Use the Enrich Job endpoint to submit a bulk of Enrich queries. It creates an asynchronous job on InsideView servers. Refer to Using the bulk API article for more details.
Endpoint
POST https://api.insideview.com/api/v1/enrich/job
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. |
| Content-Type | String | No | Input content type. Valid values are application/octet-stream and text/plain |
Query Parameters
| Parameter Name | Type | Required | Description |
| webhook | String | No | URL for receiving Job status |
Request Body
The CSV input data should be submitted in the request body. The request can contain up to 10,000 lines. See Using the Bulk API for more details.
The input data should contain exactly the columns specified below, in the specified order. The data should not contain a row describing the columns.
| Column | Order | Description |
| id | 1 | Your row identifier. Will be part of the output. |
| city | 2 | Company address's city. |
| companyName | 3 | Company name |
| country | 4 | Company address's country name (e.g. United States, France). |
| 5 | Contact's email address | |
| firstName | 6 | Contact's first name. |
| lastName | 7 | Contact's last name. |
| state | 8 | Company address's state. |
| street | 9 | Company address's street. |
| ticker | 10 | Company address's stock exchange symbol. |
| title | 11 | Contact's title. |
| url | 12 | Company web site. |
| zip | 13 | Company address's zip code. |
| confidenceScore | 14 | Confidence score threshold for returning a match |
| isContactRequired | 15 | Returns only if contact is matched |
| isPhoneRequired | 16 | Returns only matched contacts if they have a phone number (If contact doesn't have phone number, company's phone number is considered) |
| isEmailRequired | 17 | Returns only if contact has an email address |
| fullName | 18 | Contact's Full name |
| contactMatching | 19 | "active" (Default), "all", "inactive" |
Example input data
myid-1,,Google Inc,,,,,,,,,google.com,,50,True,,False myid-2,,,,umberto@insideview.com,,,,,,,,45,,, myid-3,Palo Alto,Apple,,,,,,,,,,,
Responses
Here are the major responses the API may return.
For details on the errors, please refer to the API Error Codes article.
HTTP 200
An HTTP 200 status means the data have been accepted and a job have been queued.
application/json example response
{
jobId: "peerukbkasr85s6hdtb9"
status: "accepted"
type: "enrich"
}
application/xml example response
<?xml version="1.0" encoding="UTF-8"?>
<BulkJobStatus>
<jobId>a8bpdds1one7vblg0obm</jobId>
<status>accepted</status>
<type>enrich</type>
</BulkJobStatus>
HTTP 400
An HTTP 400 error code may have several causes:
- Validation of input file failed
- Insufficient transaction quota available
- Too many job submitted to the processing queue
- etc.
Please use the error number provided to review the error cause and actions you may take in API Error Codes.
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 415
The Content-Type mandatory header is not provided.
HTTP 429
Request is throttled.