Email verification API
The Email Verification API takes an email address (potentially containing spelling mistakes and/or other errors) and validates the syntax, the existence and availability of the domain, the existence of the email account, and returns a verified state and other metadata.
Endpoint
Global
https://api.addressfinder.io/api/email/v1/verification
Parameters
Parameter | Default | Description | Test Value |
---|---|---|---|
key |
| Your unique licence key (find on Portal credentials) Required string | |
secret |
| Your unique secret key (find on Portal credentials). This required when calling API endpoints without a referer. Optional string | |
format | json | The required format of the response. Optional string | |
email |
| The email to be verified. Optional string | |
domain |
| Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Optional string | |
features |
| A comma-separated list of parameters that controls the methods of verification to be completed. This will impact the query processing time and data returned in the response.<br /><br />Options:<br />- Optional string |
Responses
200 OK
Name | Type | Description | Example |
---|---|---|---|
email_account | string | The first part of an email address, before the @ | john.doe |
email_domain | string | The second part of the email address, after the @ | addressfinder.com |
email_provider_domain | string | The underlying provider of the email service. Only populated if the features=provider parameter is provided. | google.com |
verified_email | string | The full verified email address | jane.smith@addressfinder.com |
is_verified | boolean | We did not find any reason to believe an email sent to the address provided would fail to reach the associated mailbox | true |
is_disposable | boolean | Identified as a disposable email address | false |
is_role | boolean | The email account is for a group email. For example info@addressfinder.com | false |
is_public | boolean | Identified as a public email provider. For example john.doe@gmail.com | false |
is_catch_all | boolean | The email domain has a catch all policy | false |
not_verified_reason | string | If verified is false, this will contain a short description of the failure reason | - |
not_verified_code | string | A code indicating why the email did not verify | - |
success | boolean | Indicates if the request was successful or not | true |
400 Bad request
Name | Type | Description | Example |
---|---|---|---|
completions | array | An empty array will be returned due to the error | - |
error_code | string | A unique numerical value identifying the error that occured | 1004 |
message | string | An informative message describing the error that occured | Secret not provided |
success | boolean | Indicates if the request was successful or not | false |
See API Error Reference for details.