| Key | Description | Format |
| status | "success": indicates the correct recovery of information | STRING |
| scope | Contains the scope previously sent | STRING |
| code_name | Contains the code name previously sent | STRING |
| formfilling |
If "formfilling" value sent in the "scope" field of the request. Contains all the keys described in the table below |
JSON OBJECT |
| matching |
If "matching" value sent in the "scope" field of the request. Contains all the keys described in the table below |
JSON OBJECT |
Elements of the "formfilling" key if requested scope includes formfilling :
| Key | Description | Format |
| phone_number | Phone number | STRING(10) |
| family_name | Last name | STRING |
| name | First name and last name | STRING |
| locale | Native language | STRING(3) |
| gender | Gender ("M" for male and "F" for female) | STRING |
| updated_at | Date of the last update of the information | DATE |
| birthdate | Birth date | DATE |
| birthplace | Birth department | STRING |
| given_name | First name | STRING |
| address | Contains all the keys described in the following table | JSON OBJECT |
| Complete email | STRING | |
| email_domain | Email domain | STRING |
| email_account | Email username | STRING |
| subscriber_msisdn | Phone used for the contract subscription | STRING(10) |
| sub | Customer identifier in the operator's database | STRING |
Elements of the “address” key :
| Key | Description | Format |
| country | Country of address in full letter | STRING |
| postal_code | Postal code | STRING(8) |
| formatted | Complete postal address (\n and \r correspond to line breaks) | STRING |
| street_address | Street type and street name | STRING(38) |
| number | Street number | STRING |
| locality | City | STRING(38) |
Elements of the "matching" key if requested scope includes matching:
| Key | Description | Format |
| gender | Result of the comparison on civility | STRING(3) |
| name | Result of the comparison on the first and last name | STRING(3) |
| family_name | Result of the comparison on the last name | STRING(3) |
| given_name | Result of the comparison on the first name | STRING(3) |
| maiden_name | Result of the comparison on the maiden name | STRING(3) |
| Result of the comparison on the email address | STRING(3) | |
| email_account | Result of the comparison on the username | STRING(3) |
| email_domain | Result of the comparison of the email domain | STRING(3) |
| birthdate | Result of the comparison on the date of birth | STRING(3) |
| address | Contains all the keys described in the following table | JSON OBJECT |
Elements of the “address” key :
| Key | Description | Format |
| country | Country of address in full letter | STRING(3) |
| postal_code | Postal code | STRING(3) |
| formatted | Complete postal address (\n and \r correspond to line breaks) | STRING(3) |
| street_address | Street type and street name | STRING(3) |
| number | Street number | STRING(3) |
| locality | City | STRING(3) |
Response example for « formfilling,matching » scope:
{
"status": "success",
"scope": "matching,formfilling",
"code_name": "",
"formfilling": {
"phone_number": "",
"family_name": "",
"name": " -",
"locale": "fr-FR",
"gender": "M",
"email_domain": ".com",
"updated_at": "-08-09",
"birthdate": "-08-30",
"birthplace": "-08-30",
"given_name": " ",
"address": {
"locality": "",
"country": "",
"number": "",
"formatted": "",
"postal_code": "",
"street_address": « "
},
"email_account": "",
"email": "",
"subscriber_msisdn": "",
"sub": " "
},
"matching": {
"family_name": "1.0",
"maiden_name": "1.0",
"gender": "0.0",
"name": "1.0",
"address": {
"country": "1.0",
"postal_code": "1.0",
"number": "1.0",
"street_address": "1.0",
"locality": "1.0"
},
"email_account": "1.0",
"email_domain": "1.0",
"email": "1.0",
"birthdate": "1.0",
"given_name": "1.0"
}
}
Response example for « matching » scope:
{
"status": "success",
"scope": "matching",
"matching": {
"family_name": "0.77",
"name": "0.91",
"maiden_name": "",
"gender": "0.0",
"address": {
"country": "0.88",
"postal_code": "",
"number": "",
"street_address": "",
"locality": ""
},
"birthdate": "",
"given_name": "1.0",
"email_domain": "1.0",
"email_account": "1.0",
"email": "1.0"
}
}
Response example for « formfilling » scope:
{
"status": "success",
"scope": "formfilling",
"formfilling": {
"phone_number": "",
"family_name": "",
"birthplace": "-08-30",
"sub": " "
"locale": "fr-FR",
"gender": "M",
"address": {
"locality": "",
"country": "",
"number": "",
"formatted": "",
"postal_code": "",
"street_address": « "
},
"updated_at": "-08-09",
"name": " -",
"email_domain": ".com",
"birthdate": "-08-30",
"given_name": " ",
"email_account": "",
"email": "",
"subscriber_msisdn": "",
}}