Skip to main content
POST
/
oauth2
/
session
Initiate OAuth
curl --request POST \
  --url https://sandbox.cashfree.com/verification/oauth2/session \
  --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": {
    "identifier_type": "MOBILE",
    "identifier_value": "9988776655"
  },
  "verification_id": "test_verification_id"
}
'
{
  "reference_id": 3123123,
  "verification_id": "123456",
  "user": [
    {
      "identifier_type": "MOBILE",
      "identifier_value": "9988123456"
    }
  ],
  "expiry": "2024-12-31T23:59:59Z",
  "session_id": "session_id_value"
}
Notes:
  • The session ID generated by this API is valid for 1 hour.
  • Get the X Client ID and X Client Secret from the Merchant Dashboard when you create the app under the 1-Click section.

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

Find the request parameters to initiate Oauth

ā€‹
user
object
required

It displays the list of user identifiers.

ā€‹
verification_id
string
required

It is the unique ID you create to identify the user session. The maximum character limit is 50. Alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"test_verification_id"

Response

Initiate Oauth Response Body

ā€‹
verification_id
string

It displays the unique ID you created to identify the verification request.

Example:

"test_verification_id"

ā€‹
reference_id
integer

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

Example:

123

ā€‹
expiry
string

The expiration date and time of the session, in UTC format. Format YYYY-MM-DDTHH:mm:ssZ

Example:

"2024-12-31T23:59:59Z"

ā€‹
session_id
string

A unique identifier for the session associated with the request.

Example:

"session_id_value"

ā€‹
user
object

It displays the list of user identifiers provided in the request.