Data Scopes Check | Cashfree Payments

Data Availability

curl --request POST \
  --url https://sandbox.cashfree.com/verification/user/data-availability \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ]
}
'

import requests

url = "https://sandbox.cashfree.com/verification/user/data-availability"

payload = {
    "verification_id": "123456",
    "user": [
        {
            "identifier_type": "MOBILE",
            "identifier_value": "9988123456"
        }
    ]
}
headers = {
    "x-api-version": "<x-api-version>",
    "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-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    verification_id: '123456',
    user: [{identifier_type: 'MOBILE', identifier_value: '9988123456'}]
  })
};

fetch('https://sandbox.cashfree.com/verification/user/data-availability', 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/user/data-availability",
  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' => '123456',
    'user' => [
        [
                'identifier_type' => 'MOBILE',
                'identifier_value' => '9988123456'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "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/user/data-availability"

	payload := strings.NewReader("{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-version", "<x-api-version>")
	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/user/data-availability")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/user/data-availability")

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

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}"

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

{
  "reference_id": 3123123,
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ],
  "available_scopes": [
    {
      "scope": "AADHAAR"
    },
    {
      "scope": "PAN"
    },
    {
      "scope": "DOB"
    },
    {
      "scope": "EMAIL"
    },
    {
      "scope": "GENDER"
    },
    {
      "scope": "MOBILE"
    },
    {
      "scope": "NAME"
    },
    {
      "scope": "OCCUPATION"
    },
    {
      "scope": "ADDRESS"
    },
    {
      "scope": "INCOME"
    },
    {
      "scope": "BANK_ACCOUNT"
    }
  ]
}

POST

user

data-availability

Data Availability

curl --request POST \
  --url https://sandbox.cashfree.com/verification/user/data-availability \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ]
}
'

import requests

url = "https://sandbox.cashfree.com/verification/user/data-availability"

payload = {
    "verification_id": "123456",
    "user": [
        {
            "identifier_type": "MOBILE",
            "identifier_value": "9988123456"
        }
    ]
}
headers = {
    "x-api-version": "<x-api-version>",
    "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-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    verification_id: '123456',
    user: [{identifier_type: 'MOBILE', identifier_value: '9988123456'}]
  })
};

fetch('https://sandbox.cashfree.com/verification/user/data-availability', 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/user/data-availability",
  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' => '123456',
    'user' => [
        [
                'identifier_type' => 'MOBILE',
                'identifier_value' => '9988123456'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "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/user/data-availability"

	payload := strings.NewReader("{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}")

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

	req.Header.Add("x-api-version", "<x-api-version>")
	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/user/data-availability")
  .header("x-api-version", "<x-api-version>")
  .header("x-client-id", "<api-key>")
  .header("x-client-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/user/data-availability")

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

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"verification_id\": \"123456\",\n  \"user\": [\n    {\n      \"identifier_type\": \"MOBILE\",\n      \"identifier_value\": \"9988123456\"\n    }\n  ]\n}"

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

{
  "reference_id": 3123123,
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ],
  "available_scopes": [
    {
      "scope": "AADHAAR"
    },
    {
      "scope": "PAN"
    },
    {
      "scope": "DOB"
    },
    {
      "scope": "EMAIL"
    },
    {
      "scope": "GENDER"
    },
    {
      "scope": "MOBILE"
    },
    {
      "scope": "NAME"
    },
    {
      "scope": "OCCUPATION"
    },
    {
      "scope": "ADDRESS"
    },
    {
      "scope": "INCOME"
    },
    {
      "scope": "BANK_ACCOUNT"
    }
  ]
}

The available_scopes values returned in the response have a validity period of 1 hour. Ensure that user consent is obtained and submitted within this timeframe. After expiration, you must make a new API call to retrieve updated scopes.

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.

x-api-version

string

default:2024-12-01

required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2024-12-01"

Body

application/json

Find the request parameters to retrieve the information of a user data availability.

verification_id

string

It is the unique ID you create to identify the user session. The maximum character limit is 50. Alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

user

object[]

It displays the list of user identifiers.

Show child attributes

Response

Response for user data availability request.

reference_id

integer

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

Example:

123456

verification_id

string

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

Example:

"testVerificationId"

user

object[]

It displays the list of user identifiers provided in the request.

Show child attributes

available_scopes

object[]

It displays the list of available scopes. Possible values are: AADHAAR PAN DOB EMAIL GENDER MOBILE NAME OCCUPATION ADDRESS.

Show child attributes

Integration Overview Initiate OAuth

⌘I

Secure ID APIs

V2

V1 (Depricated API's)

Data Availability

Authorizations

Headers

Body

Response