Get KYC Link Status

Use this API to get the status of the KYC link by passing verification_id or reference_id to get the KYC Link status.

GET /form

Get KYC Link Status

cURL

curl --request GET \
  --url https://sandbox.cashfree.com/verification/form \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'

import requests

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

headers = {
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};

fetch('https://sandbox.cashfree.com/verification/form', 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/form",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.cashfree.com/verification/form")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'

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

200

Example

{ "name": "John Doe", "phone": 9999999999, "email": "[e-mail]", "verification_id": "testverificationid", "reference_id": 235461, "link_expiry": "2025-12-02", "form_link": "https://forms.cashfree.com/", "form_status": "PENDING", "verification_details": [ { "reference_id": 234, "type": "OFFLINE_AADHAAR_VERIFICATION", "status": "SUCCESS" } ] }

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.

Query Parameters

verificationID · string · default: ABC00123

It is the unique ID you created to identify the KYC link.

Example:

"ABC00123"

referenceID · string · default: 235461

It is the unique ID you receive in the response of Generate KYC Link API.

Example:

"235461"

Response

200

application/json

Response Body of VRS GetFormStatus API.

name · string

It displays the name of the individual.

Example:

"John Doe"

phone · string

It displays the phone number of the individual.

Example:

9999999999

email · string

It displays the email address of the individual.

Example:

"[e-mail]"

verification_id · string

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

Example:

"testverificationid"

reference_id · integer

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

Example:

235461

link_expiry · string

It displays the expiry date of the link.

Example:

"2025-12-02"

form_link · string

It displays the URL of the form.

Example:

"https://forms.cashfree.com/"

form_status · string

It displays the status of the form.

Example:

"PENDING"

verification_details · object[]

Option 1

Option 2

Option 3

Option 4

Show child attributes