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

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired
providerstring

Whatsapp, IMessage, etc

loginIdstring

Optional, becasue can be retrived from the provider webhook

loginOptionsobject
providerIdstring
templatesobject

NOTP Requests & Responses

ssoAppIdstring

Path Parameters

providerRequiredstring

Whatsapp, IMessage, etc

curl -X POST "https://api.descope.com/v1/auth/notp/string/signin" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -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"
  }'

OK

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

Was this helpful?

Sign-Up POST

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

Sign-In with Auto Sign-Up POST

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>`