Send one-time passcode by email

POSThttps://test.stytch.com/v1/otps/email/send

Send a One-Time Passcode (OTP) to a User using their email. If you'd like to create a user and send them a passcode with one request, use our log in or create endpoint.

Add an email to an existing user

This endpoint also allows you to add a new email address to an existing Stytch User. Including a user_id, session_token, or session_jwt in your Send one-time passcode by email request will add the new, unverified email address to the existing Stytch User. If the user successfully authenticates within 5 minutes, the new email address will be marked as verified and remain permanently on the existing Stytch User. Otherwise, it will be removed from the User object, and any subsequent login requests using that email address will create a new User.

Next steps

Collect the OTP which was delivered to the user. Call Authenticate OTP using the OTP code along with the email_id found in the response as the method_id.

Body parameters

email* string
expiration_minutes int
login_template_id string
signup_template_id string
locale string
attributes object
user_id string
session_token string
session_jwt string

Response fields

status_code int
request_id string
user_id string
email_id string
curl --request POST \
  --url https://test.stytch.com/v1/otps/email/send \
  -u 'PROJECT_ID:SECRET' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "sandbox@stytch.com"
  }'

RESPONSE

200
{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "user_id": "user-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6",
  "email_id": "email-test-81bf03a8-86e1-4d95-bd44-bb3495224953"
}

Common Error Types