The businesses need to enter either base 64 or the URL of the PAN front image. The businesses can configure these checks with our PAN OCR Verification journey.
JSON
{
"front_url": "<Image URL>"
"front_base64":"<Base 64>"
}JSON
{
"transaction_id": "",
"journey_transaction_id": "",
"journey_id": "",
"status": "SUCCESS|FAILURE|IN_PROGRESS",
"status_code": "Refer to the table below",
"message": "Refer to the table below",
"decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
"checks": [],
"data": {
"keys": {
"pan": [
{
"pan_no": "XXXX",
"name": "XXXX XXX",
"dob": "18/05/1992",
"fathers_name": "",
"user_pan_image": "<Image link>|base64",
"source": "OCR",
"issuer": "ITR",
"decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
"checks": []
}
]
}
}
}📘
*Size of the image should be less than 2 MB.
*The supported formats for OCR input are JPG, JPEG and PNG.
📘 Scenario Http Status Code status status_code message When request is successful and PAN details are available. 200 SUCCESS success Request successful When pan_no provided is not a valid PAN format 200 FAILURE invalid_pan_no pan_no is Invalid Invalid image 200 FAILURE invalid_input Invalid Image, please upload a valid image When no details found at Source for given PAN Number/ PAN Image 200 FAILURE document_not_found Entity not found When Input doesn't contain the pan_no field. 400 FAILURE invalid_request pan_no is required Invalid Client Credentials 401 FAILURE invalid_credentials Invalid Client Credentials Any unhandled error from Equal end 500 FAILURE internal_server_error Something went wrong, please try again. Too many requests 429 No object will be sent, throttling happens at the gateway level. Service Unavailable 503 Both formats(Base 64 and URL) are entered 400 FAILURE invalid_request Enter only one Base 64 or URL None of the inputs (Base 64 or URL) provided 400 FAILURE invalid_request One of the inputs Base 64 or URL is required Unsupported media types 400 FAILURE invalid_request Invalid file type, only PNG, JPG, and JPEG files are allowed Image too large 400 FAILURE invalid_request File size exceeds the maximum limit of 2MB Invalid Base 64 400 FAILURE invalid_request Invalid base64 content Invalid URL 400 FAILURE invalid_request Invalid URL
Possible Values Description SUCCESS Shows that the verification process was completed successfully. FAILURE Indicates that the verification process did not succeed. IN_PROGRESS Signifies that the verification process is currently underway and has not yet been completed.
Possible Values Description CLEAR Indicates that the verification has been completed and the information is confirmed as accurate and legitimate. MUST REVIEW Signifies that further review is needed due to potential issues or inconsistencies in the verification results. NEEDS REVIEW Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made.
📘 Key Description transaction_id Unique identifier for the transaction. journey_transaction_id Unique identifier for the journey transaction. journey_id Unique identifier for the journey. status Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS. status_code Code representing the specific status of the transaction. Refer to the documentation for possible values. message Detailed message about the transaction status. Refer to the documentation for specific messages. decision Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. checks List of checks performed during the transaction. data Container for additional data related to the transaction. pan List of PAN-related data points. pan_no PAN number of the holder. name Name of the PAN holder. dob Date of birth of the PAN holder. fathers_name Father's name of the PAN holder, if available. user_pan_image Image of the PAN card, either as a link or in base64 format. source Source from which the data was extracted (e.g., OCR). issuer Issuer of the PAN (e.g., ITR). decision (key) Decision for this specific key. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW. checks (key) List of checks performed on this specific key.
