Skip to main content

List business profiles

GET/partner/v1/business-profiles
Auth Bearer tokenScope partner.read

Lists your business customers, newest first by createdDateUtc. There are no filter or sort parameters.

Query​

pageintegerquerydefault: 1

Values below 1 are treated as 1. A page past the last one returns an empty items.

pageSizeintegerquerydefault: 20

Clamped to 1 to 100.

Response​

itemsobject[]

One summary per customer.

Show propertiesHide properties
customerIduuid
partnerCustomerIdstring
companyNamestring
incorporationCountryIso3Codestring
ISO 3166-1 alpha-3.
currentStagestring
verificationStatusstring
createdDateUtcdate-time
pageinteger
The page returned, after page is adjusted.
pageSizeinteger
The page size used, after clamping.
totalCountinteger
All your customers, across every page.

Errors​

Only the common errors. A page or pageSize that is not an integer is 400 Request.Invalid.