Skip to main content
POST
Update a counterparty

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Headers

Idempotency-Key
string

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json
id
string<uuid>
required

The counterparty id

name
string | null

The counterparty name. Pass null to clear.

entityType
enum<string>

Whether the counterparty is a business or an individual

Available options:
business,
individual
isSelfOwned
boolean

Whether the counterparty is owned by the merchant

physicalAddress
object | null

A structured physical postal address.

dateOfBirth
string | null

The counterparty date of birth as YYYY-MM-DD. Pass null to clear.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

200 - application/json

The updated counterparty

id
string
required

The counterparty id

name
string | null
required

The counterparty name

entityType
enum<string>
required

Whether the counterparty is a business or an individual

Available options:
business,
individual
isSelfOwned
boolean
required

Whether the counterparty is owned by the merchant

blocked
boolean
required

Whether payments to and from the counterparty are blocked

financialAddress
object
required

The counterparty financial address

physicalAddress
object | null
required

A structured physical postal address.

dateOfBirth
string | null
required

The counterparty date of birth as YYYY-MM-DD

metadata
object
required

The counterparty metadata

createdAt
any
required

When the counterparty was created

updatedAt
any
required

When the counterparty was last updated