Voter Id

Real-time information extraction from a picture of a voter identification card.

Submit Document

ind_voter_id_ocr

POST https://secctrl.tutelar.io/api/v1/kyc/vision/ind_voter_id_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,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "5b4fb1e0-a3e4-4efc-9868-3fa20e801a1f",
    "status": "completed",
    "result": {
        "document_number": "ASP0047487",
        "name_on_document": "bharathithasan",
        "fathers_name": "rajkumar",
        "date_of_birth": null,
        "age": null,
        "gender": null,
        "is_scanned": false,
        "house_number": null,
        "address": null,
        "street_address": null,
        "pincode": null,
        "district": null,
        "state": null
    },
    "requested_at": "2024-04-22T06:44:47.928Z",
    "completed_at": "2024-04-22T06:44:53.000Z"
}

200: InProgress Response

{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "2fd4c21f-478d-4e52-bdc1-87ac29cdb300",
    "status": "in_progress",
    "requested_at": "2024-04-22T06:15:03.375Z"
}

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": "661e2042-c4ba-4966-bff3-98c6458e4b2b",
    "status": "failed",
    "error": {
        "message": "Image is non compliant to request/quality standard",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:30:22.793Z",
    "completed_at": "2024-04-22T06:30:25.000Z"
}

Check Document Status

Get document details

GET https://secctrl.tutelar.io/api/v1/kyc/vision/ind_voter_id_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,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "5b4fb1e0-a3e4-4efc-9868-3fa20e801a1f",
    "status": "completed",
    "result": {
        "document_number": "ASP0047487",
        "name_on_document": "bharathithasan",
        "fathers_name": "rajkumar",
        "date_of_birth": null,
        "age": null,
        "gender": null,
        "is_scanned": false,
        "house_number": null,
        "address": null,
        "street_address": null,
        "pincode": null,
        "district": null,
        "state": null
    },
    "requested_at": "2024-04-22T06:44:47.928Z",
    "completed_at": "2024-04-22T06:44:53.000Z"
}

200: InProgress Response

{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "2fd4c21f-478d-4e52-bdc1-87ac29cdb300",
    "status": "in_progress",
    "requested_at": "2024-04-22T06:15:03.375Z"
}

200: Failure Response

{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "661e2042-c4ba-4966-bff3-98c6458e4b2b",
    "status": "failed",
    "error": {
        "message": "Image is non compliant to request/quality standard",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:30:22.793Z",
    "completed_at": "2024-04-22T06:30:25.000Z"
}