Validate Customer Credentials
Validate a customer credentials - This endpoint has special rate limiting protections to protect against abuse.
Authentication
X-Auth-Tokenstring
### OAuth scopes
| UI Name | Permission | Parameter |
|:--------|:-----------|:----------|
| Customers | modify | `store_v2_customers` |
| Customers | read-only | `store_v2_customers_read_only` |
| Stored Payment Instruments | modify | `store_stored_payment_instruments` |
| Stored Payment Instruments | read-only | `store_stored_payment_instruments_read_only` |
### Authentication header
| Header | Argument | Description |
|:-------|:---------|:------------|
| `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). |
### Further reading
For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests).
For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes).
For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).
Request
This endpoint expects an object.
email
Customer email address.
password
Customer password.
channel_id
ChannelId to check the customer credentials against - If this field is empty we will use channel 1.
Response
Returns if the customer credentials provided are valid or not.
customer_id
Returns the customer ID.
is_valid
indicates if the provided credentials are valid.
Errors
422
Unprocessable Entity Error
429
Too Many Requests Error
