Skip to main content
GET
List relationships

Authorizations

Authorization
string
header
required

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

Query Parameters

id
string<uuid>[]

Unique resource identifier

from_person_id
string<uuid>[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

from_business_id
string<uuid>[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

to_business_id
string<uuid>[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

relationship_type
enum<string>[]

The relationship type, any of the following. All direct businesses customers need at least one beneficial owner or controlling person.

  • BENEFICIAL_OWNER_OF – a person who directly or indirectly owns a portion of the business.
  • MANAGING_PERSON_OF – a person who is an officer, director, or controlling person of an organization.
  • OWNER_OF – a business with ownership of another business.
Available options:
BENEFICIAL_OWNER_OF,
MANAGING_PERSON_OF,
OWNER_OF,
PAYER_PAYEE
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

Relationship representation.

relationships
(Managing Person · object | Beneficial Owner · object | Business Owner · object | Payer/Payee · object)[]
required

Array of business/person relationships.

Denotes the relationship between specified person and business.

next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"