Skip to main content
POST
Send a code

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Body

application/json
email
string<email>

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

phone
string

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

external_user_id
string

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

Maximum string length: 255

Response

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

object
enum<string>
Available options:
connect_attempt
id
string

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

channel
enum<string>

The channel the code was sent on.

Available options:
email,
phone
expires_at
string<date-time>

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