Single Validation API
GET https://api.bouncify.io/v1/verify
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
apikey | string | Required | Your API key. |
email | string | Required | An email address to be verified. |
timeout | int32 | Optional | The maximum time allowed for the API to complete a verification request ranges from 30,000 milliseconds to 180,000 milliseconds, with a default of 180,000 milliseconds. Defaults to 180000. |
Response
JSON
HTTP/1.1 200 OK
{
"result": "deliverable",
"message": "This address can receive emails.",
"email": "support@bouncify.io",
"user": "support",
"domain": "bouncify.io",
"accept_all": 2,
"role": 1,
"free_email": 0,
"disposable": 0,
"spamtrap": 0,
"success": true
}
How to use the result
- Apart from
undeliverable, for the resultsdeliverable,accept-allandunknowndo not reject the email address and proceed with your work flow. Bothaccept-allandunknownemails could not be validated, so they may be valid email address. - If the request was not successful, do consider proceeding with your workflow.
Response Parameters
| Parameter | Type | Definition |
|---|---|---|
result | string | The verified results will be: deliverable, undeliverable, unknown, accept all |
message | string | Describes API result |
email | The email that was verified. | |
user | string | The user part of the provided email address. |
domain | string | The domain of the provided email address. |
accept_all | Integer | Remote host accepts mail at any address. |
role | [0, 1] | Whether the email is considered a role address. (e.g. "sales@, info@, help@, etc.) |
free_email | [0, 1] | Whether the email is hosted by a free email provider like Gmail, Yahoo!, Hotmail etc.. |
disposable | [0, 1] | Whether this is a temporary email. |
spamtrap | [0, 1] | Is this a honeytrap email |
success | [true, false] | Whether the API request call was successful or not. |
Other Responses
The response you get when email address is not provided or in an invalid format.
HTTP/ 400 Bad Request
{
"result": "Invalid request. Required email.",
"success": false
}
The response you get when the API key is invalid:
HTTP/1.1 401 Unauthorized
{
"success":"false",
"result":"Invalid API Key"
}
The response you get when your credits have been used:
HTTP/1.1 402 Payment Required
{
"success":"false",
"result":"Insufficient verification credits"
}
The response you get when your call rate is high (more than 120 concurrent calls):
HTTP/ 429 Too Many Requests
{
"success":"false",
"result":"Too many requests"
}
Example
Go / PHP / C# / Python / Shell
curl --request GET \
--url 'https://api.bouncify.io/v1/verify?timeout=180000' \
--header 'accept: application/json'