API Reference/One-Time Password (OTP)/Email
POST
/v1/auth/otp/signup/email

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired
emailstring
loginIdstring
userobject
providerIdstring
loginOptionsobject
curl -X POST "https://api.descope.com/v1/auth/otp/signup/email" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "loginId": "string",
    "user": {
      "username": "string",
      "name": "string",
      "phone": "string",
      "icon": "string"
    },
    "providerId": "string",
    "loginOptions": {
      "customClaims": {},
      "templateOptions": {
        "property1": "string",
        "property2": "string"
      },
      "locale": "string",
      "pkceChallenge": "string"
    }
  }'

OK

{
  "maskedEmail": "string"
}

Was this helpful?

OTP Authentication API Overview

Use the Descope REST API to build one-time password (OTP) authentication for your application.

Sign-In POST

### Sign-in existing end user by sending an OTP code via email Initiate a sign-in process by sending a One-Time Password (OTP) to an existing end user. Descope will generate and deliver the OTP code to the email address specified. Sending multiple OTP codes (for example, when an end user tries to sign-in a second or third time) will invalidate any OTP code that has already been sent. This endpoint will return an empty response object when it completes successfully. The endpoint will return a failure code if the email address is not yet registered. ### Next Steps Verify the OTP code using the [Verify OTP Code](/api/otp/email/verify-otp) endpoint to complete the user sign-in process. After successfully verifying the code the end user will be signed-in. ### 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. - See [User Login Options](/api/overview#user-login-options) for further details on loginOptions. - Use the [Sign-Up](/api/otp/email/sign-up) endpoint to sign-up a new end user. - Use the [Sign-In with Auto Sign-up](/api/otp/email/sign-in-auto-sign-up) endpoint to create a single sign-up and sign-in flow, which will create a new end user if they are not already registered. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <Project ID>`