API - Description - Email - DQEEMAILLOOKUP

Support DQE
Support DQE
  • Updated

Use this endpoint to validate an email address — checking its domain existence, syntax, and optionally its activity status.

Related Email documentation:

GET request

Endpoint

https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&extendedsyntax={SYNTAX}&checkuser={CHECKUSER}&TimeOut={TIME}

Replace the values in braces with your own information:

Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
Email {EMAIL} Email address to validate. Mandatory
Rectify {RECTIFY} y to propose a domain correction when the entered domain is unknown; n otherwise. Optional. Default value: n.
extendedsyntax {SYNTAX} y to accept email addresses with extended syntax; n to limit checks to standard email addresses. Optional. Default value: n.
checkuser {CHECKUSER} y to check the part before the @ sign; n to check only the domain. Optional. Default value: y.
TimeOut {TIME} Maximum query time for data verification, in seconds. Example: 0.5 for 500 ms. Optional

POST request

Endpoint

https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/

Add the following parameters in the request body using x-www-form-urlencoded.

Parameter Value Description Mandatory/Optional
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
Email {EMAIL} Email address to validate. Mandatory
Rectify {RECTIFY} y to propose a domain correction when the entered domain is unknown; n otherwise. Optional. Default value: n.
extendedsyntax {SYNTAX} y to accept email addresses with extended syntax; n to limit checks to standard email addresses. Optional. Default value: n.
checkuser {CHECKUSER} y to check the part before the @ sign; n to check only the domain. Optional. Default value: y.
TimeOut {TIME} Maximum query time for data verification, in seconds. Example: 0.5 for 500 ms. Optional

Response

Success response

Level 1 verification verifies the existence of the domain and validates the email syntax.

The JSON response is a dictionary with the key 1 containing the following fields:

Key Description Type
Redressement 1: domain corrected; 0: no correction applied. INTEGER(1)
eMailOrigine Email address entered by the user. STRING(255)
IdError Validation return code. See the IdError codes table below. STRING(16)
eMail Corrected email address if Rectify=y. STRING(1024)

Example:

{
  "1": {
    "Redressement": 0,
    "eMailOrigine": "test@tesdedet.com",
    "IdError": "92",
    "eMail": "test@tesdedet.com"
  }
}

Level 2 verification additionally checks the activity status of the email address. The following field may be added:

Key Description Type
CodeActivite Provides information about email activity status. See the CodeActivite codes table below. STRING(3)

Example with level 2:

{
  "1": {
    "Redressement": 0,
    "eMailOrigine": "test@tesdedet.com",
    "IdError": "92",
    "eMail": "test@tesdedet.com",
    "CodeActivite": "200"
  }
}

IdError codes

Code Description Suggested UI message
00 Valid email. Valid email
01 Correct email but name could not be checked. Valid email
02 Email address not found for this domain. Please check your email address
03 Inbox is full (soft bounce). Please check your email address
04 Empty email. Please check your email address
91 Syntax error. Please check your email address
92 Unknown domain. Please check your email address
93 Blacklisted email or domain. Please check your email address
94 Unauthorized username. Please check your email address
95 Disposable temporary email address. Please check your email address
99 Service unavailable. Valid email

CodeActivite codes

Consider M as the current month.

Code Description
100 The email was delivered once.
200 The email is valid.
201 Email was active last month.
202 Email was active between M-1 and M-2.
203 Email was active between M-2 and M-3.
204 Email was active between M-3 and M-4.
206 Email was active between M-4 and M-6.
209 Email was active between M-6 and M-9.
212 Email was active between M-9 and M-12.
300 Inactive email.

Error response

Error type Response type
Missing Licence parameter ** LICENCE KO **
Empty Licence parameter ** LICENCE KO **
Incorrect licence number unauthorized_client
Missing or empty Email parameter IdError = 04
Parameter typo IdError = 04

Related to

Was this article helpful?

0 out of 0 found this helpful