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

​
Request

POST /auth/check-user
Content-Type: application/json
x-shop-id: {shopId}
{
  "email": "[email protected]"
}

​
Headers

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

​
Body parameters

FieldTypeRequiredDescription
emailstringYesEmail address to check for existing account.

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "User check completed",
    "data": {
        "exists": true,
        "email": "[email protected]"
    }
}
You receive exists: true if the user account exists, or exists: false if no account is found.

​
Error response

{
    "status": 500,
    "success": false,
    "message": "Failed to check user. 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 to check for existing account.

Response

User check completed successfully.

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