Skip to main content
GET
List ultimate payors

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Query Parameters

limit
integer
default:10

How many payors to return. Between 1 and 100, and 10 when you omit it.

A value outside that range is rejected with a 400.

Required range: 1 <= x <= 100
offset
integer
default:0

How many payors to skip before the first row returned. Use it with limit to walk the list: offset=0, then offset=10, and so on. 0 when you omit it.

Required range: x >= 0
sub_client_id
string<uuid>

Return only the payors of this sub-client.

A sub-client that is not yours returns an empty list, not an error.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

status
enum<string>

Return only the payors whose screening has this status — see Values.

Available options:
created,
verifying,
verified,
failed,
rejected

Return only the payors whose legal name contains this text, in any case.

Maximum string length: 100

Response

A page of your payors.

data
object[]

The payors on this page, newest first.

pagination
object