IDideal-postcodes
Emails

Email Validation

Changed on

Query for and validate email addresses.

get/emails

Request

  • Base URL
    https://api.ideal-postcodes.co.uk/v1
  • URL
    https://api.ideal-postcodes.co.uk/v1/emails
  • Auth
    none declared

Query parameters

api_keystring

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard

querystring required

Specifies the email address to validate

tagsstring

** Tags ** 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".

Response

Success

code2000 required
message'Success' required

Example response

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

Changes

  • 1b87cbe3241cRevision changes
    • warning

      deleted the query request parameter Tags

    • info

      added the new optional query request parameter tags

  • 4e708815aaceRevision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status