Aadhaar Card

Real-time data extraction from an Aadhaar card image

Submit Document

ind_aadhaar_ocr

POST https://secctrl.tutelar.io/api/v1/kyc/vision/ind_aadhaar_ocr

Post parameters description is given below,

Post Parameter	Type	Is Mandatory	Description
front_side	String	Yes	Image Url
back_side	String	No	Image Url

Sample Post Parameters

{
    "front_side": "Base64 or Url",
    "back_side": "Base64 or Url"
}

200: Success Response

{
    "success": true,
    "status_code": 200,
    "message": "Document verification completed successfully.",
    "status": "completed",
    "reference_id": "ed9e065c-d017-41b9-86f7-6ee56684b1b7",
    "result": {
        "document_number": "000000003705",
        "name_on_document": "Dhanushraja Devadasan",
        "fathers_name": "",
        "date_of_birth": "00/00/1994",
        "gender": "Male",
        "is_scanned": null,
        "house_number": null,
        "address": "",
        "street_address": null,
        "pincode": "",
        "district": null,
        "state": null
    },
    "requested_at": "2023-09-22T13:01:38.558Z",
    "completed_at": "2023-09-22T13:01:40.699Z"
}

200: InProgress Response

{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "c3d101d4-c9ec-48df-a25f-60354ec78c78",
    "status": "in_progress",
    "requested_at": "2024-04-22T04:47:39.590Z"
}

400: Validation Error Response

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Upload the front image of Aadhar card",
        "field": "front_side",
        "code": "BAD_REQUEST"
    }
}

200: Failure Response

{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "2b1dfeef-a966-4fe6-b91c-0e5bc960e41b",
    "status": "failed",
    "error": {
        "message": "Aadhaar Not Found.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T04:59:32.741Z",
    "completed_at": "2024-04-22T04:59:33.484Z"
}

Check Document Status

Get document details

GET https://secctrl.tutelar.io/api/v1/kyc/vision/ind_aadhaar_ocr

Query parameters description is given below,

Query Parameter	Type	Is Mandatory	Description
reference_id	String	Yes	Document reference id

200: Success Response

{
    "success": true,
    "status_code": 200,
    "message": "Document verification completed successfully.",
    "status": "completed",
    "reference_id": "ed9e065c-d017-41b9-86f7-6ee56684b1b7",
    "result": {
        "document_number": "000000003705",
        "name_on_document": "Dhanushraja Devadasan",
        "fathers_name": "",
        "date_of_birth": "00/00/1994",
        "gender": "Male",
        "is_scanned": null,
        "house_number": null,
        "address": "",
        "street_address": null,
        "pincode": "",
        "district": null,
        "state": null
    },
    "requested_at": "2023-09-22T13:01:38.558Z",
    "completed_at": "2023-09-22T13:01:40.699Z"
}

200: InProgress Response

    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "c3d101d4-c9ec-48df-a25f-60354ec78c78",
    "status": "in_progress",
    "requested_at": "2024-04-22T04:47:39.590Z"
}

200: Failure Response

{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "c3d101d4-c9ec-48df-a25f-60354ec78c78",
    "status": "failed",
    "error": {
        "message": "Image is non compliant to request/quality standard",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T04:47:39.590Z",
    "completed_at": "2024-04-22T04:47:40.000Z"
}