Sign in

v1

latestOpenAPI 3.0.02026-07-247150151.6 KB
Customers

Retrieve all customers

Retrieves all customers

get/customers

Query parameters

pageinteger

page number requested to return

per_page1 | 2 | 5 | 10 | 20 | 50

number of Customer information in response<br />per_page is one of the following:<br />1, 2, 5, 10, 20, 50

brand_person_idstring nullable
Example:ac6ee2d3-5a03-4043-a4aa-dda51836b9fd

Return customers that match the brand_person_id

Response

customer_idstring
brand_person_idstring
bond_brand_idstring
business_idstring nullable
dobstring string nullable

Birthday in YYYY-MM-DD format.

first_namestring required

First name.<br />Has a 1 to 50-character limit. Must start with an alphabet and may only contain alphabets, spaces, and apostrophes.

middle_namestring

Middle name.<br />Has a 50-character limit. Must start with an alphabet and may only contain alphabets, spaces, and apostrophes.

last_namestring

Last name.<br />Has a 2 to 50-character limit. Must start with an alphabet and may only contain alphabets, spaces, and apostrophes.

ssnstring

Redacted SSN. Format: XXX-XX-9999.

phonestring

Numbers only or dash-separated are acceptable

phone_country_codestring

Must be a string of 1-3 digits

emailstring

Must be a valid email address

date_createdstring

Example response

{
  "customer_id": "b3f7f6c9-503e-4457-b0ca-31f65131cfff",
  "brand_person_id": "ac6ee2d3-5a03-4043-a4aa-dda51836b9fd",
  "bond_brand_id": "8c7e08c8-0320-444c-b834-007cd9e18c0e",
  "business_id": "null",
  "dob": "1997-12-25",
  "first_name": "James",
  "middle_name": "Herbert",
  "last_name": "Bond",
  "ssn": "XXX-XX-9999",
  "phone": "555-111-2222",
  "phone_country_code": "1",
  "email": "james@mi6.gov.uk",
  "addresses": [
    {
      "address_id": "5ff2a5f8-2d96-4c89-9edc-ec762ac3844c",
      "street": "345 California Ave.",
      "street2": "Suite 600",
      "city": "San Francisco",
      "state": "CA",
      "zip_code": "12345-1234",
      "country": "US",
      "is_primary": true,
      "date_created": "2021-10-11T17:54:26.784367+00:00"
    }
  ],
  "date_created": "2021-06-02T13:38:27.965404+00:00"
}
All 71 operations