Get results (processed emails) | Documentation | Email Verification Bulk API | WhoisXML API

Get results (processed emails)

POST https://emailverification.whoisxmlapi.com/api/bevService/request/completed

CURL request sample

curl https://emailverification.whoisxmlapi.com/api/bevService/request/completed -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "id": 622, "format": "json"}'

POST request body sample

{
    "apiKey": "YOUR_API_KEY",
    "id": 596,
    "format": "csv"
}

Input parameters

apiKey

Required. Get your personal API key on the My products page.

id

Required. Integer.

ID of the request.

format

Optional. String.

Used to specify the response format.

Allowed values: "xml", "json", "csv".

Default value: "json".

Sample output

{
    "response": [
        {
            "emailAddress": "[email protected]",
            "formatCheck": "true",
            "smtpCheck": "null",
            "dnsCheck": "false",
            "freeCheck": "false",
            "disposableCheck": "false",
            "catchAllCheck": "null",
            "result": "bad"
        },
        {
            "emailAddress": "[email protected]",
            "formatCheck": "true",
            "smtpCheck": "true",
            "dnsCheck": "true",
            "freeCheck": "false",
            "disposableCheck": "false",
            "catchAllCheck": "true",
            "mxRecords": [
                "alt2.aspmx.l.google.com",
                "alt3.aspmx.l.google.com",
                "alt4.aspmx.l.google.com",
                "aspmx.l.google.com",
                "alt1.aspmx.l.google.com"
            ],
            "result": "unknown"
        },
        {
            "emailAddress": "[email protected]",
            "formatCheck": "true",
            "smtpCheck": "true",
            "dnsCheck": "true",
            "freeCheck": "true",
            "disposableCheck": "false",
            "catchAllCheck": "true",
            "mxRecords": [
                "mta6.am0.yahoodns.net",
                "mta5.am0.yahoodns.net",
                "mta7.am0.yahoodns.net"
            ],
            "result": "unknown"
        }
    ]
}

Code: 200 OK.
{
    "response": {
        "error": "Wrong request id"
    }
}

Code: 422 Unprocessable Entity.
response

The response object.

Contains an array of verification results for each email address in the original request (see the documentation below).

Responses to these request can be saved directly to disk.

In case of an error it contains its description in the 'error' field. If there are multiple errors their descriptions are returned in the 'errors' array.

result

The result field may contains four values: 'ok', 'unknown', 'smtp-failed', 'bad'. The 'ok' value means that the email successful passed through the SMTP check, DNS check, and this email address isn’t disposable. The 'bad' value means that some of this checks (except SMTP check) were failed. The 'smtp-failed' value means the email address does not exist on the target SMTP server or temporary couldn't receive messages. The 'unknown' value means that email hosting supports "catch all feature".

emailAddress
The email address to be verified.
formatCheck
Lets you know if there are any syntax errors in the email address. This is a basic check that’s done to catch any simple typos or major errors. This value will be 'true' if there are no errors, and 'false' otherwise. Behind the scenes, the API service is handling all these types of verification checks for you in a number of interesting ways.
smtpCheck
Checks if the email address exists and can receive emails by using SMTP connection and email-sending emulation techniques. This value will be 'true' if the email address exists and can receive email over SMTP, and 'false' if the email address does not exist on the target SMTP server or temporarily couldn't receive messages. The value will be null if the SMTP request could not be completed, mailbox verification is not supported on the target mailbox provider, or not applicable.
dnsCheck
Ensures that the domain in the email address, eg: gmail.com, is a valid domain. This value will be 'true' if the domain is good and 'false' otherwise. May be 'null' for invalid or non-existing emails.
freeCheck
Check to see if the email address is from a free email provider like Gmail or not. This value will be 'false' if the email address is not free, and 'true' otherwise. May be 'null' for invalid or non-existing emails.
disposableCheck
Tells you whether or not the email address is disposable (created via a service like Mailinator). This helps you check for abuse. This value will be 'false' if the email is not disposable, and 'true' otherwise. May be 'null' for invalid or non-existing emails.
catchAllCheck
Tells you whether or not this mail server has a “catch-all” address. This refers to a special type of address that can receive emails for any number of non-existent email addresses under a particular domain. Catch-all addresses are common in businesses where if you send an email to [email protected] and another email to non-existent [email protected], both of those emails will go into the same inbox. Possible values are 'true' or 'false'. May be 'null' for invalid or non-existing emails.
mxRecords
Mail servers list. May be absent for invalid or non-existing emails.