Pan Card OCR

Extracting information in real time from a PAN card image of a person or business.

Submit Document

ind_pan_ocr

POST https://secctrl.tutelar.io/api/v1/kyc/vision/ind_pan_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": "20ac0e3c-25cc-499d-8e6d-a63c81a52547",
    "status": "completed",
    "result": {
        "document_number": "BFAPL0000A",
        "name_on_document": "John Doe",
        "fathers_name": "Chineyi Lohe",
        "date_of_birth": "2001-09-10"
    },
    "requested_at": "2024-04-22T06:54:23.464Z",
    "completed_at": "2024-04-22T06:54:25.632Z"
}

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": "d8f8ec55-35c0-4d8c-86d1-3156c9587855",
    "status": "failed",
    "error": {
        "message": "PAN Not Found.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:24:49.300Z",
    "completed_at": "2024-04-22T06:24:50.164Z"
}

Check Document Status

Get document details

GET https://secctrl.tutelar.io/api/v1/kyc/vision/ind_pan_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": "20ac0e3c-25cc-499d-8e6d-a63c81a52547",
    "status": "completed",
    "result": {
        "document_number": "BFAPL0000A",
        "name_on_document": "John Doe",
        "fathers_name": "Chineyi Lohe",
        "date_of_birth": "2001-09-10"
    },
    "requested_at": "2024-04-22T06:54:23.464Z",
    "completed_at": "2024-04-22T06:54:25.632Z"
}

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"
}```postman_json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "d8f8ec55-35c0-4d8c-86d1-3156c9587855",
    "status": "failed",
    "error": {
        "message": "PAN Not Found.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:24:49.300Z",
    "completed_at": "2024-04-22T06:24:50.164Z"
}
```

200: Failure Response

{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "d8f8ec55-35c0-4d8c-86d1-3156c9587855",
    "status": "failed",
    "error": {
        "message": "PAN Not Found.",
        "code": "ERROR"
    },
    "requested_at": "2024-04-22T06:24:49.300Z",
    "completed_at": "2024-04-22T06:24:50.164Z"
}