Skip to main content
POST
/
accounts
/
{account_id}
/
relationships
Create account relationship
curl --request POST \
  --url https://api.synctera.com/v2/accounts/{account_id}/relationships \
  --header 'Content-Type: application/json' \
  --data '
{
  "relationship_type": "PRIMARY_ACCOUNT_HOLDER",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-11-07T05:31:56Z",
  "ownership_percentage": 35.75,
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z"
}
'
{
  "relationship_type": "PRIMARY_ACCOUNT_HOLDER",
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ownership_percentage": 35.75,
  "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
account_id
string<uuid>
required

Unique identifier for the account.

Example:

"57826c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Account relationship object

The relationship of the account and the customer/business. Either customer_id OR business_id must be specified, but not both.

​
relationship_type
enum<string>
required

Relationship type

Available options:
PRIMARY_ACCOUNT_HOLDER,
ACCOUNT_HOLDER,
JOINT_ACCOUNT_HOLDER,
AUTHORIZED_SIGNER,
AUTHORIZED_USER,
BENEFICIARY
​
business_id
string<uuid>

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

​
created_at
string<date-time>

Date and time when this association was created.

​
customer_id
string<uuid>

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

​
deleted_at
string<date-time>

Date and time when this association was deleted.

​
ownership_percentage
number<double>

The ownership percentage of the related party.

Required range: 0 <= x <= 100
Example:

35.75

​
person_id
string<uuid>
deprecated

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

​
updated_at
string<date-time>

Date and time when this association was last updated.

Response

Account relationship object

The relationship of the account and the customer/business.

​
relationship_type
enum<string>
required

Relationship type

Available options:
PRIMARY_ACCOUNT_HOLDER,
ACCOUNT_HOLDER,
JOINT_ACCOUNT_HOLDER,
AUTHORIZED_SIGNER,
AUTHORIZED_USER,
BENEFICIARY
​
business_id
string<uuid>

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

​
created_at
string<date-time>

Date and time when this association was created.

​
customer_id
string<uuid>

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

​
deleted_at
string<date-time>

Date and time when this association was deleted.

​
id
string<uuid>

ID of account relationship

​
ownership_percentage
number<double>

The ownership percentage of the related party.

Required range: 0 <= x <= 100
Example:

35.75

​
person_id
string<uuid>
deprecated

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

​
updated_at
string<date-time>

Date and time when this association was last updated.

​
account_id
string<uuid>

Account ID