Use the Company Matcher Lite API to get the best-matched company name and address (location) details for your search query.
Note: The maximum number of requests sent for matching per call in this matcher API call is 40.
Endpoint
POST https://api.insideview.com/api/v1/company/match/basicFields
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes |
The valid access token. |
Accept | String | No | Selects the response's content type. Valid values are application/json and application/xml (default). |
Application/JSON:
"matchbranch":"true" (boolean) is an optional parameter that can be included in the request to enable matching on the branch companies in addition to all the independent companies. "matchbranch" is set to "false" by default.
Schema
{
"$schema":"http://json-schema.org/draft-04/schema#",
"type":"object",
"properties":{
"requests":{
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"name":{
"type":"string"
},
"companyId":{
"type":"string"
},
"country":{
"type":"string"
},
"state":{
"type":"string"
},
"city":{
"type":"string"
},
"street":{
"type":"string"
},
"zip":{
"type":"string"
},
"websites":{
"id":"websites",
"type":"array",
"items":{
"id":"0",
"type":"string"
}
},
"matchbranch":{
"type":"boolean"
},
"tickers":{
"id":"tickers",
"type":"array",
"items":{
"id":"0",
"type":"object",
"properties":{
"value":{
"id":"value",
"type":"string"
},
"exchange":{
"id":"exchange",
"type":"string"
}
}
}
},
"phone":{
"type":"string"
}
}
}
},
"fieldsToFetch":{
"type":"array",
"items":{
"type":"string"
}
}
}
}
Example:
{
"requests":[
{
"id":"1",
"name":"Alp'habet Inc",
"country":"",
"state":"CA",
"city":"",
"street":"",
"zip":"",
"phone":"",
"matchbranch":false
},
{
"id": "2",
"name": "slack"
}
],
"fieldsToFetch":[
"name",
"street",
"city",
"state",
"zip",
"country",
"companyId"
]
}
Response
Here are the major responses the API may return.
For details on the errors, see API Error Codes.
HTTP 200
Name | Type | Description |
city | String | Company address: city |
companyId | Integer | Company InsideView id |
companyMatches | List | List of Company Matches |
id"}'companyMatches id | String | Requested Company Id |
probableMatches"}'companyMatches probableMatches | List | List of Probable Company Matches for the Requested Company Id |
country | String | Company address: country |
company"}'match/probableMatches company | Object | Company Details |
name | String | Company Name |
state | String | Company address: state |
street | String | Company address: street |
zip | String | Company address: code |
Application/JSON:
Schema
{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "companyMatches":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "type":"string" }, "match":{ "type":"object", "properties":{ "company":{ "type":"object", "properties":{ "name":{ "id":"name", "type":"string" }, "street":{ "id":"street", "type":"string" }, "city":{ "id":"city", "type":"string" }, "state":{ "id":"state", "type":"string" }, "zip":{ "id":"zip", "type":"string" }, "country":{ "id":"country", "type":"string" }, "companyId":{ "id":"companyId", "type":"integer" } } } } }, "probableMatches":{ "type":"array", "items":{ "type":"object", "properties":{ "company":{ "type":"object", "properties":{ "name":{ "id":"name", "type":"string" }, "street":{ "id":"street", "type":"string" }, "city":{ "id":"city", "type":"string" }, "state":{ "id":"state", "type":"string" }, "zip":{ "id":"zip", "type":"string" }, "country":{ "id":"country", "type":"string" }, "companyId":{ "id":"companyId", "type":"integer" } } } } } } } } } } }
Example:
{ "companyMatches": [ { "id": "1", "match": { "company": { "name": "Alphabet Inc", "street": "1600 Amphitheatre Pkwy", "city": "MOUNTAIN VIEW", "state": "CA", "zip": "94043-1351", "country": "United States", "companyId": 736233 } }, "probableMatches": [ { "company": { "name": "Alphabet Ranch Inc.", "street": "6224 Garfield Ave ", "city": "Sacramento", "state": "CA", "zip": "95841-2011", "country": "United States", "companyId": 8070174 } }, { "company": { "name": "Alphabet Energy, Inc.", "street": "26225 Eden Landing Road Suite D", "city": "Hayward", "state": "California", "zip": "94545", "country": "United States", "companyId": 2681965 } }, { "company": { "name": "Alphabet, Inc.", "street": "8640 East Market Street", "city": "Warren", "state": "OH", "zip": "44484", "country": "United States", "companyId": 245682 } }, { "company": { "name": "Alphabet Holding Company, Inc.", "street": "2100 Smithtown Avenue", "city": "Ronkonkoma", "state": "NY", "zip": "11779", "country": "United States", "companyId": 10869812 } }, { "company": { "name": "Alphabet Inc", "street": "111 Outrigger ", "city": "Greenwood", "state": "SC", "zip": "29649-8622", "country": "United States", "companyId": 6442246 } }, { "company": { "name": "Alphabet Station Inc", "street": "1510 e passyunk ave", "city": "Philadelphia", "state": "PA", "zip": "19147-6323", "country": "United States", "companyId": 17852001 } }, { "company": { "name": "Alphabet Resources Inc", "street": "365 Stonehenge Dr ", "city": "Phillipsburg", "state": "NJ", "zip": "08865-2075", "country": "United States", "companyId": 7193601 } }, { "company": { "name": "Alphabet Soup and Monogram Stew, Inc", "street": "113 W Thomas St ", "city": "Hammond", "state": "LA", "zip": "70401-3250", "country": "United States", "companyId": 9037453 } }, { "company": { "name": "Alphabet Soup Nursery & Pre-school, Inc", "street": "1344 Lake Ave ", "city": "Metairie", "state": "LA", "zip": "70005-1972", "country": "United States", "companyId": 9015479 } }, { "company": { "name": "The Alphabet Shop, Inc.", "street": "300 Elgin Ave", "city": "Elgin", "state": "IL", "zip": "60120-8412", "country": "United States", "companyId": 5596488 } } ] }, { "id": "2", "match": { "company": { "name": "SLACK Incorporated", "street": "6900 Grove Road", "city": "Thorofare", "state": "NJ", "zip": "08086-9447", "country": "United States", "companyId": 687022 } }, "probableMatches": [ { "company": { "name": "Slack Technologies, Inc.", "street": "155 5th Street, 6th Floor ,", "city": "San Francisco", "state": "CA", "zip": "94103", "country": "United States", "companyId": 2861937 } }, { "company": { "name": "Slack Tech Services", "street": "67 Winding Way W ", "city": "Morrisville", "state": "PA", "zip": "19067-5933", "country": "United States", "companyId": 9133896 } }, { "company": { "name": "Slack Chemical, Inc.", "street": "465 South Clinton Street", "city": "Carthage", "state": "NY", "zip": "13619", "country": "United States", "companyId": 3482823 } }, { "company": { "name": "Slack & Davis, Llp", "street": "2705 Bee Caves Rd Ste 220", "city": "Austin", "state": "TX", "zip": "78746-5685", "country": "United States", "companyId": 9477056 } }, { "company": { "name": "Slack Barshinger", "street": "233 North Michigan Avenue Suite 3050", "city": "Chicago", "state": "IL", "zip": "60601", "country": "United States", "companyId": 29786 } }, { "company": { "name": "Slack Auto Parts", "street": "404 Sw Main St ", "city": "Gainesville", "state": "GA", "zip": "30501-4416", "country": "United States", "companyId": 5717834 } }, { "company": { "name": "Slack Auto Parts", "street": "146 Morrison Moore Pkwy E ", "city": "Dahlonega", "state": "GA", "zip": "30533-1632", "country": "United States", "companyId": 5721229 } }, { "company": { "name": "Slack & Co. Contracting, Inc.", "street": "10622 S Main St", "city": "Houston", "state": "TX", "zip": "77025", "country": "United States", "companyId": 15543632 } }, { "company": { "name": "Slack & Parr Investments Limited", "street": "Long Lane Kegworth", "city": "Derby", "country": "United Kingdom", "companyId": 10938868 } }, { "company": { "name": "G.h. Slack and Son", "street": "2741 Landco Dr ", "city": "Bakersfield", "state": "CA", "zip": "93308-6147", "country": "United States", "companyId": 602245 } } ] } ], "successfulCount": 2 }
Type: application/xml
Schema:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"elementFormDefault="qualified">
<xs:element name="companyMatches"> <xs:complexType> <xs:sequence> <xs:element ref="companyMatch" maxOccurs="unbounded" minOccurs="0" /> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="companyMatch"> <xs:complexType> <xs:sequence> <xs:element name="id" type="xs:integer" /> <xs:element name="probableMatches" maxOccurs="unbounded" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element name="company" type="companyDTO" /> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:complexType name="companyDTO"> <xs:sequence> <xs:element name="companyId" type="xs:int" minOccurs="0"/> <xs:element name="city" type="xs:string" minOccurs="0"/> <xs:element name="country" type="xs:string" minOccurs="0"/> <xs:element name="name" type="xs:string" minOccurs="0"/> <xs:element name="state" type="xs:string" minOccurs="0"/> <xs:element name="street" type="xs:string" minOccurs="0"/> <xs:element name="zip" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType> <xs:element name="id" type="xs:integer" /> </xs:schema>
Example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<companyMatches>
<companyMatch>
<id>1</id>
<match>
<company>
<companyId>736233</companyId>
<city>MOUNTAIN VIEW</city>
<country>United States</country>
<name>Alphabet Inc</name>
<state>CA</state>
<street>1600 Amphitheatre Pkwy</street>
<zip>94043-1351</zip>
</company>
</match>
<probableMatches>
<company>
<companyId>8070174</companyId>
<city>Sacramento</city>
<country>United States</country>
<name>Alphabet Ranch Inc.</name>
<state>CA</state>
<street>6224 Garfield Ave </street>
<zip>95841-2011</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>2681965</companyId>
<city>Hayward</city>
<country>United States</country>
<name>Alphabet Energy, Inc.</name>
<state>California</state>
<street>26225 Eden Landing Road Suite D</street>
<zip>94545</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>245682</companyId>
<city>Warren</city>
<country>United States</country>
<name>Alphabet, Inc.</name>
<state>OH</state>
<street>8640 East Market Street</street>
<zip>44484</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>10869812</companyId>
<city>Ronkonkoma</city>
<country>United States</country>
<name>Alphabet Holding Company, Inc.</name>
<state>NY</state>
<street>2100 Smithtown Avenue</street>
<zip>11779</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>6442246</companyId>
<city>Greenwood</city>
<country>United States</country>
<name>Alphabet Inc</name>
<state>SC</state>
<street>111 Outrigger </street>
<zip>29649-8622</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>17852001</companyId>
<city>Philadelphia</city>
<country>United States</country>
<name>Alphabet Station Inc</name>
<state>PA</state>
<street>1510 e passyunk ave</street>
<zip>19147-6323</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>7193601</companyId>
<city>Phillipsburg</city>
<country>United States</country>
<name>Alphabet Resources Inc</name>
<state>NJ</state>
<street>365 Stonehenge Dr </street>
<zip>08865-2075</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>9037453</companyId>
<city>Hammond</city>
<country>United States</country>
<name>Alphabet Soup and Monogram Stew, Inc</name>
<state>LA</state>
<street>113 W Thomas St </street>
<zip>70401-3250</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>9015479</companyId>
<city>Metairie</city>
<country>United States</country>
<name>Alphabet Soup Nursery & Pre-school, Inc</name>
<state>LA</state>
<street>1344 Lake Ave </street>
<zip>70005-1972</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>5596488</companyId>
<city>Elgin</city>
<country>United States</country>
<name>The Alphabet Shop, Inc.</name>
<state>IL</state>
<street>300 Elgin Ave</street>
<zip>60120-8412</zip>
</company>
</probableMatches>
</companyMatch>
<companyMatch>
<id>2</id>
<match>
<company>
<companyId>687022</companyId>
<city>Thorofare</city>
<country>United States</country>
<name>SLACK Incorporated</name>
<state>NJ</state>
<street>6900 Grove Road</street>
<zip>08086-9447</zip>
</company>
</match>
<probableMatches>
<company>
<companyId>2861937</companyId>
<city>San Francisco</city>
<country>United States</country>
<name>Slack Technologies, Inc.</name>
<state>CA</state>
<street>155 5th Street, 6th Floor ,</street>
<zip>94103</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>9133896</companyId>
<city>Morrisville</city>
<country>United States</country>
<name>Slack Tech Services</name>
<state>PA</state>
<street>67 Winding Way W </street>
<zip>19067-5933</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>3482823</companyId>
<city>Carthage</city>
<country>United States</country>
<name>Slack Chemical, Inc.</name>
<state>NY</state>
<street>465 South Clinton Street</street>
<zip>13619</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>9477056</companyId>
<city>Austin</city>
<country>United States</country>
<name>Slack & Davis, Llp</name>
<state>TX</state>
<street>2705 Bee Caves Rd Ste 220</street>
<zip>78746-5685</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>29786</companyId>
<city>Chicago</city>
<country>United States</country>
<name>Slack Barshinger</name>
<state>IL</state>
<street>233 North Michigan Avenue Suite 3050</street>
<zip>60601</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>5717834</companyId>
<city>Gainesville</city>
<country>United States</country>
<name>Slack Auto Parts</name>
<state>GA</state>
<street>404 Sw Main St </street>
<zip>30501-4416</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>5721229</companyId>
<city>Dahlonega</city>
<country>United States</country>
<name>Slack Auto Parts</name>
<state>GA</state>
<street>146 Morrison Moore Pkwy E </street>
<zip>30533-1632</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>15543632</companyId>
<city>Houston</city>
<country>United States</country>
<name>Slack & Co. Contracting, Inc.</name>
<state>TX</state>
<street>10622 S Main St</street>
<zip>77025</zip>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>10938868</companyId>
<city>Derby</city>
<country>United Kingdom</country>
<name>Slack & Parr Investments Limited</name>
<street>Long Lane Kegworth</street>
</company>
</probableMatches>
<probableMatches>
<company>
<companyId>602245</companyId>
<city>Bakersfield</city>
<country>United States</country>
<name>G.h. Slack and Son</name>
<state>CA</state>
<street>2741 Landco Dr </street>
<zip>93308-6147</zip>
</company>
</probableMatches>
</companyMatch>
</companyMatches>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in the header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
The request is throttled.