API Restful - Description - Email - LOOKUPEMAIL - Response

Support DQE
Support DQE
  • Updated

"lookupemail" response success

Json description

For a Level 1 verification:

Level 1 verification only verifies the existence of the email on the domain as well as the existence of the domain.

The JSON response is a dictionary with the key "1" and its value is a dictionary containing the following keys :

KeyDescriptionType
FoundNumber of results foundINTEGER
EmailsList of email validation resultsARRAY OF OBJECTS

In "Emails" array of objects :

Key (Path)DescriptionType
Emails[].IdErrorError identifier codeSTRING
Emails[].CorrectedFlag indicating if correction was appliedINTEGER
Emails[].SuggestedEmailSuggested email addressSTRING
Emails[].InputEmailOriginal input email addressSTRING

 

Example :

{
  "Found": 1,
  "Emails": [
    {

      "IdError": "02",
      "Corrected": 0,
      "SuggestedEmail": "toto@gmail.com",
      "InputEmail": "toto@gmail.com"
    }
  ]
}

For a Level 2 verification:

Level 2 verification checks the existence of the email on the domain, the existence of the domain and the activity of the email.

The following key is added to the Emails array of objects for a level 2 verification :

Key (Path)DescriptionType
Emails[].ActivityCodeActivity code inside result objectSTRING

Example :

{
  "Found": 1,
  "Emails": [
    {
      "ActivityCode": "",
      "IdError": "02",
      "Corrected": 0,
      "SuggestedEmail": "toto@gmail.com",
      "InputEmail": "toto@gmail.com"
    }
  ]
}

Code description

For "IdError":

IdError DescriptionUI Display
91Syntax errorPlease check your email address
92Unknown domainPlease check your email address
93Blacklisted email or domain (list provided by client)Please check your email address
94Unauthorized username (reserved name or insult)Please check your email address
95Disposable temporary email addressPlease check your email address
99Service not availableValid email
04Empty emailPlease check your email address
03Inbox is full (Soft Bounce)Please check your email address
02Email address not found for this domainPlease check your email address
01Correct email but name could not be checkedValid email
00Valid emailValid email

For "ActivityCode":

To define the descriptions of the return codes in "ActivityCode", consider “M" as the current month.

Return code in «ActivityCode»Corresponding label
100The email was delivered once
200The email is valid
201Email was active last month
202Between (M-1) and (M-2), email was active
203Between (M-2) and (M-3), email was active
204Between (M-3) and (M-4), email was active
206Between (M-4) and (M-6), email was active
209Between (M-6) and (M-9), email was active
212Between (M-9) and (M-12), email was active
300Inactive email

 

"lookupemail" response error

Error typeRequestResponse type
Missing “Licence” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email=contact@gmailcom&Rectify=y
&extendedsyntax=n&checkuser=y
{"status": 400, "message": "Missing parameters", "details": "Licence", "error": "bad request"}
Empty “Licence” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email=contact@gmailcom&Rectify=y
&extendedsyntax=n&checkuser=y&Licence=
{"status": 400, "message": "Licence must be filled", "details": "", "error": "bad request"}
Incorrect Licence number (expired, out of scope, nonexistent)https://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email=contact@gmailcom&Rectify=y
&extendedsyntax=n&checkuser=y&Licence={INCORRECT_LICENCE_CODE}
{"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "{INCORRECT_LICENCE_CODE}}", "error": "unauthorized_client"}
Missing “Email” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Rectify=y&extendedsyntax=n
&checkuser=y&Licence={LICENCE_CODE}
{"status": 400, "message": "Missing parameters", "details": "Email", "error": "bad request"}
Empty “Email” parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email=&Rectify=y&extendedsyntax=n
&checkuser=y&Licence={LICENCE_CODE}
{"status": 400, "message": "Email must be filled", "details": "*", "error": "bad request"}
Error on a parameterhttps://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Eail=contact@gmailcom&Rectify=y
&extendedsyntax=n&checkuser=y&Licence={LICENCE_CODE}
{"status": 400, "message": "Missing parameters", "details": "Email", "error": "bad request"}

Related to

Was this article helpful?

0 out of 0 found this helpful