OCR

Aadhaar QR decode

Decodes an Aadhaar QR from an Aadhaar card image or cropped QR image. Accepts multipart/form-data with exactly one of file (binary image) or image_b64 (base64 image bytes). Requires X-API-KEY and X-Client-ID headers.

post/verify/aadhar_qr

Request

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

Request body multipart/form-data

filestring binary

Aadhaar card image or cropped QR image. Supported formats: JPEG, PNG, WebP, BMP, TIFF. Maximum size: 11 MB.

image_b64string

Base64-encoded Aadhaar card image or cropped QR image bytes. Send this instead of file.

user_idstring nullable

Optional merchant user identifier for tracking.

workflow_session_tokenstring nullable

Optional workflow session token when called inside a workflow.

Example request

{
  "image_b64": "<base64_of_image_bytes>"
}

Response

Aadhaar QR decode result. Timeouts after the configured decode window are returned as no-readable-QR failures.

OR

Example response

{
  "status": "success",
  "message": "Aadhaar QR decoded successfully",
  "data": {
    "name": "Example User",
    "dob": "01-01-1990",
    "gender": "M",
    "address": "House 1, Example Street, Example City, 110001",
    "id_number": "123412341234"
  },
  "chargeble": "true",
  "user_consent": "true"
}

Changes

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