Passer au contenu principal
Cet article présente une documentation sur l’API de vérification de photo d’identité, qui peut être utilisée pour transmettre une photo de la face d’une carte d’identité, reconnaître les informations sur la photo de la carte d’identité, et comparer le nom, le numéro de la carte d’identité et la photo de la carte d’identité avec les photos de documents d’une base de données autorisée, afin de vérifier si cela appartient à la même personne, et ainsi valider l’authenticité des informations de la carte d’identité.

Processus de demande

Pour utiliser l’API, vous devez d’abord vous rendre sur la page correspondante de l’API de vérification de photo d’identité pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué dans l’image ci-dessous : Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle. Lors de la première demande, un quota gratuit sera offert, vous permettant d’utiliser l’API gratuitement.

Utilisation de base

Tout d’abord, comprenez la méthode d’utilisation de base, qui consiste à entrer le lien de l’image de la carte d’identité pour obtenir le résultat de vérification après traitement. Vous devez d’abord transmettre un champ image_url, puis vous pouvez remplir le contenu correspondant sur l’interface, comme indiqué dans l’image ci-dessous :

Vous pouvez voir ici que nous avons configuré les en-têtes de requête, y compris :
  • accept : le format de réponse souhaité, ici rempli comme application/json, c’est-à-dire au format JSON.
  • authorization : la clé d’API pour appeler l’API, que vous pouvez sélectionner directement après la demande.
De plus, nous avons configuré le corps de la requête, y compris :
  • image_url : le lien de l’image de la carte d’identité à traiter.
  • config : options de configuration facultatives, champs de type booléen, par défaut tous à false, supporte copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (seuil de 0 à 100).
Après sélection, vous pouvez voir que le code correspondant a également été généré à droite, comme indiqué dans l’image ci-dessous :

Cliquez sur le bouton « Try » pour effectuer un test, comme indiqué sur l’image ci-dessus, et nous avons obtenu le résultat suivant :
{
  "sim": 99.76,
  "result": "Success",
  "description": "Succès",
  "name": "Nom sur la carte d'identité",
  "sex": "Sexe sur la carte d'identité",
  "nation": "Nationalité sur la carte d'identité",
  "birth": "Date de naissance sur la carte d'identité",
  "address": "Adresse sur la carte d'identité",
  "id_num": "Numéro de la carte d'identité",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}
Le résultat de retour contient plusieurs champs, décrits comme suit :
  • sim, similarité, plage de valeurs [0.00, 100.00]. Il est recommandé de considérer une similarité supérieure ou égale à 70 comme étant la même personne, vous pouvez ajuster le seuil selon le contexte spécifique (le taux de faux positif pour un seuil de 70 est de un pour mille, pour un seuil de 80, c’est un pour dix mille).
  • result, code d’erreur métier, renvoie Success en cas de succès, pour les erreurs, veuillez vous référer à la section des codes d’erreur ci-dessous dans la partie FailedOperation.
  • description, résultat de la vérification du nom et du numéro de la carte d’identité.
  • name, informations sur le nom dans la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • sex, informations sur le sexe dans la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • nation, informations sur la nationalité dans la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • birth, informations sur la date de naissance dans la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • address, informations sur l’adresse dans la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • id_num, informations sur le numéro de la carte d’identité, vide si aucune image de carte d’identité n’est téléchargée.
  • portrait, code base64 de la photo de portrait de la carte d’identité, si le découpage échoue, l’ensemble de la carte d’identité sera utilisé pour la comparaison et renverra vide.
  • warnings, informations d’alerte, lorsque des informations d’alerte sont configurées dans Config, la comparaison de portrait sera arrêtée, le résultat renverra une erreur (FailedOperation.OcrWarningOccurred) et contiendra cette information d’alerte.
  • quality, score de qualité de l’image, ce paramètre n’a de sens que si une alerte de flou est configurée dans la requête Config, plage de valeurs (0~100), le seuil par défaut est actuellement de 50, en dessous de 50 déclenchera une alerte de flou.
  • encryption, informations de cryptage des données sensibles.
On peut voir que les informations de la carte d’identité ont une très haute authenticité. De plus, si vous souhaitez générer le code d’intégration correspondant, vous pouvez le copier directement, par exemple, le code CURL est le suivant :
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
Le code d’intégration en Python est le suivant :
import requests

url = "https://api.acedata.cloud/identity/idcard/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Gestion des erreurs

Lors de l’appel de l’API, si une erreur se produit, l’API renverra le code d’erreur et les informations correspondantes. Par exemple :
  • 400 token_mismatched : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 400 api_not_implemented : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 401 invalid_token : Non autorisé, jeton d’autorisation invalide ou manquant.
  • 429 too_many_requests : Trop de requêtes, vous avez dépassé la limite de taux.
  • 500 api_error : Erreur interne du serveur, quelque chose s’est mal passé sur le serveur.

Exemple de réponse d’erreur

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "échec de la récupération"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Conclusion

Grâce à ce document, vous avez compris comment utiliser l’API de vérification de photo d’identité pour transmettre une photo de la face d’une carte d’identité, reconnaître les informations sur la photo de la carte d’identité, et comparer le nom, le numéro de la carte d’identité et la photo de la carte d’identité avec les photos de documents d’une base de données autorisée, afin de vérifier si cela appartient à la même personne, et ainsi valider l’authenticité des informations de la carte d’identité. Nous espérons que ce document vous aidera à mieux intégrer et utiliser cette API. Si vous avez des questions, n’hésitez pas à contacter notre équipe de support technique.