POST
/
user
/
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

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

​
x-api-version
string
required

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

Body

application/json
Find the request parameters to retrieve the information of a user data availability

Request for data availability of the user.

​
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

200
application/json
Response for user data availability request

Response for user data availability.

​
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

Was this page helpful?