Relationships
List relationships
Retrieves paginated list of relationships viewable by the authorized requester.
get/relationships
Query parameters
to_business_idstring[]
Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.
from_person_idstring[]
Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.
relationship_typestring[]
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.
[ "BENEFICIAL_OWNER_OF" ]
from_business_idstring[]
Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.
page_tokenstring
Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
Example:a8937a0d
idstring[]
Unique resource identifier
[ "7d943c51-e4ff-4e57-9558-08cab6b963c7" ]
limitinteger
Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
Example:100
Response
Relationship representation.
Example response
{
"relationships": [
{
"additional_data": {
"percent_ownership": 35.75
},
"creation_time": "2010-05-06T12:23:34.321Z",
"from_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"relationship_type": "BENEFICIAL_OWNER_OF",
"tenant": "abcdef_ghijkl",
"to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}
],
"next_page_token": "a8937a0d"
}