Cashfree Payments Developer Documentation

Mobile 360 Send OTP Request

curl --request POST \
  --url https://sandbox.cashfree.com/verification/mobile360/otp/send \
  --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 '
{
  "verification_id": "ABC00122",
  "mobile_number": "9999999999",
  "name": "John Doe",
  "user_consent": {
    "timestamp": "2024-11-29T12:34:56Z",
    "purpose": "User consent to fetch data.",
    "obtained": true,
    "type": "EXPLICIT"
  },
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ]
}
'

{
  "verification_id": "ABC00122",
  "mobile_number": "9999999999",
  "status": "OTP_GENERATED",
  "reference_id": 123454,
  "name": "John Doe",
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ]
}

POST

mobile360

otp

send

Mobile 360 Send OTP Request

curl --request POST \
  --url https://sandbox.cashfree.com/verification/mobile360/otp/send \
  --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 '
{
  "verification_id": "ABC00122",
  "mobile_number": "9999999999",
  "name": "John Doe",
  "user_consent": {
    "timestamp": "2024-11-29T12:34:56Z",
    "purpose": "User consent to fetch data.",
    "obtained": true,
    "type": "EXPLICIT"
  },
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ]
}
'

{
  "verification_id": "ABC00122",
  "mobile_number": "9999999999",
  "status": "OTP_GENERATED",
  "reference_id": 123454,
  "name": "John Doe",
  "notification_modes": [
    "SMS",
    "WHATSAPP"
  ]
}

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

Find the request parameters to send the OTP to the mobile number

verification_id

string

default:test_verification_id

required

It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphaumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.

Example:

"test_verification_id"

mobile_number

string

default:9999999999

required

It is the 10 digit mobile number of individual.

Example:

"9999999999"

notification_modes

string[]

required

Modes for sending OTP Possible values are

SMS
WHATSAPP

Consent details for Mobile360 Send OTP.

Show child attributes

Indicates whether the user has given consent.

Example:

true

It displays the type of user consent provided. Possible values are:

EXPLICIT: Consent is clearly given by the user to collect and process personal data.
IMPLICIT: Consent is implied through the user's actions.
OPT-OUT: Consent is assumed by default, but the user can revoke it later
BROAD: Consent is granted for future, undefined purposes.

Example:

"EXPLICIT"

Timestamp when the consent was provided. The value must be in UTC and must be within 5 minutes before or after the current time.

Example:

"2024-11-29T12:34:56Z"

The description of the consent. The length must be between 20 and 100 characters. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).

Required string length: 20 - 100

Example:

"Fetching data of customer XYZ for verification purposes"

Show child attributes

IP address of the user. Must be a valid IP.

Example:

"192.168.1.1"

Origin of the IP. Allowed values are HOME, OFFICE, and OTHERS.

Available options:

HOME,

OFFICE,

OTHERS

Example:

"HOME"

Name of the Internet service provider. The maximum character limit is 100. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).

Maximum string length: 100

Example:

"ISP Provider Name"

Show child attributes

It is the unique identifier for the user's device. The maximum character limit is 100. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).

Maximum string length: 100

Example:

"12345-ABCDE"

The operating system of the user's device. The maximum character limit is 50. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).

Maximum string length: 50

Example:

"WINDOWS"

The model of the user's device. The maximum character limit is 100. Allowed characters are alphanumeric, period (.), hyphen (-), slash (/), ampersand (&), and underscore (_).

Maximum string length: 100

Example:

"SAMSUNG GALAXY S21"

name

string

default:John Doe

Name of the individual, a correct name can increase the success rate of data retrieval.

Example:

"John Doe"

Response

Response for Mobile360 Send OTP

verification_id

string

Unique ID of the verification request.

Example:

"ABC00122"

mobile_number

string

Mobile number of the individual.

Example:

"9999999999"

status

string

It displays the status of the API request. Possible values are

OTP_GENERATED: The OTP has been successfully generated.

Example:

"OTP_GENERATED"

reference_id

integer

Reference ID for the transaction.

Example:

123454

name

string

Name of the individual.

Example:

"John Doe"

notification_modes

string[]

Modes for sending OTP Possible values are

SMS
WHATSAPP

Fetch User Details From Access Token Mobile 360 Verify OTP

⌘I

Secure ID APIs

V2

V1 (Depricated API's)

Mobile 360 Send OTP Request

Authorizations

Headers

Body

Response