Request success
IDCHECK
The JSON response is a dictionary containing a single element "DATA1" whose value is a dictionary containing the following keys:
| Key | Possible values | Description | Type |
| Check_FirstName | “E”,”S”,”P”,”D”,”?” | First name verification result | STRING(1) |
| Check_BirthDate | ”?” | NA (only available with ID Check Plus) | STRING(1) |
| Check_Number | “True”,”False” | "True" or "False" depending on whether the street number provided matches in our database | STRING(5) |
| HOUSEHOLDID | - | Unique ID in our database | STRING(30) |
| FirstName_Dist | - | Number of characters different in our database compared to the first name sent in the request | STRING(2) |
| LastName_Dist | - | Number of characters different in our database compared to the last name sent in the request | STRING(2) |
| Result |
“FOUND”, “NOT FOUND” |
Household is defined as FOUND if Last Name and Address are close to our database. | STRING(9) |
| Check_Email | ”?” | NA (only available with ID Check Plus) | STRING(1) |
| Check_LastName | “E”,”S”,”P”,”D”,”?” | Name Verification Result | STRING(1) |
| Check_City | “E”,”S”,”P”,”D”,”?” | City Verification Result | STRING(1) |
| Check_PostalCode | “E”,”N”,”D”,”?” | Postal code verification result | STRING(1) |
| Check_Phone | ”?” | NA (only available with ID Check Plus) | STRING(1) |
| Check_Address | “E”,”S”,”P”,”N”,”D”,”?” | Address Verification Result | STRING(1) |
See below a description of each possible value:
| Code | Description |
| ? | The field was not provided in the request, or the product subscribed does not allow this check |
| E | The value found in our database is strictly identical to the value provided in the request |
| S | The value found in our database is close to the value provided in the request (up to 10% difference) |
| P | The value found in our database is quite far from the value provided in the request (up to 25% difference) |
| N |
For Check_Address and Check_City: The value found in our database is far from the value provided in the request (up to 35% difference) For Check_PostalCode: The first 3 digits are identical with the value found in our database. |
| D | The value found in our database is completely different from the value provided in the request |
Example :
{
"DATA1": {
"Check_FirstName": "D",
"Check_BirthDate": "?",
"Check_Number": "True",
"HOUSEHOLDID": "-4144192729077107476",
"FirstName_Dist": "9",
"LastName_Dist": "0",
"result": "FOUND",
"Check_Email": "?",
"Check_LastName": "E",
"Check_City": "E",
"Check_Address": "E",
"Check_PostalCode": "E",
"Check_Phone": " ?"
}
}
IDCHECK PLUS
The JSON response is a dictionary containing a single element "DATA1" whose value is a dictionary containing the following keys:
| Key | Possible values | Value | Type |
| Check_FirstName | “E”,”S”,”P”,”D”,”?” | First name verification result | STRING(1) |
| Check_BirthDate | See table below | Date of birth verification result | STRING(3) |
| Check_Number | “True”,”False” | "True" or "False" depending on whether the street number provided matches in our database | STRING(5) |
| HOUSEHOLDID | - | Unique ID in our database | STRING(30) |
| FirstName_Dist | - | Number of characters different in our database compared to the first name sent in the request | STRING(2) |
| LastName_Dist | - | Number of characters different in our database compared to the last name sent in the request | STRING(2) |
| Result |
“FOUND”, “NOT FOUND” |
Household is defined as FOUND if Last Name and Address or Email or Phone are close to our database. | STRING(9) |
| Check_Email | “E”,”D”,”?” | Result of email address verification | STRING(1) |
| Check_LastName | “E”,”S”,”P”,”D”,”?” | Name Verification Result | STRING(1) |
| Check_City | “E”,”S”,”P”,”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) |
See below a description of each possible value:
| Code | Description |
| ? | The field was not provided in the request, or the product subscribed does not allow this check |
| E | The value found in our database is strictly identical to the value provided in the request |
| S | The value found in our database is close to the value provided in the request (up to 10% difference) |
| P | The value found in our database is quite far from the value provided in the request (up to 25% difference) |
| N |
For Check_Address and Check_City: The value found in our database is far from the value provided in the request (up to 35% difference) For Check_PostalCode: The first 3 digits are identical with the value found in our database. |
| D | The value found in our database is completely different from the value provided in the request |
Possible values in the "Check_Birthdate" key:
| Code | Description |
| 000 | Indicates that the year, month, day are the same |
| 001 | Indicates that the year and month are the same, but the day is different |
| 010 | Indicates that the year and day are the same, but the month is different |
| 100 | Indicates that the month and day are the same, but the year is different |
| 011 | Indicates that the year is the same, but the month and day are different |
| 101 | Indicates that the month is the same, but the year and day are different |
| 110 | Indicates that the day is the same, but the year and month are different |
| 111 | Indicates that the year, month, day are different |
| --- | Indicates that we do not have a date in 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
IDCHECK
| Error type | Request | Response type |
| Missing “Licence” parameter | https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME} |
{
|
|
Empty “Licence” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence= |
{
|
| Incorrect Licence number | https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={INCORRECT_LICENCE_CODE} |
{
|
| Missing or Empty “Address” parameter |
https://{SERVER_ADDRESS}/SEARCH/?PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/SEARCH/?Address=&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE} |
{
|
| Missing or Empty “PostalCode” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode=&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE} |
{
|
| Missing or Empty “LastName” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE} https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName=&FirstName={FIRST_NAME}&Licence={LICENCE_CODE} |
{
|
| Error on a parameter | https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PstalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE} |
{
|
IDCHECK PLUS
| Error type | Request | Response type |
| Missing “Licence” parameter | https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE} |
{
|
|
Empty “Licence” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence= |
{
|
| Incorrect Licence number | https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={INCORRECT_LICENCE_CODE} |
{
|
| Missing or Empty “Address” parameter |
https://{SERVER_ADDRESS}/SEARCH/?PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/SEARCH/?Address=&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE} |
{
|
| Missing or Empty “PostalCode” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode=&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence ={LICENCE_CODE} |
{
|
| Missing or Empty “LastName” parameter |
https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE} https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName=&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE} |
{
|
| Error on a parameter | https://{SERVER_ADDRESS}/SEARCH/?Adress={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE} |
{
|
Related to