Skip to main content
POST
/
api
/
commerce
/
auth
/
request
Request a customer sign-in code
curl --request POST \
  --url https://app.vaultgraph.com/api/commerce/auth/request \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "data": {
    "challenge_id": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

The customer's account email address. The store delivers a one-time code to it out of band.

​
email
string<email>
required

The customer's account email address.

Response

A pending sign-in challenge

​
data
object

A pending sign-in challenge. Echo challenge_id, together with the one-time code the customer received, to the verify endpoint.