v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Relationships

Create a relationship

Create a party relationship.

post/relationships

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

OR
OR
OR

Example request

{
  "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",
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

Response

Created relationship representation.

OR
OR
OR

Example response

{
  "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",
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}