| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| Name | Type | Description |
|---|---|---|
| batch_id | string | The batch ID. |
The response from the API returns the below fields within a result object. Should an error occur, an error object is returned instead.
| Name | Type | Description |
|---|---|---|
| batch_id | string | The Batch ID. |
| status | string | The current status of the Batch. |
The following response codes can be returned by the API:
| HTTP status code | Title | Scenario |
|---|---|---|
| 200 | Success | You've submitted a successful request and a valid response was returned. |
| 400 | Bad Request | You've submitted an invalid batch_id path parameter. |
| Your Batch has been started. | ||
| Your Batch is older than 28 days. | ||
| You didn't provide an authentication token. Try submitting another request and make sure you specify your token, which you can find by signing in to the Self Service Portal. | ||
| You've submitted a malformed request body. Try sending another call and make sure the request body contains all required fields and that they are formatted correctly. | ||
| You've submitted an empty request body. Try sending another call and make sure the request body contains all required fields. | ||
| You've submitted an invalid Reference-ID header. Try submitting another request and make sure this header is formatted correctly. | ||
| You've submitted an invalid Add-Metadata header. Try submitting another request and make sure this header is formatted correctly. | ||
| 401 | Unauthorized | The authentication token you've provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | The authentication token you've provided is valid, but it's associated with another product or you have insufficient credits. Sign in to the Self Service Portal to check if you are using the right token and if you have credits. |
| The authentication token you've provided is disabled. Sign in to the Self Service Portal to activate the token. | ||
| The domain you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the domain. | ||
| The IP address you've sent the request from does not have access to your integration. Sign in to the Self Service Portal to whitelist the IP address. | ||
| 404 | Not Found | The resource you've requested could not be found. Try submitting another call and make sure you're using the correct endpoint URL. If the issue persists, contact us. |
| 406 | Not Acceptable | You've specified an invalid Accept header. Try submitting another call and make sure you specify a valid Accept value. Check out Supported data formats for details. |
| 415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. Check out Supported data formats for details. |
| 429 | Too Many Requests | You've submitted too many requests. To protect all customers, your account has been temporarily throttled. Check out Rate limiting for details. |
| 500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
| 503 | Service Unavailable | The service is currently unavailable. You can check the API's uptime and downtime by going to our service status page. |
Successful API request returns the response within a result object. However, should an error occur, an error object is returned instead with the below fields.
| Name | Type | Description |
|---|---|---|
| type | string | A link to documentation that provides more details about the error you've encountered. |
| title | string | The title of the error. |
| detail | string | A description of the error. |
| instance | string | The endpoint that returned the error. |
POST https://api.experianaperture.io/phone/bulk/v1/batches/<batch_id>/start
{
"result": {
"batch_id": "<batch_id>",
"status": "processing"
}
}