| 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 | A unique identifier for the batch. |
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 | A unique identifier for the batch. |
| batch_reference_id (Optional) |
string | Optional reference identifier provided during batch creation to support tracking of the batch. |
| status | string | The current processing 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 field. |
| 401 | Unauthorized | The authentication token you've provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | Request is not authorized to use this service. |
| 406 | Not Acceptable | Request is not in an acceptable format. |
| 408 | Request Timeout | Your request has timed out. Try submitting another request. |
| 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. |
| 429 | Too Many Requests | You've submitted too many requests. To protect all customers, your account has been temporarily throttled. |
| 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. Check the API's uptime and downtime on 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/address/bulk/v1/batches/<batch_id>/stop
{
"result": {
"batch_id": "<batch_id>",
"status": "stopped"
}
}