This page describes the response returned by the ID Check API.
Related ID Check documentation:
Request success
The JSON response contains a single DATA1 object with the following keys:
| Key | Possible values | Description | Type |
|---|---|---|---|
| Check_FirstName |
E, S, P, D, ?
|
First name verification result. | STRING(1) |
| Check_BirthDate | See birthdate code table below. | Date of birth verification result. | STRING(3) |
| Check_Number |
True, False
|
Indicates whether the street number matches the database. | STRING(5) |
| HOUSEHOLDID | - | Unique identifier in the database. | STRING(30) |
| FirstName_Dist | - | Number of different characters between the submitted first name and the database value. | STRING(2) |
| LastName_Dist | - | Number of different characters between the submitted last name and the database value. | STRING(2) |
| Result |
FOUND, NOT FOUND
|
Indicates whether the household was found based on address, email, or phone data. | STRING(9) |
| Check_Email |
E, D, ?
|
Email verification result. | STRING(1) |
| Check_LastName |
E, S, P, D, ?
|
Last name verification result. | STRING(1) |
| Check_City |
E, S, P, N, D, ?
|
City verification result. | STRING(1) |
| Check_PostalCode |
E, N, D, ?
|
Postal code verification result. | STRING(1) |
| Check_Phone |
E, D, ?
|
Phone verification result. | STRING(1) |
| Check_Address |
E, S, P, N, D, ?
|
Address verification result. | STRING(1) |
Generic comparison code values:
| Code | Description |
|---|---|
? |
The field was not provided, is not available, or the subscribed product does not allow this check. |
E |
The value in the database is strictly identical to the value provided in the request. |
S |
The value in the database is close to the value provided in the request, up to 10% difference. |
P |
The value in the database is quite far from the value provided in the request, up to 25% difference. |
N |
For address and city: the value is far from the request value, up to 35% difference. For postal code: the first 3 digits match. |
D |
The value in the database is completely different from the value provided in the request. |
Birthdate comparison codes:
| Code | Description |
|---|---|
000 |
Year, month, and day are identical. |
001 |
Year and month are identical, but the day is different. |
010 |
Year and day are identical, but the month is different. |
100 |
Month and day are identical, but the year is different. |
011 |
Year is identical, but month and day are different. |
101 |
Month is identical, but year and day are different. |
110 |
Day is identical, but year and month are different. |
111 |
Year, month, and day are different. |
--- |
No date is available in the database. |
Example:
{
"DATA1": {
"Check_FirstName": "E",
"Check_BirthDate": "000",
"Check_Number": "True",
"HOUSEHOLDID": "3678263863104901575",
"FirstName_Dist": "0",
"LastName_Dist": "0",
"Result": "FOUND",
"Check_Email": "D",
"Check_LastName": "E",
"Check_City": "E",
"Check_Address": "E",
"Check_PostalCode": "E",
"Check_Phone": "D"
}
}Request error
Error responses use the following structure:
{
"status": 400,
"message": "Missing parameters",
"details": "Address",
"error": "bad request"
}| Error case | HTTP status | Message | Details example |
|---|---|---|---|
| Missing, empty, or incorrect licence | 401 |
Your licence is not allowed to cover this functionality |
Empty or incorrect licence code. |
Missing or empty Address
|
400 |
Missing parameters |
Address |
Missing or empty PostalCode
|
400 |
Missing parameters |
PostalCode |
Missing or empty LastName
|
400 |
Missing parameters |
LastName |
| Parameter typo | 400 |
Missing parameters |
Name of the missing expected parameter. |
Related to