API Reference/nOTP
POST
/v1/auth/notp/{provider}/signup

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired
providerstring
phonestring
loginIdstring
userobject
providerIdstring
templatesobject

NOTP Requests & Responses

ssoAppIdstring
loginOptionsobject

Path Parameters

providerRequiredstring

Whatsapp, IMessage, etc

curl -X POST "https://api.descope.com/v1/auth/notp/string/signup" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "string",
    "phone": "string",
    "loginId": "string",
    "user": {
      "loginId": "string",
      "name": "string",
      "phone": "string",
      "email": "string",
      "givenName": "string",
      "middleName": "string",
      "familyName": "string"
    },
    "providerId": "string",
    "templates": {
      "verifyTemplateId": "string",
      "successTemplateId": "string",
      "errorTemplateId": "string"
    },
    "ssoAppId": "string",
    "loginOptions": {
      "customClaims": {},
      "templateOptions": {
        "property1": "string",
        "property2": "string"
      },
      "locale": "string",
      "pkceChallenge": "string"
    }
  }'

OK

{
  "pendingRef": "string",
  "redirectUrl": "string",
  "image": "string"
}

Was this helpful?

nOTP Authentication API Overview

Use the Descope REST API to build an authentication process that relays on nOTP and WhatsApp.

Sign-In POST

Login a user using NOTP ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <Project ID>`