post

/customers/{customer_id}/validate

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"
}

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Headers

Request Body

1 Example
Schema
object
password
string

String to run against customer password. Will return a true or false.

Responses

1 Example
Schema
object
success
boolean

Will return true or false

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
2 path params not set
store_hash
customer_id
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client