Skip to main content
POST
Search for customers

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Body

application/json
partner_customer_id
string

The unique identifier for the customer in the partner's system

ssn
string

The ssn of the customer without hyphens

Example:

"123456789"

date_of_birth
object

Customer's date of birth

limit
integer<int32>
default:10

Limits the number of returned results

Required range: x >= 1
starting_after
string

A cursor for use in pagination. An id that defines your place in the list.

Response

200 - application/json

List of customers

data
object[]
has_more
boolean
total
integer