Aadhaar OCR v2

Aadhaar OCR v2

Extracts structured Aadhaar details (masked Aadhaar number, name, date of birth, gender, care-of, address) from an uploaded image or PDF using OCR, via the customer's configured v2 verification setup. The Aadhaar number is always returned masked.

Response contract: A successful extraction returns HTTP 200 with status: "success", error_code: null, and a populated data object. A valid upload with nothing readable also returns HTTP 200, but with status: "failed", a non-null error_code (IDTO_202), and data: null — do not treat HTTP 200 alone as success; always branch on status and inspect error_code. An unreadable or oversized image returns HTTP 413 (IDTO_503). Authenticate with your X-Client-ID and X-API-KEY headers.

post/v2/verify/aadhaar_ocr

Request

  • Base URL
    https://prod.idto.ai
  • URL
    https://prod.idto.ai/v2/verify/aadhaar_ocr
  • Auth
    API key in header X-Client-ID and API key in header X-API-KEY

Request body multipart/form-data

filestring binary required

Upload a clear JPG, PNG or PDF of the Aadhaar card.

Response

OCR completed. Inspect status and error_code for the business result.

statusstring required
messagestring nullable
error_codestring nullable
tranx_idstring nullable
timestampstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.