API - Description - IDCHECK - Response

Support DQE
Support DQE
  • Updated

Request success

IDCHECK

The JSON response is a dictionary containing a single element "DATA1" whose value is a dictionary containing the following keys:            

KeyPossible valuesDescriptionType
Check_FirstName“E”,”S”,”P”,”D”,”?”First name verification resultSTRING(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 databaseSTRING(5)
HOUSEHOLDID-Unique ID in our databaseSTRING(30)
FirstName_Dist-Number of characters different in our database compared to the first name sent in the requestSTRING(2)
LastName_Dist-Number of characters different in our database compared to the last name sent in the requestSTRING(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 ResultSTRING(1)
Check_City“E”,”S”,”P”,”N”,”D”,”?”City Verification ResultSTRING(1)
Check_PostalCode“E”,”N”,”D”,”?”Postal code verification resultSTRING(1)
Check_Phone”?”NA (only available with ID Check Plus)STRING(1)
Check_Address“E”,”S”,”P”,”N”,”D”,”?”Address Verification ResultSTRING(1)

See below a description of each possible value:

CodeDescription
?The field was not provided in the request or not available on our side, or the product subscribed does not allow this check.
EThe value found in our database is strictly identical to the value provided in the request
SThe value found in our database is close to the value provided in the request (up to 10% difference)
PThe 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.

DThe 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:            

KeyPossible valuesValueType
Check_FirstName“E”,”S”,”P”,”D”,”?”First name verification resultSTRING(1)
Check_BirthDateSee table belowDate of birth verification resultSTRING(3)
Check_Number“True”,”False”"True" or "False" depending on whether the street number provided matches in our databaseSTRING(5)
HOUSEHOLDID-Unique ID in our databaseSTRING(30)
FirstName_Dist-Number of characters different in our database compared to the first name sent in the requestSTRING(2)
LastName_Dist-Number of characters different in our database compared to the last name sent in the requestSTRING(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 verificationSTRING(1)
Check_LastName“E”,”S”,”P”,”D”,”?”Name Verification ResultSTRING(1)
Check_City“E”,”S”,”P”,”N”,”D”,”?”City Verification ResultSTRING(1)
Check_PostalCode“E”,”N”,”D”,”?”Postal code verification resultSTRING(1)
Check_Phone“E”,”D”,”?”Phone verification resultSTRING(1)
Check_Address“E”,”S”,”P”,”N”,”D”,”?”Address Verification ResultSTRING(1)

See below a description of each possible value:

CodeDescription
?The field was not provided in the request or not available on our side, or the product subscribed does not allow this check
EThe value found in our database is strictly identical to the value provided in the request
SThe value found in our database is close to the value provided in the request (up to 10% difference)
PThe 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.

DThe value found in our database is completely different from the value provided in the request

Possible values in the "Check_Birthdate" key:

CodeDescription
000Indicates that the year, month, day are the same
001Indicates that the year and month are the same, but the day is different
010Indicates that the year and day are the same, but the month is different
100Indicates that the month and day are the same, but the year is different
011Indicates that the year is the same, but the month and day are different
101Indicates that the month is the same, but the year and day are different
110Indicates that the day is the same, but the year and month are different
111Indicates 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 typeRequestResponse type
Missing “Licence” parameterhttps://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "",
"error": "unauthorized_client"
}

 Empty

“Licence”

parameter

https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence=
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "",
"error": "unauthorized_client"
}
Incorrect Licence numberhttps://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={INCORRECT_LICENCE_CODE}
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "xxxxxxxxx",
"error": "unauthorized_client"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "Address",
"error": "bad request"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "PostalCode",
"error": "bad request"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "LastName",
"error": "bad request"
}
Error on a parameterhttps://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PstalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&Licence={LICENCE_CODE}
{
"status": 400,
"message": "Missing parameters",
"details": "PostalCode",
"error": "bad request"
}

IDCHECK PLUS

Error typeRequestResponse type
Missing “Licence” parameterhttps://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "",
"error": "unauthorized_client"
}

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=
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "",
"error": "unauthorized_client"
}
Incorrect Licence numberhttps://{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}
{
"status": 401,
"message": "Your licence is not allowed to cover this functionality",
"details": "xxxxxxxxx",
"error": "unauthorized_client"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "Address",
"error": "bad request"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "PostalCode",
"error": "bad request"
}
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}

{
"status": 400,
"message": "Missing parameters",
"details": "LastName",
"error": "bad request"
}
Error on a parameterhttps://{SERVER_ADDRESS}/SEARCH/?Adress={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}
{
"status": 400,
"message": "Missing parameters",
"details": "Address",
"error": "bad request"
}

Related to

Was this article helpful?

0 out of 0 found this helpful