| 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. |
| Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
| Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. The default value of this setting is true. |
In the request body you can specify:
| Name | Type | Description | |
|---|---|---|---|
| components | object | Object defining the input components. | |
| first_name | collection | Collection containing the first name of the individual. | |
| last_name | collection | Collection containing the last name of the individual. | |
| collection | Collection containing the email of the individual. | ||
| attributes | collection | Collection containing the type of the request. | |
| Name | Type | Description |
|---|---|---|
| Reference-Id (Optional) |
string | Identifier that was supplied by you in the request header to help you track the request. |
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 | |
|---|---|---|---|
| contacts | collection | Collection of contact information matched to the email supplied. | |
| first_name | string | The first name of the individual. | |
| last_name | string | The last name of the individual. | |
| address_line_1 | string | The address of the individual. | |
| town | string | The town, city or suburb. | |
| region | string | The state or province. | |
| postal_code | string | The post/zip code. | |
| country_iso_3 | string | The country of the individual in three letter ISO code, i.e. USA. | |
The following response codes can be returned by the API:
| Status Code | Reason phrase | Description |
|---|---|---|
| 200 | Success | Request processed successfully. |
| 400 | Bad Request | Request failed due to malformed syntax. |
| 401 | Unauthorized | Auth-Token provided is incorrect. |
| 403 | Forbidden | Request is not authorized to use this service. |
| 404 | Not Found | Request is not found. |
| 406 | Not Acceptable | Request is not in an acceptable format. |
| 408 | Request Timeout | Response was not returned within the timeout allowance. |
| 415 | Unsupported Media Type | Request is not using a Media type that is recognized by the server. |
| 429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
| 500 | Internal Server Error | The server has encountered an error. |
| 503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
{
"components": {
"first_name": [
"tom"
],
"last_name": [
"Smith"
],
"email": [
"support@experian.com"
]
},
"attributes": [
"contact"
]
}
{
"result": {
"contacts": [
{
"first_name": "THOMAS",
"last_name": "Smith",
"address_line_1": "1153 S GILCHRIST ST",
"town": "TERRE HAUTE",
"region": "IN",
"postal_code": "47802-4742",
"country_iso_3": "USA"
}
]
}
}