Data Quality user documentation
home/Email validation/Experian Email Validation v2/Realtime API reference/Realtime email validation

Realtime email validation

Headers

Name Type Description
Auth-Token string Input your unique token here. This is required to submit an API request.
Add-Metadata
(Optional)		 boolean Specify whether the response should return all fields and values, in addition to the main core information.
Reference-Id
(Optional)		 string Identifier that will be returned to the response to help you track the request.
Timeout-Seconds
(Optional)		 integer Maximum time you are prepared to wait for a response, expressed in seconds.
Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

The default value of this setting is 15.

Body parameter

Field Type Description
email string The email that you are submitting for validation.

Headers

Name Type Description
Reference-Id
(Optional)		 string Identifier that was supplied by you in the request header to help you track the request.

Body

The response from the API returns the below fields within a result object. Should an error occur, an error object is returned instead.

Name Type Description
email string The email address that you are submitting for validation.
confidence string The outcome of the validation. Check out Confidence Level for details.
verbose_output string Additional information on the confidence level. Check out Confidence Level for details.
did_you_mean collection A list of more likely email addresses. Suggestions include fixes to syntax errors in the provided email address, typos in domains etc. Check out Suggestions for details.

Metadata

Name Type Description
domain_detail object Provides information about the domain of the email address.
type string A string that identifies whether the domain is a business domain or a consumer domain. This field is omitted when the domain type cannot be determined.
Available values:
  • Consumer - returned for free, publicly available domains such as gmail.com.
  • Business - returned for domains associated with organisations, companies, or enterprises.
normalized_email string The normalised version of the email address, provided in a consistent and standardised format.

Below you have an example of a successful response returned by the API.

Content-Type: application/json; charset=utf-8 Date: 29 Mar 2019 11:19:09 GMT
Message: OK X-Rate-Limit-Limit: 27000 X-Rate-Limit-Remaining: 26999
X-Rate-Limit-Reset: 1553858400 Reference-Id: EV-V2-RT-test Transaction-Id:
19ecd20e-e179-4a22-9c3b-b22e4beb9013

{
  "result": {
    "confidence": "illegitimate",
    "did_you_mean": [
      "support@experian.com"
    ],
    "verbose_output": "roleAccount",
    "email": "support@experian.cim"
  },
  "metadata": {
    "domain_detail": {
      "type": "business"
    }
  }
}
Experian Email Validation v2

Realtime API reference