Skip to main content
POST
Create User for Secure ID Suite

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.

Body

application/json

Request payload for creating a user for Video KYC.

phone
string
required

It is 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

It displays the email address of the user.

Example:

"johndoe@gmail.com"

name
string

It is the name of the user.

Example:

"John Doe"

address
string

It is the 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.

Example:

"User0123"

user_reference_id
integer

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

Example:

1358

phone
string

It is the phone number of the user.

Example:

"9988776655"

email
string

It displays the email address of the user.

Example:

"johndoe@gmail.com"

name
string

It is the name of the user.

Example:

"John Doe"

address
string

It is the address of the user.

Example:

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