[POST] - Enrich

Last Update:
Follow

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.
See Authentication and Authorization Overview for more details.
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
email 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
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)
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 
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 > salary String  Salary
contact > salaryCurrency String  Salary Currency
contact > peopleId String People Id
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": "Cincinnati",
    "companyId": 731617,
    "companyStatus": "Operating",
    "companyType": "Public",
    "country": "United States",
    "employees": "130000",
    "equifaxId": "4714167",
    "fax": "1-513-4218624",
    "financialYearEnd": "12",
    "industry": "Bedrijfsdiensten",
    "naics": "551112",
    "naicsDescription": "Offices of Other Holding Companies",
    "name": "Convergys Corp",
    "phone": "+1 513 723 7000",
    "revenue": "2229.975",
    "sic": "7373",
    "sicDescription": "Services-Computer Integrated Systems Design",
    "state": "OH",
    "street": "201 E 4th St",
    "subIndustry": "IT-diensten en -consultants",
    "tickers": [
      {
        "tickerName": "CVG",
        "exchange": "NYSE"
      }
    ],
    "zip": "45202-4248",
    "mostRecentQuarter": "Dec, 2015",
    "revenueCurrency": "EUR",
    "industryCode": "11",
    "subIndustryCode": "11_19",
    "britishSics": [
      {
        "britishSic": "62090",
        "description": "Other information technology service activities"
      },
      {
        "britishSic": "62020",
        "description": "Information technology consultancy activities"
      }
    ],
    "fortuneRanking": "783",
    "foundationDate": "1998",
    "websites": [
      "www.convergys.com"
    ],
    "sources": [
      "User Generated",
      "Reuters",
      "InsideView",
      "Community",
      "Equifax",
      "Cortera"
    ]
  },
  "contact": {
    "contactId": "8786617",
    "facebookProfile": "http://www.facebook.com/umbertom",
    "firstName": "Umberto",
    "lastName": "Milletti",
    "fullName": "Umberto Milletti",
    "linkedInProfile": "http://www.linkedin.com/in/umbertom",
    "twitterProfile": "http://twitter.com/umbertom",
    "imageUrl": "https://pbs.twimg.com/profile_images/303484549/Umberto_small_normal.jpg",
    "age": "50",
    "peopleId": "544KN90XokCKSBrKF8FkX_Eszq2JCMDfzMjbglyzLVXd0TDdVA0GymiRy4BesdZ-",
    "jobLevels": [
      "Other"
    ],
    "jobFunctions": [
      "Other"
    ],
    "active": false,
    "titles": [
      "Co-Founder, DigitalThink"
    ],
    "sources": [
      "User Generated",
      "Web References",
      "Social Media",
      "LinkSV",
      "S&P Capital IQ",
      "InsideView",
      "Community"
    ],
    "education": [
      {
        "degree": "BS",
        "major": "Electrical Engineering",
        "university": "Tufts University"
      },
      {
        "degree": "MS",
        "major": "Electrical Engineering and Computer Science",
        "university": "U.C. Berkeley"
      }
    ]
  },
  "confidenceScore": "51.923077"
}

application/xml Example (with a match)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<enrichedLead>
    <company>
        <city>Cincinnati</city>
        <companyId>731617</companyId>
        <companyStatus>Operating</companyStatus>
        <companyType>Public</companyType>
        <country>United States</country>
        <employees>130000</employees>
        <equifaxId>4714167</equifaxId>
        <fax>1-513-4218624</fax>
        <financialYearEnd>12</financialYearEnd>
        <industry>Bedrijfsdiensten</industry>
        <naics>551112</naics>
        <naicsDescription>Offices of Other Holding Companies</naicsDescription>
        <name>Convergys Corp</name>
        <phone>+1 513 723 7000</phone>
        <revenue>2229.975</revenue>
        <sic>7373</sic>
        <sicDescription>Services-Computer Integrated Systems Design</sicDescription>
        <state>OH</state>
        <street>201 E 4th St</street>
        <subIndustry>IT-diensten en -consultants</subIndustry>
        <tickers>
            <ticker>
                <exchange>NYSE</exchange>
                <tickerName>CVG</tickerName>
            </ticker>
        </tickers>
        <websites>
            <website>www.convergys.com</website>
        </websites>
        <zip>45202-4248</zip>
        <sources>
            <source>User Generated</source>
            <source>Reuters</source>
            <source>InsideView</source>
            <source>Community</source>
            <source>Equifax</source>
            <source>Cortera</source>
        </sources>
        <britishSics>
            <britishSicDetails>
                <britishSic>62090</britishSic>
                <description>Other information technology service activities</description>
            </britishSicDetails>
            <britishSicDetails>
                <britishSic>62020</britishSic>
                <description>Information technology consultancy activities</description>
            </britishSicDetails>
        </britishSics>
        <fortuneRanking>783</fortuneRanking>
        <foundationDate>1998</foundationDate>
        <industryCode>11</industryCode>
        <mostRecentQuarter>Dec, 2015</mostRecentQuarter>
        <revenueCurrency>EUR</revenueCurrency>
        <subIndustryCode>11_19</subIndustryCode>
    </company>
    <confidenceScore>51.923077</confidenceScore>
    <contact>
        <contactId>8786617</contactId>
        <facebookProfile>http://www.facebook.com/umbertom</facebookProfile>
        <firstName>Umberto</firstName>
        <lastName>Milletti</lastName>
        <fullName>Umberto Milletti</fullName>
        <linkedInProfile>http://www.linkedin.com/in/umbertom</linkedInProfile>
        <titles>
            <title>Co-Founder, DigitalThink</title>
        </titles>
        <twitterProfile>http://twitter.com/umbertom</twitterProfile>
        <sources>
            <source>User Generated</source>
            <source>Web References</source>
            <source>Social Media</source>
            <source>LinkSV</source>
            <source>S&amp;P Capital IQ</source>
            <source>InsideView</source>
            <source>Community</source>
        </sources>
        <educations>
            <education>
                <degree>BS</degree>
                <major>Electrical Engineering</major>
                <university>Tufts University</university>
            </education>
            <education>
                <degree>MS</degree>
                <major>Electrical Engineering and Computer Science</major>
                <university>U.C. Berkeley</university>
            </education>
        </educations>
        <jobLevels>
            <jobLevel>Other</jobLevel>
        </jobLevels>
        <jobFunctions>
            <jobFunction>Other</jobFunction>
        </jobFunctions>
        <active>false</active>
        <age>50</age>
        <imageUrl>https://pbs.twimg.com/profile_images/303484549/Umberto_small_normal.jpg</imageUrl>
        <peopleId>544KN90XokCKSBrKF8FkX_Eszq2JCMDfzMjbglyzLVXd0TDdVA0GymiRy4BesdZ-</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.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk