Skip to main content
POST
Authenticate shopper

Request

Headers

Body parameters

Successful response

You receive success: true, confirming the verification code is on its way to the shopper’s inbox.
The verification code emailed to the shopper is a 6-digit number. Submit it to Verify OTP to complete sign-in.

Error response

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Body

application/json
email
string<email>
required

Email address that receives the verification code.

name
string

Shopper's full name. If not provided, defaults to email prefix.

phone
string

Shopper's phone number in international format.

Response

Verification code dispatched to the shopper's email.

status
integer
required
success
boolean
required
message
string
required
data
object
required