Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id
string
required

Organization ID (UUID)

holder_id
string
required

Holder ID (UUID)

instrument_id
string
required

Instrument ID (UUID)

Body

application/json
bankingDetails
object
required
metadata
object
required
regulatoryFields
object

Response

OK

accountId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

createdAt
string<date-time>
required
Example:

"2025-01-01T00:00:00Z"

deletedAt
string<date-time> | null
required
Example:

"2025-01-01T00:00:00Z"

holderId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

updatedAt
string<date-time>
required
Example:

"2025-01-01T00:00:00Z"

bankingDetails
object
document
string
Maximum string length: 100
Example:

"12345678900"

id
string<uuid>
Example:

"00000000-0000-0000-0000-000000000000"

metadata
object
regulatoryFields
object
type
string
Maximum string length: 100
Example:

"NATURAL_PERSON"