Skip to main content
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"
  ]
}
'
import requests

url = "https://sandbox.cashfree.com/verification/mobile360/otp/send"

payload = {
    "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"]
}
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({
    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']
  })
};

fetch('https://sandbox.cashfree.com/verification/mobile360/otp/send', 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/mobile360/otp/send",
  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([
    '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'
    ]
  ]),
  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/mobile360/otp/send"

	payload := strings.NewReader("{\n  \"verification_id\": \"ABC00122\",\n  \"mobile_number\": \"9999999999\",\n  \"name\": \"John Doe\",\n  \"user_consent\": {\n    \"timestamp\": \"2024-11-29T12:34:56Z\",\n    \"purpose\": \"User consent to fetch data.\",\n    \"obtained\": true,\n    \"type\": \"EXPLICIT\"\n  },\n  \"notification_modes\": [\n    \"SMS\",\n    \"WHATSAPP\"\n  ]\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/mobile360/otp/send")
  .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  \"verification_id\": \"ABC00122\",\n  \"mobile_number\": \"9999999999\",\n  \"name\": \"John Doe\",\n  \"user_consent\": {\n    \"timestamp\": \"2024-11-29T12:34:56Z\",\n    \"purpose\": \"User consent to fetch data.\",\n    \"obtained\": true,\n    \"type\": \"EXPLICIT\"\n  },\n  \"notification_modes\": [\n    \"SMS\",\n    \"WHATSAPP\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.cashfree.com/verification/mobile360/otp/send")

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  \"verification_id\": \"ABC00122\",\n  \"mobile_number\": \"9999999999\",\n  \"name\": \"John Doe\",\n  \"user_consent\": {\n    \"timestamp\": \"2024-11-29T12:34:56Z\",\n    \"purpose\": \"User consent to fetch data.\",\n    \"obtained\": true,\n    \"type\": \"EXPLICIT\"\n  },\n  \"notification_modes\": [\n    \"SMS\",\n    \"WHATSAPP\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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
ā€‹
user_consent
object
required

Consent details for Mobile360 Send OTP.

ā€‹
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