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.

Response

201
application/json

Created relationship representation.

Denotes the relationship between specified businesses.