API DOCUMENTATION Last Update: July 2025

Customer Password Validation

Returns whether a customer's password is valid or not.

 

Headers

  Key   Value   Note
api_access_key user_api_key Optional

 

 

The data to be submitted to the API is composed of the following fields:

 

  field   Example   Note
user_id john1970 Required
user_password 1959caadac9b13dcb3 Required if not included in the headers
type validate_customer_password Required
account_id greatwidgets Required
card_number 1212121212 See Notes
code 1234567890123456 See Notes
customer_username jdoe1970 See Notes
customer_password pa$$w0rd See Notes
customer_PIN 1234 See Notes
phone 5551115555
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output

 

Notes:

  • Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.

  • Either the card_number, customer code, or customer_username is REQUIRED.
  • Either the customer_password or customer_PIN is REQUIRED
  • Use any combination of parameters. Success will only be returned if ALL passed parameters are matched. (ie. you can validate on card_number + customer_password or customer_username + customer_PIN or card_number + code + customer_PIN or on all 5 parameters.)
  • If passing the customer code, this MUST be the unique Customer ID that was either
    • passed as 'code' by your program when the customer record was created previously, or
    • the 16-digit number that was generated by us and returned to you in the API response.

 

Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'validate_customer_password';
  4. $data['account_id'] = 'greatwidgets';
  5. $data['card_number'] = '121212121212';
  6. $data['customer_password'] = 'pa$$w0rd';

 

Success XML Response (password matches the one on record):

  1. <response status="success">
  2. </response>

 

Error XML Response (password does not match the one on record):

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>