Skip to main content
POST
/
user
Create User for Secure ID
curl --request POST \
  --url https://sandbox.cashfree.com/verification/user \
  --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 '{
  "user_id": "User0123",
  "phone": "9988776655",
  "email": "johndoe@gmail.com",
  "name": "John Doe",
  "address": "GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"
}'
{
  "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 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

Request payload for creating a user for Video KYC.

ā€‹
phone
string
required

The phone number of the user.

Example:

"9988776655"

ā€‹
user_id
string

It is the unique ID you create to identify the user. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed. Auto-generated if not passed.

Example:

"User0123"

ā€‹
email
string

The email address of the user.

Example:

"johndoe@gmail.com"

ā€‹
name
string

The name of the user.

Example:

"John Doe"

ā€‹
address
string

The address address of the user.

Example:

"GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"

Response

Success response for creating a user profile for Video KYC.

ā€‹
user_id
string

It is the unique ID you create to identify the user, or it is auto-generated by Cashfree if not provided in request.

Example:

"User0123"

ā€‹
user_reference_id
integer

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

Example:

1358

ā€‹
phone
string

The phone number of the user.

Example:

"9988776655"

ā€‹
email
string

The email address of the user.

Example:

"johndoe@gmail.com"

ā€‹
name
string

The name of the user.

Example:

"John Doe"

ā€‹
address
string

The address of the user.

Example:

"GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"