Skip to main content
POST
/
otp
/
link
/
request
cURL
curl --request POST \
  --url https://api.crunchz.app/api/otp/link/request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "[email protected]",
  "expires": 1800,
  "name": "Your Company Name",
  "message": {
    "prompt": "Give me link to login at TARGET App",
    "success": "Here is your login link bit.ly/any",
    "failed": "Login failed, please try again later.",
    "expired": "The link has been expired, please try another one."
  },
  "callback": {
    "success": "https://domain.com/callback/success",
    "failed": "https://domain.com/callback/failed"
  }
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "code": "<string>",
    "contact_id": "<string>",
    "link": "<string>",
    "app_uri": "<string>",
    "expired_at": "<string>",
    "timestamp": "<string>"
  }
}

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

​
expires
number
required

Expire time in second ( e.g 30 Minute )

Example:

1800

​
name
string | null

Application Name.

Example:

"Your Company Name"

​
message
object
​
callback
object

Response

OtpLinkResource

​
success
boolean
required

The success status of response.

​
message
string
required

The message of response.

​
data
object
required