Skip to navigation

List All Relationships of a Business

Lists the beneficial owners and control persons attached to a business, oldest first. Removed relationships are included unless you filter by status. Requires the api:read scope on a partner token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

business_external_idstringRequired

The id of the business.

Query parameters

roleenumOptional
Only return relationships with this role.
Allowed values:
statusenumOptional
Only return relationships with this status.
Allowed values:
pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.

Response

countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
404
Not Found Error