Customer Passwords
Validate a Password
POST https://api.bigcommerce.com/stores/{store_hash}/v2/customers/{customer_id}/validate⚠️
This endpoint is deprecated.
Request
This endpoint has special rate limiting protections to protect against abuse.
Provided a password, will return a true/false response indicating if the provided password matches the customer’s current password. This endpoint is useful if you want to power the login of another system using BigCommerce’s stored customer accounts, or as a safe way to migrate passwords to another system (by checking them against BigCommerce’s password, and if correct, storing it in another system securely.) If the password matches what’s stored against the customer account, the response will be:
{
"success": "true"
}
If the password does NOT match, the response will instead be:
{
"success": "false"
}
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- customer_id in path - integerrequiredUnique numeric ID of the customer.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
passwordstring
String to run against customer password. Will return a true or false.
example
Response
Body
object | application/json
successboolean
Will returntrue
orfalse
.
example
Did you find what you were looking for?