"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 :
| Key | Description | Type |
| Found | Number of results found | INTEGER |
| Emails | List of email validation results | ARRAY OF OBJECTS |
In "Emails" array of objects :
| Key (Path) | Description | Type |
| Emails[].IdError | Error identifier code | STRING |
| Emails[].Corrected | Flag indicating if correction was applied | INTEGER |
| Emails[].SuggestedEmail | Suggested email address | STRING |
| Emails[].InputEmail | Original input email address | STRING |
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) | Description | Type |
| Emails[].ActivityCode | Activity code inside result object | STRING |
Example :
{
"Found": 1,
"Emails": [
{
"ActivityCode": "",
"IdError": "02",
"Corrected": 0,
"SuggestedEmail": "toto@gmail.com",
"InputEmail": "toto@gmail.com"
}
]
}Code description
For "IdError":
| IdError | Description | UI Display |
| 91 | Syntax error | Please check your email address |
| 92 | Unknown domain | Please check your email address |
| 93 | Blacklisted email or domain (list provided by client) | Please check your email address |
| 94 | Unauthorized username (reserved name or insult) | Please check your email address |
| 95 | Disposable temporary email address | Please check your email address |
| 99 | Service not available | Valid email |
| 04 | Empty email | Please check your email address |
| 03 | Inbox is full (Soft Bounce) | Please check your email address |
| 02 | Email address not found for this domain | Please check your email address |
| 01 | Correct email but name could not be checked | Valid email |
| 00 | Valid email | Valid 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 |
| 100 | The email was delivered once |
| 200 | The email is valid |
| 201 | Email was active last month |
| 202 | Between (M-1) and (M-2), email was active |
| 203 | Between (M-2) and (M-3), email was active |
| 204 | Between (M-3) and (M-4), email was active |
| 206 | Between (M-4) and (M-6), email was active |
| 209 | Between (M-6) and (M-9), email was active |
| 212 | Between (M-9) and (M-12), email was active |
| 300 | Inactive email |
"lookupemail" response error
| Error type | Request | Response type |
| Missing “Licence” parameter | https://{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” parameter | https://{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” parameter | https://{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” parameter | https://{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 parameter | https://{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