API ID Check — Vérifier un document d'identité

Support DQE
Support DQE
  • Mise à jour

Utilisez cet endpoint pour vérifier l'identité d'une personne en croisant son adresse, son nom, sa date de naissance, son e-mail et son numéro de téléphone avec la base de données DQE.

Documentation ID Check associée :

Requête GET

Endpoint

GET https://{SERVER_ADDRESS}/SEARCH/?Address={ADDRESS}&PostalCode={POSTAL_CODE}&City={CITY}&LastName={NAME}&FirstName={FIRST_NAME}&BirthDate={DATE}&Email={EMAIL}&Phone={PHONE}&Licence={LICENCE_CODE}&Version=2

Remplacez les valeurs entre accolades par vos propres informations.

Paramètre Description Obligatoire
SERVER_ADDRESS Adresse du serveur DQE utilisée pour traiter la requête. Oui
LICENCE_CODE Votre code de licence DQE. Oui
ADDRESS Numéro et nom de rue. Oui
POSTAL_CODE Code postal. Oui
CITY Nom de la ville. Oui
NAME Nom de famille de la personne à vérifier. Oui
FIRST_NAME Prénom de la personne à vérifier. Oui
DATE Date de naissance au format AAAA-MM-JJ. Oui
EMAIL Adresse e-mail à vérifier. Oui
PHONE Numéro de téléphone à vérifier. Oui
Version=2 Retourne les informations de statut de licence. Non

Requête POST

Endpoint

POST https://{SERVER_ADDRESS}/SEARCH/

Envoyez les paramètres suivants dans un corps de requête x-www-form-urlencoded.

Paramètre Description Obligatoire
Licence Votre code de licence DQE. Oui
Address Numéro et nom de rue. Oui
PostalCode Code postal. Oui
City Nom de la ville. Oui
LastName Nom de famille de la personne à vérifier. Oui
FirstName Prénom de la personne à vérifier. Oui
BirthDate Date de naissance au format AAAA-MM-JJ. Oui
Email Adresse e-mail à vérifier. Oui
Phone Numéro de téléphone à vérifier. Oui
Version Retourne les informations de statut de licence lorsque défini sur 2. Non

Réponse

Réponse de succès

La réponse JSON contient un unique objet DATA1 avec les clés suivantes :

Clé Valeurs possibles Description Type
Check_FirstName E, S, P, D, ? Résultat de la vérification du prénom. STRING(1)
Check_BirthDate Voir les codes de date de naissance ci-dessous. Résultat de la vérification de la date de naissance. STRING(3)
Check_Number True, False Indique si le numéro de rue correspond à la base de données. STRING(5)
HOUSEHOLDID - Identifiant unique dans la base de données. STRING(30)
FirstName_Dist - Nombre de caractères différents entre le prénom soumis et la valeur en base de données. STRING(2)
LastName_Dist - Nombre de caractères différents entre le nom de famille soumis et la valeur en base de données. STRING(2)
Result FOUND, NOT FOUND Indique si le foyer a été trouvé sur la base des données d'adresse, d'e-mail ou de téléphone. STRING(9)
Check_Email E, D, ? Résultat de la vérification de l'e-mail. STRING(1)
Check_LastName E, S, P, D, ? Résultat de la vérification du nom de famille. STRING(1)
Check_City E, S, P, N, D, ? Résultat de la vérification de la ville. STRING(1)
Check_PostalCode E, N, D, ? Résultat de la vérification du code postal. STRING(1)
Check_Phone E, D, ? Résultat de la vérification du téléphone. STRING(1)
Check_Address E, S, P, N, D, ? Résultat de la vérification de l'adresse. STRING(1)

Valeurs de code de comparaison génériques :

Code Description
? Le champ n'a pas été fourni, n'est pas disponible, ou le produit souscrit ne permet pas cette vérification.
E La valeur en base de données est strictement identique à la valeur fournie dans la requête.
S La valeur en base de données est proche de la valeur fournie dans la requête, jusqu'à 10 % de différence.
P La valeur en base de données est assez éloignée de la valeur fournie dans la requête, jusqu'à 25 % de différence.
N Pour l'adresse et la ville : la valeur est éloignée de la valeur de la requête, jusqu'à 35 % de différence. Pour le code postal : les 3 premiers chiffres correspondent.
D La valeur en base de données est complètement différente de la valeur fournie dans la requête.

Codes de comparaison de date de naissance :

Code Description
000 L'année, le mois et le jour sont identiques.
001 L'année et le mois sont identiques, mais le jour est différent.
010 L'année et le jour sont identiques, mais le mois est différent.
100 Le mois et le jour sont identiques, mais l'année est différente.
011 L'année est identique, mais le mois et le jour sont différents.
101 Le mois est identique, mais l'année et le jour sont différents.
110 Le jour est identique, mais l'année et le mois sont différents.
111 L'année, le mois et le jour sont différents.
--- Aucune date n'est disponible en base de données.

Exemple :

{
  "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"
  }
}

Réponse d'erreur

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Address",
  "error": "bad request"
}
Cas d'erreur Statut HTTP Message Exemple de détails
Licence manquante, vide ou incorrecte 401 Your licence is not allowed to cover this functionality Code de licence vide ou incorrect.
Address manquant ou vide 400 Missing parameters Address
PostalCode manquant ou vide 400 Missing parameters PostalCode
LastName manquant ou vide 400 Missing parameters LastName
Faute de frappe dans un paramètre 400 Missing parameters Nom du paramètre attendu manquant.

Documentation Swagger

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0