| 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. | |
| middle_name (Optional) |
collection | Collection containing the middle name of the individual. | |
| last_name | collection | Collection containing the last name of the individual. | |
| address_line_1 | collection | Collection containing the address of the individual. | |
| town | collection | Collection containing the town, city or suburb. | |
| region | collection | Collection containing the state or province. | |
| postal_code | collection | Collection containing the post/zip code. | 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 |
|---|---|---|
| string | The email address that matched to the name and postal address. |
| Name | Type | Description |
|---|---|---|
| email_type | string | The match level of the email returned:
|
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": [
"John"
],
"middle_name": [
"Abraham"
],
"last_name": [
"Smith"
],
"street": [
"1 Main Street"
],
"town": [
"Phoenix"
],
"region": [
"AZ"
],
"postal_code": [
"94133"
]
},
"attributes": [
"email"
]
}
{
"result": {
"email": "goooooogle.me@gmail.com"
},
"metadata": {
"email_detail": {
"email_type": "individual"
}
}
}