Validate a customer credentials
POST /stores/{store_hash}/v3/customers/validate-credentials
Request
Validate a customer credentials - This endpoint has special rate limiting protections to protect against abuse.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
Body
object | application/json
emailstring
requiredCustomer email address.
passwordstring
requiredCustomer password.
channel_idinteger
ChannelId to check the customer credentials against - If this field is empty we will use channel 1.
data
{ "email": "foo@bar.com", "password": "password", "channel_id": 1 }
Response
Returns if the customer credentials provided are valid or not.
Body
object | application/json
customer_idinteger
Returns the customer ID.
is_validboolean
indicates if the provided credentials are valid.
data
{ "is_valid": true, "customer_id": 1 }