Skip to main content
POST
/
passport-profile
/
v1
/
phone-otp
Send phone OTP code for user supplied phone number
curl --request POST \
  --url https://api.sandbox.immutable.com/passport-profile/v1/phone-otp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "+61412345678",
  "channel": "sms"
}
'
{
  "phone_number": "+61412345678"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Phone number OTP request

​
phone_number
string
required

Phone number

Required string length: 3 - 50
Example:

"+61412345678"

​
channel
enum<string>
Available options:
sms,
whatsapp
Example:

"sms"

Response

OK

Phone number OTP request

​
phone_number
string
required

Phone number

Required string length: 3 - 50
Example:

"+61412345678"