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 champimage_url, puis vous pouvez remplir le contenu correspondant sur l’interface, comme indiqué dans l’image ci-dessous :

accept: le format de réponse souhaité, ici rempli commeapplication/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.
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, supportecopy_warn,border_check_warn,reshoot_warn,detect_ps_warn,temp_id_warn,quality(seuil de 0 à 100).

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.
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.

