Counterparty

Update a Counterparty

Update a Counterparty (partial; unknown keys 400).

patch/counterparties/{counterpartyId}

Path parameters

counterpartyIdstring required

Counterparty ID (ctp_ prefix).

Request body

namestring

entityType'individual' | 'business'

emailstring

Contact email address.

phonestring

Phone in E.164 format.

taxIdstring

Tax ID (CPF, CNPJ, SSN, etc.). Required for some external-account types.

dateOfBirthstring date

Date of birth (YYYY-MM-DD).

nationalitystring

metadataobject

Free-form key-value pairs stored on the resource and echoed back on reads.

Response

The request has succeeded.

idstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

object'counterparty'

customerIdstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

status'active' | 'rejected' | 'deleted'

Lifecycle of a counterparty. rejected is reserved for create-time compliance screening (not yet active); deleted marks a soft-deleted record that remains readable by id.

rejectionReasonstring

Set when status = rejected.

namestring

Full legal name or registered business name.

entityType'individual' | 'business'

emailstring

phonestring

taxIdstring

dateOfBirthstring date

nationalitystring

ISO 3166-1 alpha-2.

metadataobject

createdAtstring date-time

updatedAtstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.