Skip to main content
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"
    }
  ]
}'
{
  "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"
    }
  ]
}

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.

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.

ā€‹
available_scopes
object[]

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