Sign in

v1

latestOpenAPI 3.1.02026-07-26261466.6 KB
Connect

Send a code

Sends a one-time code to the user by email or phone. Provide exactly one of email or phone. Codes are valid for 10 minutes.

If you've designed a connect email in your dashboard, we send that branded email; otherwise we send a default one.

post/api/v2/connect/start

Request body

emailstring email

The user's email address. Provide this or phone, not both.

phonestring

The user's phone number in E.164 format (e.g. +15551234567). Provide this or email, not both.

external_user_idstring

Optional. Your own identifier for the user, stored on the attempt for your reference.

Response

The attempt. Pass its id back as connect_id when you verify.

object'connect_attempt'
idstring

The attempt id. Pass it back as connect_id when you verify.

channel'email' | 'phone'

The channel the code was sent on.

expires_atstring date-time

When the attempt expires (ISO 8601). Codes are valid for 10 minutes.