staqlydocs
REST APIAPI referenceAccounts

Send a sign-in code to an email address

Send a sign-in code to an email address

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/auth/email/start

Mails a 6-digit code (valid 10 minutes, single use, 5 tries). The answer is the same whether or not the address has an account. A new code replaces the previous one. Limits: one code per address every 30 seconds (429 code_cooldown, details.resend_in), 5 per address per hour, and a limit per client IP.

Request Body

application/json
  1. body
email*string

Response Body

Code sent

application/json
  1. response
resend_in*integer

Seconds until another code may be asked for

expires_in*integer

Seconds the code works

curl -X POST 'https://staqly.example.com/v1/auth/email/start' \  -H 'Content-Type: application/json' \  -d '{  "email": "string"}'
{  "resend_in": 0,  "expires_in": 0}