API ReferencenOTP
POST
/v1/auth/notp/{provider}/signup

Create a new user using NOTP

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID\>

Try it

/v1/auth/notp/{provider}/signup

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

providerstring

Whatsapp, IMessage, etc

phonestring

loginIdstring

userobject

providerIdstring

templatesobject

NOTP Requests & Responses

ssoAppIdstring

loginOptionsobject

Path Parameters

provider
Required
string

Whatsapp, IMessage, etc

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/notp/{provider}/signup" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Project ID>" \
  -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"
  }
}'

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

Was this helpful?

Previous

nOTP Authentication API Overview

Next

Sign-In