Skip to navigation

Request Sign-in Code

View as Markdown

Emails a 6-digit sign-in code to the address. The code expires after 10 minutes and allows 5 wrong tries. Requesting a new code cancels the previous one. The response is the same whether or not the address already has an account.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired
client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"<=255 characters
Address to send the code to.

Response

Successfully sent sign-in code

statusboolean

Always true on success.

messagestring

Human-readable outcome.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error