v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

Accounts

Create account relationship

Add a customer to an account

post/accounts/{account_id}/relationships

Path parameters

account_idstring uuid required

Example:57826c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for the account.

Headers

Idempotency-Keystring

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

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

updated_atstring date-time

Date and time when this association was last updated.

Example request

{
  "ownership_percentage": 35.75
}

Response

Account relationship object

account_idstring uuid

Account ID