POST
/
relationships
Create a relationship
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/relationships \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_data": {
    "percent_ownership": 35.75
  },
  "from_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "metadata": {},
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}'
{
  "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",
  "metadata": {},
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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"

Body

application/json

Party relationship to create.

Denotes the relationship between specified businesses.

​
additional_data
object
required

Contains additional information about the relationship.

​
from_business_id
string<uuid>
required

Unique ID for the subject business.

Example:

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

​
relationship_type
enum<string>
required

The relationship type. One of the following:

  • 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 other notable person of an organization.
  • OWNER_OF – a business with ownership of another business.
  • PAYER_PAYEE - a person or business with a payer payee relationship with another person or business
Available options:
BENEFICIAL_OWNER_OF,
MANAGING_PERSON_OF,
OWNER_OF,
PAYER_PAYEE
Example:

"BENEFICIAL_OWNER_OF"

​
to_business_id
string<uuid>
required

Unique ID for the related business.

Example:

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

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

Response

Created relationship representation.

Denotes the relationship between specified businesses.

​
additional_data
object
required

Contains additional information about the relationship.

​
from_business_id
string<uuid>
required

Unique ID for the subject business.

Example:

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

​
relationship_type
enum<string>
required

The relationship type. One of the following:

  • 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 other notable person of an organization.
  • OWNER_OF – a business with ownership of another business.
  • PAYER_PAYEE - a person or business with a payer payee relationship with another person or business
Available options:
BENEFICIAL_OWNER_OF,
MANAGING_PERSON_OF,
OWNER_OF,
PAYER_PAYEE
Example:

"BENEFICIAL_OWNER_OF"

​
to_business_id
string<uuid>
required

Unique ID for the related business.

Example:

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

​
creation_time
string<date-time>

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>

Relationship unique identifier.

Example:

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

​
last_updated_time
string<date-time>

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"