Get Status

Use this API to get the status of the created PAN Verification via OCR request. You need to enter either the reference ID or verification ID to get the status. When you provide both the values, the API prioritises the reference ID.

Response Codes

Sub Code	Status	Message	Next Action
200	SUCCESS	PAN card is valid	-
200	SUCCESS	PAN card is invalid	-
200	SUCCESS	Insufficient balance	Ensure you have sufficient balance and then verify PAN via OCR.
200	SUCCESS	verification attempt failed	Use the API to verify again.
400	ERROR	x-client-id is missing in the request.	Enter all the header information in the API request.
400	ERROR	x-client-secret is missing in the request.	Enter all the header information in the API request.
400	ERROR	provide verification_id or reference_id	Enter a valid verification_id or reference_id in the request.
400	ERROR	Bad request, please check API documentation	Enter a valid reference_id in the request.
401	ERROR	Invalid clientId and clientSecret combination	Ensure you enter valid x-client-id and x-client-secret information in the API request.
403	ERROR	IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification	Whitelist the IP address.
404	ERROR	reference_id does not exist.	Enter a valid reference_id.
404	ERROR	verification_id does not exist.	Enter a valid verification_id
500	ERROR	something went wrong	Try again after some time.

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

Query Parameters

reference_id · string · default: 1358

It is the unique ID created by Cashfree Payments that you receive in the response of PAN Verification via OCR API.

verification_id · string · default: ABC00123

It is the unique ID you created to identify the verification request.

Response

200

application/json

Success response for getting the PAN OCR information

PAN Verification via OCR success response

name · string

It displays the name of the PAN holder.

Example:

"John Doe"

organization_name · string

It displays the name of the organisation the individual runs.

Example:

"ABC pvt ltd."

pan_type · string

It displays the type of PAN issued to the individual.

Example:

"Business"

date_of_incorporation · string

It displays the incorporation date of the individual's organisation.

Example:

"01-01-2000"

dob · string

It displays the date of birth of the individual.

Example:

"01-01-1990"

father · string

It displays the father's name of the individual.

Example:

"Jone Doe"

pan · string

It displays the entered PAN information in the request.

Example:

"ABCPP3011E"

valid · boolean

It displays whethere the entered PAN information is valid.

Example:

true

age · string

It displays the age of the individual.

Example:

"20"

status · string

It displays the status of the PAN information.

Example:

"Valid"

reference_id · string

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

Example:

"123456789"

verification_id · string

It displays the unique ID you created to identify the request.

Example:

"1676668986"

confidence_score · string

It displays the level of confidence or reliability associated with the PAN verification.

Example:

"0.98"

message · string

It displays details about the success or failure of the API request.

Example:

"Valid PAN"