Below are the response fields w.r.t Batch Email verification. For Single Email verification root element will be response:
| Field | Type | Description |
|---|---|---|
| responses.id | Unique id | Optional parameter which will tag along with result when passed at the time of input. |
| responses.status | Status | Status of the response. |
| responses.email | Result array | Result of email verification. |
| responses.email.address | String | The email address to be validated. |
| responses.email.result | String | The result of the validated email. |
| responses.email.subResult | String | The sub result of the validated email. |
| responses.email.freeEmail | String | Returns true or false, if the email comes from a free provider. |
| responses.email.didYouMean | String | Suggestive Fix for an email typo. |
| responses.email.account | String | The portion of the email address before the "@" symbol. |
| responses.email.domain | String | The portion of the email address after the "@" symbol. |
| responses.email.domainAgeDays | String | Age of the email domain in days. |
| responses.email.smtpProvider | String | The SMTP Provider of the email. |
| responses.email.mxFound | String | Returns true or false depending on whether the domain have an MX record. |
| responses.email.mxRecord | String | The preferred MX record of the domain. |
| responses.email.firstName | String | The first name of the owner of the email when available. |
| responses.email.lastName | String | The last name of the owner of the email when available. |
| responses.email.gender | String | The gender of the owner of the email when available. |
| responses.email.processedAt | String | The time the email was validated in ISO 8601 format. |
Email Verification API sample response:
Below is a sample Single Email Verification API
Response:
{
"response": {
"status": "OK",
"email": {
"address": "example@mail.com",
"result": "invalid",
"subResult": "mailbox_quota_exceeded",
"freeEmail": "true",
"account": "example",
"domain": "mail.com",
"domainAgeDays": "9864",
"smtpProvider": "mail.com",
"mxFound": "true",
"mxRecord": "mx00.mail.com",
"processedAt": "2024-03-26T14:59:27.057Z"
}
}
}Below is a sample Batch Email Verification API
Response:
{
"responses": [
{
"id": "1",
"status": "OK",
"email": {
"address": "example@mail.com",
"result": "invalid",
"subResult": "mailbox_quota_exceeded",
"freeEmail": "true",
"account": "example",
"domain": "mail.com",
"domainAgeDays": "9864",
"smtpProvider": "mail.com",
"mxFound": "true",
"mxRecord": "mx00.mail.com",
"processedAt": "2024-03-26T14:59:27.057Z"
}
},
{
"id": "2",
"status": "OK",
"email": {
"address": "john.smith@example.org",
"result": "do_not_mail",
"subResult": "global_suppression",
"freeEmail": "false",
"account": "john.smith",
"domain": "example.org",
"domainAgeDays": "10435",
"mxFound": "false",
"processedAt": "2024-03-26T15:00:24.604Z"
}
}
]
}
Error Codes
Email Verification API will return the following error codes in case of any
error:
| Error Code | Description |
|---|---|
| DIS-1001 | Invalid token |
| DIS-1002 | Not Authorized to access this API |
| DIS-1003 | Issue with internal services |
| DIS-1004 | Workspace Id is missing from Bearer Token |
| DIS-EV-1001 | Batch size must not exceed 10 |
| DIS-EV-1002 | Email can not be null or empty |
| DIS-EV-1003 | Request is not valid |
| DIS-EV-1004 | Required body is not specified |