GET
/
user
Get User Detail
curl --request GET \
  --url https://sandbox.cashfree.com/verification/user \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "user_reference_id": 1358,
  "user_id": "User0123",
  "phone": "9988776655",
  "email": "johndoe@gmail.com",
  "name": "John doe",
  "address": "GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"
}

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 IP is not whitelisted.

​
x-api-version
string
required

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

Query Parameters

​
user_reference_id
string
default:1358

This is the unique ID generated by Cashfree Payments and returned in the response of the Add User API.

​
user_id
string
default:ABC00123

This is the unique ID you created to identify the user.

Response

200
application/json

Success response for creating a user profile for Video KYC.

The response is of type object.