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

Login in using NTOP. If the user does not exist, a new user will be created with the given identifier

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<Project ID\>

Try it

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

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

providerstring

Whatsapp, IMessage, etc

loginIdstring

Optional, becasue can be retrived from the provider webhook

loginOptionsobject

providerIdstring

templatesobject

NOTP Requests & Responses

ssoAppIdstring

Path Parameters

provider
Required
string

Whatsapp, IMessage, etc

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/auth/notp/{provider}/signup-in" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <Project ID>" \
  -d '{
  "provider": "string",
  "loginId": "string",
  "loginOptions": {
    "stepup": false,
    "customClaims": {},
    "mfa": false,
    "ssoAppId": "string",
    "templateOptions": {
      "property1": "string",
      "property2": "string"
    },
    "locale": "string",
    "pkceChallenge": "string",
    "revokeOtherSessions": true
  },
  "providerId": "string",
  "templates": {
    "verifyTemplateId": "string",
    "successTemplateId": "string",
    "errorTemplateId": "string"
  },
  "ssoAppId": "string"
}'

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

Was this helpful?

Previous

Sign-In

Next

Get NoTP Pending Session