Look up clients by ID or SSN

Required scope: clients:read.

Finds clients using exactly one of these modes:

  • ids: up to 100 client IDs.
  • full_ssns: up to 100 nine-digit SSNs.
  • last_four: an SSN last four, optionally narrowed by first_name and last_name.

For ids and full_ssns, the response has one entry per input, in the same order, with status set to found or not_found and a clients array. An SSN can match more than one client, so all matches are returned. Clients this key cannot access are reported as not_found. For last_four, the response is an ordinary paginated list of clients; pass limit and cursor in the body.

The SSN modes require clients:sensitive:read in addition to clients:read. SSNs are accepted only in the request body and are never echoed back. Sensitive fields in the results follow include_sensitive, as in List clients.

This is a read-only request, so it does not use an Idempotency-Key.

POST /api/v2/clients/lookup
Bearer token scope clients:read

Body

required application/json
value any

Responses