Skip to main content
POST
/
otp
/
code
/
request
OTP Code - Request and Send Code
curl --request POST \
  --url https://api.crunchz.app/api/otp/code/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "[email protected]",
  "length": 4,
  "useLetter": false,
  "useNumber": true,
  "allCapital": false,
  "name": "Your Company Name",
  "expires": 1800
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
contact_id
string
required

Contact ID .

Example:

"[email protected]"

​
length
number
required

Length OTP Code.

Required range: x <= 6
Example:

4

​
useLetter
boolean
required

Using letter for Otp Code.

Example:

false

​
useNumber
boolean
required

Using number for Otp Code.

Example:

true

​
allCapital
boolean
required

Using uppercase for Otp Code.

Example:

false

​
name
string
required

Application Name.

Example:

"Your Company Name"

​
expires
number
required

Expire time in second ( e.g 30 Minute )

Example:

1800

Response

  • Option 1
  • OtpCodeResource

The response is of type object.