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"
}
'

import requests

url = "https://sandbox.cashfree.com/verification/passport"

payload = {
    "verification_id": "ABC00123",
    "name": "John Doe",
    "file_number": "PA1079341954215",
    "dob": "2007-03-01"
}
headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    verification_id: 'ABC00123',
    name: 'John Doe',
    file_number: 'PA1079341954215',
    dob: '2007-03-01'
  })
};

fetch('https://sandbox.cashfree.com/verification/passport', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/verification/passport",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'verification_id' => 'ABC00123',
    'name' => 'John Doe',
    'file_number' => 'PA1079341954215',
    'dob' => '2007-03-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/verification/passport"

	payload := strings.NewReader("{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/passport")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/passport")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

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.

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"
}
'

import requests

url = "https://sandbox.cashfree.com/verification/passport"

payload = {
    "verification_id": "ABC00123",
    "name": "John Doe",
    "file_number": "PA1079341954215",
    "dob": "2007-03-01"
}
headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    verification_id: 'ABC00123',
    name: 'John Doe',
    file_number: 'PA1079341954215',
    dob: '2007-03-01'
  })
};

fetch('https://sandbox.cashfree.com/verification/passport', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/verification/passport",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'verification_id' => 'ABC00123',
    'name' => 'John Doe',
    'file_number' => 'PA1079341954215',
    'dob' => '2007-03-01'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/verification/passport"

	payload := strings.NewReader("{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/passport")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/passport")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"verification_id\": \"ABC00123\",\n  \"name\": \"John Doe\",\n  \"file_number\": \"PA1079341954215\",\n  \"dob\": \"2007-03-01\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

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.

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"