API Docs · eKYC Core

ID Card

Endpoints of the eKYC Core API for reading, sanity-checking, and verifying identity cards and other documents (including QR codes carried on them).

The composite Read ID card info with sanity endpoint lives on Customized API rather than here.

Read ID card infoPOST/v1/read_id_card_info_syncReads one or two ID card images and returns the text parsed from the card, together with where the card sits inside each image.Verify ID cardPOST/v1/verify_id_card_sanity_syncChecks the sanity of one or two ID card images and returns a good verdict, or the first quality issue found.Detect ID card tamperingPOST/v1/detect_id_card_tampering_syncChecks one or two ID card images for physical or digital tampering and returns a verdict per feature checked, plus a final verdict.Detect ID cardsPOST/v1/detect_id_cards_syncFinds the identity cards in an image and returns each card's label and the coordinates of its four corners.Read doc infoPOST/v1/read_doc_info_syncReads the pages of a supported legal document and returns the text parsed from it, together with where the document sits inside each image.Read QR infoPOST/v1/read_qr_infoParses the raw text read from the QR code on an identity card into named card fields.Verify identityPOST/v1/verify_identity_syncChecks an identity card against a portrait image and returns a trust verdict, optionally verifying age from the date of birth on the card.