latestOpenAPI 3.0.32026-07-2650226215.9 KB

18fdaebf64e5

Counterparty

Get a Counterparty

Get a Counterparty by id.

get/counterparties/{counterpartyId}

Path parameters

counterpartyIdstring required

Counterparty ID (ctp_ prefix).

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