Create User for Secure ID

Use this API to create a Secure ID user profile, which is required to initiate Video KYC verification.

POST /user

Create User for Secure ID

cURL

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 '
{
  "phone": "9988776655",
  "user_id": "User0123",
  "email": "[e-mail]",
  "name": "John Doe",
  "address": "GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"
}
'

import requests

url = "https://sandbox.cashfree.com/verification/user"

payload = {
    "phone": "9988776655",
    "user_id": "User0123",
    "email": "[e-mail]",
    "name": "John Doe",
    "address": "GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE"
}
headers = {
    "x-api-version": "<x-api-version>",
    "x-client-id": "<api-key>",
    "x-client-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-version': '<x-api-version>',
    'x-client-id': '<api-key>',
    'x-client-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone: '9988776655',
    user_id: 'User0123',
    email: '[e-mail]',
    name: 'John Doe',
    address: 'GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE'
  })
};

fetch('https://sandbox.cashfree.com/verification/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.cashfree.com/verification/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '9988776655',
    'user_id' => 'User0123',
    'email' => '[e-mail]',
    'name' => 'John Doe',
    'address' => 'GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-version: <x-api-version>",
    "x-client-id: <api-key>",
    "x-client-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.cashfree.com/verification/user"

	payload := strings.NewReader("{\n  \"phone\": \"9988776655\",\n  \"user_id\": \"User0123\",\n  \"email\": \"[e-mail]\",\n  \"name\": \"John Doe\",\n  \"address\": \"GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-version", "<x-api-version>")
	req.Header.Add("x-client-id", "<api-key>")
	req.Header.Add("x-client-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("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>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"9988776655\",\n  \"user_id\": \"User0123\",\n  \"email\": \"[e-mail]\",\n  \"name\": \"John Doe\",\n  \"address\": \"GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-version"] = '<x-api-version>'
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"9988776655\",\n  \"user_id\": \"User0123\",\n  \"email\": \"[e-mail]\",\n  \"name\": \"John Doe\",\n  \"address\": \"GROUND FLOOR, 123, ABC CIRCLE, XYZ MAIN ROAD, BANGALORE\"\n}"

response = http.request(request)
puts response.read_body

200

Success

{
  "user_reference_id": 1358,
  "user_id": "User0123",
  "phone": "9988776655",
  "email": "[e-mail]",
  "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:

"[e-mail]"

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

200

application/json

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:

"[e-mail]"

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"