Verify Passport
Use this API to verify passport information and ensure the identity of your customer. Provide the passport file number in the request and we help you fetch the details. View the test data and use the information to trigger the validations. The test data are usable only in the test environments such as gamma and sandbox.
Response Codes
| Sub Code | Status | Message | Next Action |
|---|---|---|---|
| 200 | SUCCESS | VALID | - |
| 200 | SUCCESS | INVALID | Enter the correct information in the request. |
| 400 | ERROR | verification_id is missing in the request. | Enter a valid verification_id in the request. |
| 400 | ERROR | verification_id can include only alphanum, dot, hyphen, and underscores. | Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed. |
| 400 | ERROR | file_number is missing in the request. | Enter the file number in the request. |
| 400 | ERROR | dob is missing in the request. | Enter the date of birth of the passport holder in the request. |
| 400 | ERROR | dob should be of type YYYY-MM-DD. | Enter the DOB in the YYYY-MM-DD format |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 400 | ERROR | x-client-id is missing in the request. | Enter all the header information in the API 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. |
| 409 | ERROR | verification id already exists | Enter a unique verification ID to identify the request. |
| 422 | ERROR | Insufficient balance to process this request | Try again with sufficient balance. |
| 500 | ERROR | something went wrong | Try again after some time. |
| 502 | ERROR | verification attempt failed | Try again after some time. |
Authorizations
Client ID. You can find your ID in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
Send the signature if IP is not whitelisted
Body
Find the request parameters to verify passport information
It is the date of birth of the passport holder. The format is YYYY-MM-DD.
It is the unique alphanumeric code that identifies an individual's passport application.
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.
It is the name of the passport holder.
Response
Success response for Verify Passport
It displays when the passport application was received.
It displays the type of passport application.
It displays the date of birth of the passport holder.
It displays the unique alphanumeric code that identifies an individual's passport application.
It displays the name of the passport holder.
It displays the unique ID created by Cashfree Payments for reference purposes.
format: int64
It displays the status of the passport.
It displays the unique ID you created to identify the verification request.
Was this page helpful?