Email Validation

GET 
/emails

Query for and validate email addresses.

Request

Query Parameters

api_key string
API Key
Your unique identifier that allows access to our APIs.
Begins ak_. Available from your dashboard
Example: ak_test
query stringrequired

Specifies the email address to validate

Tags string
A comma separated list of tags to query over.
Useful if you want to specify the circumstances in which the request was made.
If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching "foo,bar" will only query requests which tagged both "foo" and "bar".
Example: foo,bar

Responses

200

Success

application/json

Schema

Schema

code int32required

Possible values: [2000]

message stringrequired

Possible values: [Success]

result object required

oneOf

Email Object

result stringrequired

Possible values: [deliverable, not_deliverable]

deliverable booleanrequired

Returns true if the email can be delivered

disposable booleanrequired

Returns true if email comes from a disposable email service like temp-mail

free booleanrequired

Returns true if the email originates from a free service like Outlook or Gmail.

role booleanrequired

Returns true if email address represents an organisational role like admin, support, postmaster etc

catchall booleanrequired

Returns true if this domain accepts all emails regardless of username

Unknown Email Object

result stringrequired

Possible values: [unknown]

deliverable booleannullablerequired

Possible values: [null]

Deliverability is not known

disposable booleannullablerequired

Possible values: [null]

Disposability is not known

free booleannullablerequired

Possible values: [null]

Free email provider is not known

role booleannullablerequired

Possible values: [null]

Role is not known

catchall booleannullablerequired

Possible values: [null]

Catch-all status is not known

Example (from schema)

{
  "result": {
    "result": "deliverable",
    "deliverable": true,
    "catchall": false,
    "free": false,
    "role": true,
    "disposable": false
  },
  "code": 2000,
  "message": "Success"
}

Valid Email

{
  "result": {
    "result": "deliverable",
    "deliverable": true,
    "catchall": false,
    "free": false,
    "role": true,
    "disposable": false
  },
  "code": 2000,
  "message": "Success"
}

400

Bad Request

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

errors object[]
Array [
message stringrequired
Indicates location of error in request query or URL parameter
path stringrequired
Indicates location of error in request query or URL parameter
errorCode string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    {
      "message": "should have required property 'type'",
      "path": ".query.type",
      "errorCode": "required.openapi.validation"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

code int32required

API Response Code. Non 2xxx code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging.

message stringrequired

Human readable error message supplied with every error response.

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...