Get a Counterparty
Get a Counterparty by id.
Authorizations
Token from POST /auth/token
Path Parameters
Counterparty ID (ctp_ prefix).
Response
The request has succeeded.
A third party a customer transacts with — an entry in the customer's address book. Counterparties will own External Accounts (registered payment destinations) in a later slice.
The customer whose address book holds this counterparty.
Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q.
^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$Lifecycle of a counterparty. rejected is set when compliance screening finds a prohibited country, on create or on a later update. A counterparty rejected only for countryProhibited returns to active when an update moves its address to an allowed country; deleted marks a soft-deleted record that remains readable by id.
active, rejected, deleted Why the counterparty was rejected. Present only when status is rejected.
Single-line display name, read-only and server-composed: businessName for a business, or firstName + " " + lastName for an individual. It is the same string an instrument's owner.name carries. Write the structured fields; read this one.
Determines which structured name fields apply. Can be absent on reads for older counterparties that have not been classified yet.
individual, business Given name — present when entityType is individual and the row has structured name fields. Echoed back exactly as supplied.
Family name — present when entityType is individual and the row has structured name fields. Echoed back exactly as supplied.
Registered legal name — present when entityType is business and the row has structured name fields. Echoed back exactly as supplied.
Registered address. Omitted when the counterparty has none, such as one created without an address on a project that does not require it.
ISO 3166-1 alpha-2.