Skip to main content
POST
/
auth
/
authenticate
Authenticate shopper
curl --request POST \
  --url https://store.salesive.com/api/v1/auth/authenticate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-shop-id: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "name": "<string>",
  "phone": "<string>"
}
'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "email": "[email protected]"
  }
}

​
Request

POST /auth/authenticate
Content-Type: application/json
x-shop-id: {shopId}
{
  "name": "John Doe",
  "email": "[email protected]",
  "phone": "+2348012345678"
}

​
Headers

HeaderTypeDescription
Content-TypestringAlways set to application/json.
x-shop-idstringShop identifier to associate the user with your store.

​
Body parameters

FieldTypeRequiredDescription
emailstringYesEmail address that receives the verification code.
namestringNoShopper’s full name. If not provided, defaults to email prefix.
phonestringNoShopper’s phone number in international format.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Please check your email for verification code.",
    "data": {
        "email": "[email protected]"
    }
}
You receive success: true, confirming the verification code is on its way to the shopper’s inbox.

​
Error response

{
    "status": 500,
    "success": false,
    "message": "Failed to process registration. Please try again.",
    "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

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