API Reference/One-Time Password (OTP)/Voice Message (Phone)
POST
/v1/auth/otp/update/phone/voice

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired
loginIdstring
phonestring
addToLoginIDsboolean
Default: false
onMergeUseExistingboolean
Default: false
providerIdstring
templateOptionsobject
localestring
curl -X POST "https://api.descope.com/v1/auth/otp/update/phone/voice" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "string",
    "phone": "string",
    "addToLoginIDs": false,
    "onMergeUseExisting": false,
    "providerId": "string",
    "templateOptions": {
      "property1": "string",
      "property2": "string"
    },
    "locale": "string"
  }'

OK

{
  "maskedPhone": "string"
}

Was this helpful?

Verify OTP Code POST

### Verify the validity of an OTP code via Voice Verify that the OTP code entered by the end user matches the OTP code that was sent. The Verify OTP code endpoint completes the OTP via Voice flow for: - [Sign-Up](/api/otp/phone/sign-up) - [Sign-In](/api/otp/phone/sign-in) - [Sign-In with Auto Sign-up](/api/otp/phone/sign-in-auto-sign-up) - [Update Phone](/api/otp/phone/update-phone) The response object includes the session JWT `sessionJwt` and refresh JWT `refreshJwt` when it completes successfully, and the end user will be signed in. For an update phone number flow, the new phone number will replace the original phone number. ### See Also - See [The User Object](/api/overview#the-user-object) for further details on how to identify users and their contact information such as email address and phone number. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <Project ID>`

Magic Link Authentication API Overview

Use the Descope REST API to build magic link authentication for your application.