Get all Customers
Get all customers for a particular partner. The partner ID does not need to be provided as it is provided by the API Key.
An optional search_term can be provided to filter by name, id, email, or external id.
Authorizations
API Key
Headers
Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner
Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.
Query Parameters
Paging: the cursor field from previous page
Paging: the cursor field for backward pagination
Paging: the requested page size (max 100)
x <= 100A search term to filter the customers
256Filter by customer status (comma-separated or repeated values)
The status of the Customer
UserRequired, SigningsRequired, IdentificationRequired, Active, Suspended, Archived Filter by the customer's most-recent identification status
The Process status of the identification
The various state transitions an identification can go through.
Pending, Processed, PendingReview, Approved, Declined, Expired, Archived Filter by customer type (Person or Business)
CustomerType
Customers can either be a commercial business or a natural person
Business, Person When true, only customers with at least one transaction; when false, only customers without any. Omit to disable the filter.
Sort order: "asc" for oldest first, "desc" for newest first (default)
asc, desc 
