POST
/
vault
/
data-availability
{
  "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-api-version
string
required

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

Body

application/json

Request for data availability of the user.

user
object[]

It displays the list of user identifiers.

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.

Response

200 - application/json

Response for user data availability.

available_scopes
object[]

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

reference_id
integer

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

user
object[]

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

verification_id
string

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