API Restful - Description - Email - LOOKUPEMAIL - Response

Support DQE
Support DQE
  • Updated

This page describes the response returned by the Restful Email /email/lookup endpoint.

Related Email documentation:

Restful Email response

Success response

The JSON response contains validation details for the provided email address.

Key Description Type
IdError Error code returned by the API. INTEGER
Error Error message associated with the validation result. STRING
Formatted Normalized and formatted email address. STRING
LocalPart Part before the @ symbol. STRING
Domain Email domain name. STRING
Tld Top-level domain. STRING
IsValid Indicates whether the email syntax is valid. BOOLEAN
IsDisposable Indicates whether the email belongs to a disposable provider. BOOLEAN
IsCatchAll Indicates whether the domain accepts all email addresses. BOOLEAN
IsFree Indicates whether the provider is free. BOOLEAN
IsRole Indicates whether the address is role-based. BOOLEAN
IsDeliverable Indicates whether the email address is deliverable. BOOLEAN
HasSuggestedCorrection Indicates whether a correction suggestion is available. BOOLEAN
SuggestedCorrection Suggested corrected email address. STRING
DomainExists Indicates whether the domain exists. BOOLEAN
HasMxRecords Indicates whether MX records are available. BOOLEAN

Example:

{
  "IdError": 0,
  "Error": "",
  "Formatted": "test@gmail.com",
  "LocalPart": "test",
  "Domain": "gmail.com",
  "Tld": "com",
  "IsValid": true,
  "IsDisposable": false,
  "IsCatchAll": false,
  "IsFree": true,
  "IsRole": false,
  "IsDeliverable": true,
  "HasSuggestedCorrection": false,
  "SuggestedCorrection": "",
  "DomainExists": true,
  "HasMxRecords": true
}

Error response

Error type Response type
Missing or invalid authentication 401 Unauthorized
Missing email parameter 400 Bad Request
Invalid email syntax Validation error response

Related to

Was this article helpful?

0 out of 0 found this helpful