Skip to main content
POST
/
passport
Verify Passport
curl --request POST \
  --url https://sandbox.cashfree.com/verification/passport \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "ABC00123",
  "name": "John Doe",
  "file_number": "PA1079341954215",
  "dob": "2007-03-01"
}
'
{
  "verification_id": "ABC00123",
  "reference_id": 1358,
  "status": "VALID",
  "file_number": "PA1079341954215",
  "name": "John doe",
  "dob": "1998-12-31",
  "application_type": "NORMAL",
  "application_received_date": "2003-12-31"
}
Sub codeStatusMessageNext action
200SUCCESSVALID-
200SUCCESSINVALIDEnter the correct information in the request.
400ERRORverification_id is missing in the request.Enter a valid verification_id in the request.
400ERRORverification_id can include only alphanum, dot, hyphen, and underscores.Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.
400ERRORfile_number is missing in the request.Enter the file number in the request.
400ERRORdob is missing in the request.Enter the date of birth of the passport holder in the request.
400ERRORdob should be of type YYYY-MM-DD.Enter the DOB in the YYYY-MM-DD format.
400ERRORClient secret belongs to test environment.Enter the correct environment credentials in the request.
400ERRORx-client-id is missing in the request.Enter all the header information in the API request.
401ERRORInvalid clientId and clientSecret combination.Ensure you enter valid x-client-id and x-client-secret information in the API request.
403ERRORIP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our IP Whitelisting guideWhitelist the IP address.
409ERRORverification ID already exists.Enter a unique verification ID to identify the request.
422ERRORInsufficient balance to process this request.Try again with sufficient balance.
500ERRORsomething went wrong.Try again after some time.
502ERRORverification attempt failed.Try again after some time.

Authorizations

ā€‹
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

ā€‹
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

ā€‹
x-cf-signature
string

Send the signature if two-factor authentication is selected as Public Key. More details

Body

application/json

Find the request parameter to retrieve your customer's passport information

ā€‹
verification_id
string
default:ABC00123
required

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

Example:

"ABC00123"

ā€‹
file_number
string
default:PA1079341954215
required

It is the unique alphanumeric code that identifies an individual's passport application.

Example:

"PA1079341954215"

ā€‹
dob
string
default:2007-03-01
required

It is the date of birth of the passport holder. The format is YYYY-MM-DD.

Example:

"2007-03-01"

ā€‹
name
string

It is the name of the passport holder.

Example:

"John Doe"

Response

Success response for retrieveing passport information

ā€‹
reference_id
integer

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

Example:

1358

ā€‹
verification_id
string

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

Example:

"ABC00123"

ā€‹
status
string

It displays the status of the passport.

Example:

"VALID"

ā€‹
file_number
string

It displays the unique alphanumeric code that identifies an individual's passport application.

Example:

"XX0000000000000"

ā€‹
name
string

It displays the name of the passport holder.

Example:

"John Doe"

ā€‹
dob
string

It displays the date of birth of the passport holder.

Example:

"YYYY-MM-DD"

ā€‹
application_type
string

It displays the type of passport application.

Example:

"NORMAL"

ā€‹
application_received_date
string

It displays when the passport application was received.

Example:

"YYYY-MM-DD"