Update Phone (IM) | API Reference | Descope Documentation

Authorization

Descope Project ID:Refresh JWT

AuthorizationBearer <token>

Project ID:Refresh JWT as bearer token.

In: header

application/json

loginId?string

phone?string

addToLoginIDs?boolean

Defaultfalse

onMergeUseExisting?boolean

Defaultfalse

providerId?string

templateOptions?object

locale?string

failOnConflict?boolean

Update phone, and verify via OTP based on an instant message

curl -X POST "https://api.descope.com/v1/auth/otp/update/phone/im" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/auth/otp/update/phone/im" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

{
  "maskedPhone": "string",
  "verificationAttempts": 0
}

{  "maskedPhone": "string",  "verificationAttempts": 0}

TypeScript

export interface Response {
maskedPhone?: string
verificationAttempts?: number
}

export interface Response {maskedPhone?: stringverificationAttempts?: number}

Was this helpful?