Name | Type | Description |
---|---|---|
Auth-Token | string | Input your unique token here. This is required to submit an API request. |
Add-Metadata (Optional) |
boolean | Specify whether the response should return all fields and values, in addition to the main core information. |
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. |
Field | Type | Description |
---|---|---|
string | The email that you are submitting for validation. |
Name | Type | Description |
---|---|---|
string | The email address that you are submitting for validation. | |
confidence | string | The outcome of the validation. Check out Confidence Level for details. |
verbose_output | string | Additional information on the confidence level. Check out Confidence Level for details. |
did_you_mean | collection | A list of more likely email addresses. Suggestions include fixes to syntax errors in the provided email address, typos in domains etc. Check out Suggestions for details. |
Name | Type | Description | |
---|---|---|---|
domain_detail | object | The details about the domain. | |
type | string | Omit this field when we are unable to provide a value (either through DB issues, not having the domain in our DB, or other).
The type of domain:
|
Below you have an example of a successful response returned by the API.