Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Accounts

Get account relationship

Get account relationship by ID

get/accounts/{account_id}/relationships/{relationship_id}

Path parameters

relationship_idstring uuid required
Example:1a582c51-e4ff-4e57-9558-08cab6b963aa

Relationship ID of the account associate with the account entity

account_idstring uuid required
Example:57826c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for the account.

Response

Account relationship

account_idstring uuid

Account ID

business_idstring uuid

Business associated with the current account. One of business_id or customer_id must be specified.

created_atstring date-time

Date and time when this association was created.

customer_idstring uuid

Personal customer associated with the current account. One of customer_id or business_id must be specified.

deleted_atstring date-time

Date and time when this association was deleted.

idstring uuid

ID of account relationship

ownership_percentagenumber double

The ownership percentage of the related party.

person_idstring uuid

Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead.

relationship_type'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER' required

Relationship type

updated_atstring date-time

Date and time when this association was last updated.

Example response

{
  "ownership_percentage": 35.75
}