Docs
Management API
Validate Credentials

Customers V3

Validate a customer credentials

POST /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
  • email
    string
    required

    Customer email address.

  • password
    string
    required

    Customer password.

  • channel_id
    integer

    ChannelId to check the customer credentials against - If this field is empty we will use channel 1.

data

Response

Returns if the customer credentials provided are valid or not.

Body

object | application/json
  • customer_id
    integer or null

    Returns the customer ID.

  • is_valid
    boolean

    indicates if the provided credentials are valid.

data

Did you find what you were looking for?