---
title: "Update relationship"
method: PATCH
path: "/relationships/{relationship_id}"
tags: ["Relationships"]
---

# Update relationship

`PATCH /relationships/{relationship_id}`

Update relationship by ID.

## Path parameters

- `relationship_id` string, uuid, required

## Headers

- `Idempotency-Key` string

## Request body

- union
  - object — Denotes the relationship between specified person and business.
    - `additional_data` AdditionalData — Contains additional information about the relationship.
      - `title` 'DIRECTOR' | 'FOUNDER' | 'OFFICER' | 'OTHER', required — The professional role or position the person holds at the related organization.
      - `title_other` string — The specific title or professional role at the related organization (required if not one of: `DIRECTOR`, `OFFICER`, `FOUNDER`).
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — Denotes the relationship between specified businesses.
    - `additional_data` AdditionalOwnerData — Contains additional information about the relationship.
      - `percent_ownership` number, double, required — Percentage ownership of the related business.
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_business_id` string, uuid — Unique ID for the subject business.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — Denotes the relationship between specified business and person.
    - `additional_data` AdditionalOwnerData — Contains additional information about the relationship.
      - `percent_ownership` number, double, required — Percentage ownership of the related business.
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — > 🚧 Alpha > The PAYER_PAYEE relationship is Alpha. We may make breaking changes to this schema. PAYER_PAYEE denotes the relationship between specified person or business as a payer or payee to a person or business
    - `additional_data` PayerPayeeAdditionalData — Contains the type of transfer for the payer and payee relationship
      - `transfer_type` 'CREDIT' | 'DEBIT' | 'DEBIT_OR_CREDIT', required
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_business_id` string, uuid — Unique ID for the subject business.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
    - `to_person_id` string, uuid — Unique ID for the related person.

## Response `200`

Updated relationship representation.

- union
  - object — Denotes the relationship between specified person and business.
    - `additional_data` AdditionalData — Contains additional information about the relationship.
      - `title` 'DIRECTOR' | 'FOUNDER' | 'OFFICER' | 'OTHER', required — The professional role or position the person holds at the related organization.
      - `title_other` string — The specific title or professional role at the related organization (required if not one of: `DIRECTOR`, `OFFICER`, `FOUNDER`).
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — Denotes the relationship between specified businesses.
    - `additional_data` AdditionalOwnerData — Contains additional information about the relationship.
      - `percent_ownership` number, double, required — Percentage ownership of the related business.
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_business_id` string, uuid — Unique ID for the subject business.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — Denotes the relationship between specified business and person.
    - `additional_data` AdditionalOwnerData — Contains additional information about the relationship.
      - `percent_ownership` number, double, required — Percentage ownership of the related business.
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
  - object — > 🚧 Alpha > The PAYER_PAYEE relationship is Alpha. We may make breaking changes to this schema. PAYER_PAYEE denotes the relationship between specified person or business as a payer or payee to a person or business
    - `additional_data` PayerPayeeAdditionalData — Contains the type of transfer for the payer and payee relationship
      - `transfer_type` 'CREDIT' | 'DEBIT' | 'DEBIT_OR_CREDIT', required
    - `creation_time` string, date-time — The date and time the resource was created.
    - `from_business_id` string, uuid — Unique ID for the subject business.
    - `from_person_id` string, uuid — Unique ID for the subject person.
    - `id` string, uuid — Relationship unique identifier.
    - `last_updated_time` string, date-time — The date and time the resource was last updated.
    - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
    - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', 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
    - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `to_business_id` string, uuid — Unique ID for the related business.
    - `to_person_id` string, uuid — Unique ID for the related person.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `404` — Resource not found
- `409` — Resource already exists error
- `422` — Unprocessable entity request response
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)