POST
/
generic-ocr
{
  "verification_id": "test_verification_id",
  "reference_id": "1358",
  "status": "VALID",
  "document_type": "PAN",
  "document_fields": {
    "pan": "DUXPR7763F",
    "dob": "2004-10-02T00:00:00.000Z",
    "name": "John Doe",
    "father": "Josh Doe"
  },
  "quality_checks": {
    "partially_present": false,
    "black_and_white": false,
    "face_present": true,
    "qr_present": false
  },
  "fraud_checks": {
    "is_screenshot": true,
    "is_photo_of_screen": false
  }
}

Authorizations

x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

x-cf-signature
string

Send the signature if IP is not whitelisted

x-api-version
string
required

API version to be used. Format is in YYYY-MM-DD

Body

multipart/form-data

Request parameters for Generic OCR.

document_type
string
default:
PAN
required

Tag depicts the document type of the file being shared in the request. Allowed values are PAN or AADHAAR.

image
file
required

Image of the document. Allowed file types: JPEG, JPG, or PNG. The maximum file size is 5 MB.

verification_id
string
default:
test_verification_id
required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Response

200 - application/json

Success response for retrieving the list of information associated with the mobile number.

document_fields
object

Structure with all the relevant fields in the input image.

document_type
string

The field will show the document_type shared or predicted if it is not shared in the request.

fraud_checks
object

It displays the personal information of the mobile number holder.

quality_checks
object

Contains all the quality checks the product performs on the given input image.

reference_id
string

It displays the unique ID created by Cashfree Payments for reference purposes.

verification_id
string

It is the unique ID shared by the merchant for each request.