Skip to main content
PATCH
Update entity fields (provided fields only)

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

id
string
required

Body

application/json
name
string
Example:

"Berlin Bank AG"

types
enum<string>[]

Relationship kinds: client and/or counterparty. self is never assignable.

Minimum array length: 1
Available options:
client,
counterparty
Example:
Available options:
individual,
business
Example:

"business"

jurisdiction
string | null

ISO 3166-1 alpha-2, stored upper-cased.

Example:

"DE"

address
object | null
is_fi
boolean
default:false

Whether the entity is a regulated financial institution.

Example:

false

tax_ids
object[]

Tax identifiers. On PATCH this replaces the whole set — anything absent is deleted.

Maximum array length: 20
notes
string | null
Example:

"Onboarded via referral"

Response

id
string
required
Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

name
string
required
Example:

"Berlin Bank AG"

types
enum<string>[]
required
Available options:
self,
client,
counterparty
Example:
is_fi
boolean
required
Example:

false

created_at
string
required
Example:

"2026-09-14T10:00:00.000Z"

updated_at
string
required
Example:

"2026-09-14T10:00:00.000Z"

address
object
required
tax_ids
object[]
required
Available options:
individual,
business
Example:

"business"

jurisdiction
string | null
Example:

"DE"

notes
string | null
Example:

"Onboarded via referral"

Last modified on October 2, 2026