Skip to main content
Update related party

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Headers

Idempotency-Key
string
required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId
string
required

Body

application/json

Related-party-type-specific JSON merge document. The stored party type selects the applicable branch; shared-only patches can satisfy both schemas. Unknown request fields are silently ignored.

roles
enum<string>[]
Available options:
control_person,
director,
officer,
authorized_signer,
authorized_representative,
compliance_officer,
primary_contact,
account_administrator,
trustee,
settlor,
protector,
beneficiary,
general_partner,
limited_partner,
other
roleDescription
string | null

Preserved exactly; leading/trailing whitespace and control characters are rejected.

Required string length: 1 - 256
title
string | null

Preserved exactly; leading/trailing whitespace and control characters are rejected.

Required string length: 1 - 256
ownership
object | null
votingRights
object | null
control
object | null
person
object

Response

Related party updated

data
object
required