Skip to main content
POST
Document Verification — Kenya ID
Vérifiez la carte de national ID kényane d’un client en téléversant une photo — aucune saisie manuelle de l’ID requise. Extraction OCR plus une concordance faciale requise par rapport à un selfie — pas de vérification de vivacité (pas de vidéo, pas de défi de clignement/mouvement).
Il s’agit d’un document recto-verso — fournissez à la fois document_front et document_back pour l’extraction la plus complète. Le Kenya a deux générations de cartes d’identité en circulation : l’ancien design plastifié et le nouveau « Maisha Card ». Les champs spécifiques à la Maisha Card (serial_number, place_of_issue, date d’expiration) reviendront vides sur une carte plus ancienne — c’est attendu, pas une erreur.
selfie_image est requis — le visage extrait du document est comparé à celui-ci. Il s’agit d’une comparaison d’image fixe (pas de vivacité).

Endpoint

Requête

En-têtes

Paramètres de corps

Exemple

Réponse

200 OK

Champs additionnelsextra_fields porte tout ce que la carte a imprimé au-delà des champs listés ci-dessus : district_of_birth, et — uniquement lorsque document_back a été fourni — district, division, location, sub_location, barcode_number, et les trois lignes MRZ (mrz_line1/mrz_line2/mrz_line3, exactement telles qu’imprimées, y compris les caractères de remplissage < — non décodées). Seuls les champs réellement présents sur la carte sont inclus.
Notes de concordance faciale — si le service de comparaison lui-même échoue, attempted reflète si une comparaison a réellement été exécutée et verified revient null avec un champ reason expliquant pourquoi — c’est différent de verified: false, qui signifie que la comparaison a été exécutée et que les visages ne correspondaient pas. Un problème de concordance faciale ne bloque jamais les données du document sous-jacent — le reste de data est toujours renvoyé.

400 Bad Request

401 Unauthorized

Pour une liste complète des codes d’erreur, consultez la référence Codes d’erreur.

Autorisations

x-access-token
string
header
requis

Your Adhere API secret key

Corps

multipart/form-data
document_front
file
requis

Front of the ID card. JPG or PNG, max 5MB.

document_back
file

Back of the card. Optional, but recommended — extraction may be less complete without it.

selfie_image
file

A selfie to compare against the face extracted from the document. JPG or PNG, max 5MB. Required.

Réponse

Document details extracted successfully

status
string
Exemple:

"success"

data
object
message
string
Exemple:

"Document details retrieved successfully"