Use the Enrich endpoint to fetch company and contact information in a single query. This resource enables your users to search based on one or more inputs, and immediately retrieve only the highest ranked information for the combination of inputs.
Endpoint
POST https://api.insideview.com/api/v1/enrich
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes |
Valid access token. |
Accept | String | No | Selects the response's content type. Valid values are application/json and application/xml (default). |
Accept-Language | String | No | Select the response's language and locale. Default value: en-en See Internationalization Support for more details. |
Form Parameters
The parameters should be sent as x-www-form-urlencoded parameters.
Note: sending the parameters as form-data parameters will generate an error.
Parameter Name | Type | Required | Description |
companyName | String | Yes1 | Company Name |
url | String | Yes1 | Company Web Site |
String | Yes1 | Contact Email | |
firstName | String | No | Contact First Name |
lastName | String | No | Contact Last Name |
fullName | String | No | Contact Full Name |
country | String | No | Country name (e.g. United States, France) |
state | String | No | |
city | String | No | |
street | String | No | |
zip | String | No | |
fax | String | No | Company fax number |
phone | String | No | Company phone number |
phoneType | String | No | Accepts DIRECT, CORP, and ANY to find the corresponding contact's phone numbers. |
tickers | String | No | Company Ticker Symbol |
title | String | No | Contact designation at the company he/she is employed |
minConfidenceScore | String | No | Match score threshold for the API to return a match |
isContactRequired | Boolean | No | If set to true (default value: false), then a result is returned only if a contact is matched |
isPhoneRequired | Boolean | No | Returns only matched contacts if they have a phone number (If contact doesn't have phone number, company's phone number is considered) |
isEmailRequired | Boolean | No | Returns only matched contacts if they have a email address |
contactMatching | String | No | "all", "active"(Default), "inactive" are supported values for this parameter |
1: The request should include at least one of the three mandatory parameters.
Responses
HTTP 200
Returns either a JSON or XML data structure depending on the request Accept header.
The response, in case of a match, contains a company record and a contact record if a contact is also matched.
If there is no match the response will be an empty JSON structure or an empty enrichedLead node in an XML document depending on the Accept header of the query.
Name | type | Description |
company | Object | Company firmographic data |
company > britishSics | List | List of British SIC codes |
company > britishSics > britishSic | String | British SIC code |
company > britishSics > description | String | British SIC code description |
company > city | String | Company address: city |
company > companyId | Integer | InsideView company ID |
company > companyStatus | String | Company status (Operating, Subsidiary, Acquired, Liquidating, and OOB) |
company > companyType | String | Company type (Public, Private, School, Government, Organization) |
company > country | String | Company address: country |
company > employees | String | Company employee count |
company > employeeRange | String | Range of number of company employees |
company > equifaxId | String | Company Equifax ID |
company > fax | String | Company fax number |
company > financialYearEnd | String | Company financial year end |
company > fortuneRanking | String | Company Fortune ranking |
company > industry | String | Company industry |
company > industryCode | String | Company industry code |
company > mostRecentQuarter | String | Most Recent Quarter Earning Date |
company > naics | String | Company NAICS code |
company > naicsDescription | String | Company NAICS description |
company > name | String | Company name |
company > parentCompanyId | String | Parent company InsideView id |
company > parentCompanyName | String | Parent company name |
company > parentCompanyCountry | String | Parent company country |
company > phone | String | Company phone number |
company > revenue | String | Company revenue (Millions of $) |
company > revenueCurrency | String | Company revenue's currency (USD, EUR, GBP) |
company > sic | String | Company SIC code |
company > sicDescription | String | Company SIC description |
company > foundationDate | String | Foundation date of the company |
comapny > revenueRange | String | Revenue range of the company |
company > sources | String | Sources for company attributes |
company > state | String | Company address: state |
company > street | String | Company address: street |
company > subIndustry | String | Company sub-industry |
company > subIndustryCode | String | Company sub-industry code |
company > ticker | Array | Array of company's tickers details |
company > ticker > tickerName | String | Ticker symbol |
company > ticker > exchange | String | Exchange symbol |
company > ultimateParentCompanyId | String | Ultimate parent company InsideView id |
company > ultimateParentCompanyName | String | Ultimate parent company name |
company > ultimateParentCompanyCoutnry | String | Ultimate parent company Country |
company > websites | List | List of company's web site URL (String) |
company > zip | String | Company address: zip code |
company > companyFacebookProfile | String | Facebook profile of Company |
company > companyTwitterProfile | String | Twitter profile of Company |
company > companyBlogProfile | String | Blog Url of Company |
company > companyLinkedInProfile | String | LinkedIn Profile of Company |
contact | Object | Contact demographic details |
contact > age | String | Age |
contact > contactId | Integer | Contact InsideView ID |
contact > description | String | Contact biography |
contact > education | Array | Array of contact's education details |
contact > education > degree | String | |
contact > education > major | String | |
contact > education > university | String | |
contact > email | String | Contact email address |
contact > facebookProfile | String | Contact Facebook profile URL |
contact > firstName | String | Contact first name |
contact > fullName | String | Contact full name |
contact > imageUrl | String | Contact image URL |
contact > lastName | String | Contact last name |
contact > linkedInProfile | String | Contact LinkedIn profile URL |
contact > phone | String | Contact phone number |
contact > phoneType | String | Corporate and direct phone number |
contact > salary | String | Salary |
contact > salaryCurrency | String | Salary Currency |
contact > peopleId | String | People Id |
contact > jobLevelsV2 | List | List of a newer version of job levels for contact |
contact > jobFunctionsV2 | List | List of a newer version of job functions for contact |
contact > jobLevels | List | List of job levels for contact(String) |
contact > jobFunctions | List | List of job functions for contact (String) |
contact > active | Boolean | True or False to indicate employment status |
contact > sources | List | List of sources for contact attributes (String) |
contact > titles | List | List of contact's titles (String) |
contact > twitterProfile | String | Contact Twitter profile URL |
confidenceScore | Number | Matching score. Min value: 0, max value: 100 |
application/json Example (without a match)
{}
application/xml Example (without a match)
<?xml version="1.0" encoding="UTF-8"?> <enrichedLead/>
application/json Example (with a match)
{ "company": { "city": "CUPERTINO", "companyId": 724468, "companyStatus": "Operating", "companyType": "Public", "country": "United States", "employees": "500000", "equifaxId": "19571340", "fax": "(408) 996-0275", "financialYearEnd": "9", "industry": "Computerhardware", "naics": "334118", "naicsDescription": "Computer Terminal and Other Computer Peripheral Equipment Manufacturing", "name": "Apple Inc.", "phone": "1-408-9961010", "revenue": "176634.78555", "sic": "3663", "sicDescription": "Radio & Tv Broadcasting & Communications Equipment", "state": "CA", "street": "1 Infinite Loop", "subIndustry": "Computerhardware", "tickers": [ { "tickerName": "AAPL", "exchange": "NASD" } ], "zip": "95014-2083", "mostRecentQuarter": "Jun, 2016", "revenueCurrency": "EUR", "industryCode": "6", "britishSics": [ { "britishSic": "46510", "description": "Wholesale of computers, computer peripheral equipment and software" }, { "britishSic": "26200", "description": "Manufacture of computers and peripheral equipment" } ], "fortuneRanking": "5", "foundationDate": "1976", "companyFacebookProfile": "615085188507202", "companyTwitterProfile": "AppStore", "companyBlogProfile": "http://time.com/3965742/husband-smoking-google-street-view/feed/", "companyLinkedInProfile": "https://www.linkedin.com/company/apple", "sources": [ "User Generated", "Web References", "Reuters", "InsideView", "Community", "Equifax", "Cortera" ], "websites": [ "www.apple.com" ] }, "contact": { "contactId": "17710764", "firstName": "Michael", "lastName": "Cook", "fullName": "Michael Cook",
"corporate": +44 800 1010",
"direct" : +939 4321 3433, "linkedInProfile": "http://www.linkedin.com/pub/michael-cook/0/289/51b", "age": "0", "peopleId": "e_zAKbaifnjVHnLb-UjHLA-RjQm5H3IXpFCAGyUwPUGOUzkD8sJpNs8_scbt2s1X", "jobLevels": [ "Other" ], "jobFunctions": [ "Sales", "Operations and Administration" ], "jobLevelsV2": [ { "id": "0", "name": "Board Member" }, { "id": "2", "name": "Senior Executive" } ], "jobFunctionsV2": [ { "id": "22", "name": "Others" } ], "active": true, "sources": [ "Web References" ], "titles": [ "Director, Retail Operations" ] }, "confidenceScore": "50.016148" }
application/xml Example (with a match)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <enrichedLead> <company> <city>CUPERTINO</city> <companyId>724468</companyId> <companyStatus>Operating</companyStatus> <companyType>Public</companyType> <country>United States</country> <employees>500000</employees> <equifaxId>19571340</equifaxId> <fax>(408) 996-0275</fax> <financialYearEnd>9</financialYearEnd> <industry>Computerhardware</industry> <naics>334118</naics> <naicsDescription>Computer Terminal and Other Computer Peripheral Equipment Manufacturing</naicsDescription> <name>Apple Inc.</name> <phone>1-408-9961010</phone> <revenue>176634.78555</revenue> <sic>3663</sic> <sicDescription>Radio & Tv Broadcasting & Communications Equipment</sicDescription> <state>CA</state> <street>1 Infinite Loop</street> <subIndustry>Computerhardware</subIndustry> <tickers> <ticker> <exchange>NASD</exchange> <tickerName>AAPL</tickerName> </ticker> </tickers> <websites> <website>www.apple.com</website> </websites> <zip>95014-2083</zip> <sources> <source>User Generated</source> <source>Web References</source> <source>Reuters</source> <source>InsideView</source> <source>Community</source> <source>Equifax</source> <source>Cortera</source> </sources> <britishSics> <britishSicDetails> <britishSic>46510</britishSic> <description>Wholesale of computers, computer peripheral equipment and software</description> </britishSicDetails> <britishSicDetails> <britishSic>26200</britishSic> <description>Manufacture of computers and peripheral equipment</description> </britishSicDetails> </britishSics> <companyBlogProfile>http://time.com/3965742/husband-smoking-google-street-view/feed/</companyBlogProfile> <companyFacebookProfile>615085188507202</companyFacebookProfile> <companyLinkedInProfile>https://www.linkedin.com/company/apple</companyLinkedInProfile> <companyTwitterProfile>AppStore</companyTwitterProfile> <fortuneRanking>5</fortuneRanking> <foundationDate>1976</foundationDate> <industryCode>6</industryCode> <mostRecentQuarter>Jun, 2016</mostRecentQuarter> <revenueCurrency>EUR</revenueCurrency> </company> <confidenceScore>50.016148</confidenceScore> <contact> <contactId>17710764</contactId> <firstName>Michael</firstName> <lastName>Cook</lastName> <fullName>Michael Cook</fullName>
<corporatePhone>+44 800 1010</corporatePhone>
<directPhone>+939 4321 3433</directPhone> <linkedInProfile>http://www.linkedin.com/pub/michael-cook/0/289/51b</linkedInProfile> <titles> <title>Director, Retail Operations</title> </titles> <sources> <source>Web References</source> </sources> <jobLevels> <jobLevel>Other</jobLevel> </jobLevels> <jobFunctions> <jobFunction>Sales</jobFunction> <jobFunction>Operations and Administration</jobFunction> </jobFunctions> <jobLevelsV2> <jobLevelV2> <id>0</id> <name>Board Member</name> </jobLevelV2> <jobLevelV2> <id>2</id> <name>Senior Executive</name> </jobLevelV2> </jobLevelsV2> <jobFunctionsV2> <jobFunctionV2> <id>22</id> <name>Others</name> </jobFunctionV2> </jobFunctionsV2> <active>true</active> <age>0</age> <peopleId>e_zAKbaifnjVHnLb-UjHLA-RjQm5H3IXpFCAGyUwPUGOUzkD8sJpNs8_scbt2s1X</peopleId> </contact> </enrichedLead>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
Request is throttled.
Comments
0 comments
Please sign in to leave a comment.