SYsynctera
Accounts

Get account relationship

Changed on

Get account relationship by ID

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

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships/{relationship_id}
  • Auth
    HTTP bearer

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

legal_rolesAccountLegalRole[]

Legal roles the related party holds on the account. Reporting labels only; carry no permissions. A PRIMARY_ACCOUNT_HOLDER (or its deprecated alias ACCOUNT_HOLDER) may hold any combination; an AUTHORIZED_SIGNER may only hold ESCROW_AGENT. If a primary holder is a CUSTODIAN, the account must also have a BENEFICIARY 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' | 'GUARANTOR' | '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
}

Changes

  • a9a5c394da16Revision changes
    • info

      added the optional property / to the response with the status

  • a841410907f8Revision changes
    • warning

      added the new GUARANTOR enum value to the / response property for the response status