Skip to main content
GET
/
oauth2
/
user-details
Fetch User Details From Access Token
curl --request GET \
  --url https://sandbox.cashfree.com/verification/oauth2/user-details \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-version: <x-api-version>'
{
  "reference_id": 123456,
  "verification_id": "test_verification_id",
  "scopes": [
    {
      "scope": "MOBILE",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "mobile": "9988123456"
          }
        }
      ]
    },
    {
      "scope": "EMAIL",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "email": "example@example.com"
          }
        }
      ]
    },
    {
      "scope": "ADDRESS",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "complete_address": "123 Main St, Bangalore",
            "state": "KARNATAKA",
            "type": "Permanent",
            "pincode": "123456"
          }
        }
      ]
    },
    {
      "scope": "GENDER",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "gender": "MALE"
          }
        }
      ]
    },
    {
      "scope": "DOB",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "dob": "1990-01-01"
          }
        }
      ]
    },
    {
      "scope": "AADHAAR",
      "records": [
        {
          "confidence_score": 0.85,
          "metadata": {
            "aadhaar": "xxxxxxxx9012",
            "care_of": "S/O: Fakkirappa Dollin",
            "address": "Shri Kanaka Nilaya,,Umashankar Nagar 1st Main 5th Cross,Ranebennur,Haveri-Karnataka,India",
            "dob": "02-02-1995",
            "email": "example@example.com",
            "gender": "M",
            "name": "Mallesh Fakkirappa Dollin",
            "split_address": {
              "country": "India",
              "dist": "Haveri",
              "house": "Shri Kanaka Nilaya",
              "landmark": "Shell petrol pump",
              "pincode": "123456",
              "po": "Ranebennur",
              "state": "Karnataka",
              "street": "Umashankar Nagar 1st Main 5th Cross",
              "subdist": "Ranibennur",
              "vtc": "Ranibennur"
            },
            "year_of_birth": "1995",
            "mobile_hash": "abc123hash",
            "photo_link": "<base64 encoded image>"
          }
        }
      ]
    },
    {
      "scope": "PAN",
      "records": [
        {
          "confidence_score": 0.85,
          "metadata": {
            "pan": "ABCDE1234F",
            "type": "Individual",
            "registered_name": "John Doe",
            "aadhaar_seeding_status": "Y",
            "last_updated_at": "2023-09-01",
            "name_pan_card": "John Doe",
            "aadhaar_seeding_status_desc": "Aadhaar is linked to PAN"
          }
        }
      ]
    },
    {
      "scope": "BANK_ACCOUNT",
      "records": [
        {
          "confidence_score": 0.85,
          "metadata": {
            "bank_account": "1234567890",
            "name_at_bank": "John Doe",
            "bank_name": "YES BANK",
            "city": "BANGALORE",
            "branch": "BANGALORE",
            "micr": "123456789"
          }
        }
      ]
    },
    {
      "scope": "NAME",
      "records": [
        {
          "confidence_score": 0.85,
          "metadata": {
            "name": "John Doe"
          }
        }
      ]
    },
    {
      "scope": "OCCUPATION",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "occupation": "Salaried"
          }
        }
      ]
    },
    {
      "scope": "INCOME",
      "records": [
        {
          "confidence_score": null,
          "metadata": {
            "income": "BELOW_ONE_LAKH"
          }
        }
      ]
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ā€‹
x-api-version
string
default:2024-12-01
required

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

Example:

"2024-12-01"

Response

Fetch User Details from access token Response Body

ā€‹
reference_id
string

A unique ID created by Cashfree Payments for reference purposes.

Example:

"ref123"

ā€‹
verification_id
string

It is the unique ID you create to identify the verification request.

Example:

"verif123"

ā€‹
scopes
object[]

A list of scopes associated with the verification, each representing a specific type of user data that can be accessed.