[POST] - New Company Details Job

  • Updated

Use the New Company Details Job endpoint to submit a bulk of New Company Details queries.  It creates an asynchronous job on InsideView servers. See Using the Bulk APIs for more details.

Endpoint

POST https://api.insideview.com/api/v1/target/company/fetch/job

Request

HTTP Headers

Header Name
Type
Required
Description
accessToken String Y Valid access token. 
See Authentication and Authorization Overview for more details.
Accept String No Precise the content type for the response.  
Valid values are application/json and application/xml (default).  
Accept-Language String No

Locale

Example: nl_NL,fr_FR,es_ES,de_DE,en_IE,en_GB,en_US

Query Parameters

Parameter Name Type Required Description
webhook String No URL for receiving Job status

Request Body

The request body should contain a list of new company ids, either separated with a new line.  The request can contain up to 10,000 new company ids.

Example input data

TpK9Pfj0reHRDsBKLsm9QdvBF4RUQqmNaLvYlh8Qcxshb1LDCdjfrnlT9cZEKsoP
TpK9Pfj0reHRDsBKLsm9Qc6anwTUlcMWZ7ad_M6EwCJHQrLbtTZQNsOh-SGmVMMb
TpK9Pfj0reHRDsBKLsm9QcR1zbxfug8J67sSP63tRymPHslL1Uzgvjs1f5OvA3ku

Responses

Here are the major responses the API may return.

For details on the errors, see API Error Codes.

HTTP 200

An HTTP 200 status means the data have been accepted and a job have been queued.

Type: application/json

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "object",
  "properties": {
    "jobId": {
      "id": "jobId",
      "type": "string"
    },
    "status": {
      "id": "status",
      "type": "string"
    },
    "type": {
      "id": "type",
      "type": "string"
    }
  }
}

Example

{
  "jobId": "lnjkd7ie0hblp1k58e5q",
  "status": "accepted",
  "type": "targetCompanyDetails"
}

Type: application/xml

Schema

Example


    81g8d74jjo8s4grarkii
    accepted
    targetCompanyDetails

HTTP 400

An HTTP 400 error code may have several causes:

  • Validation of input data failed
  • Insufficient transaction quota available
  • Too many job submitted to the processing queue
  • etc.

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 is not valid, please refer to the API documentation.

HTTP 429

Request is throttled.