Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Counterparty

Get a counterparty by identifier

post/counterparty/get

Request body

userIdstring uuid

Owner user id. Provide exactly one of userId / businessId.

businessIdstring uuid

Owner business id. Provide exactly one of userId / businessId.

counterpartyAddressstring

On-chain destination address. Provide exactly one of counterpartyAddress / paymentHash / invoice.

paymentHashstring

Lightning payment hash (64-hex on BTC). Provide exactly one of counterpartyAddress / paymentHash / invoice.

invoicestring

bolt11 invoice (decoded server-side to a payment hash). Provide exactly one of counterpartyAddress / paymentHash / invoice.

networkstring required

Blockchain network for the currency (e.g. SOL, POLYGON, ETH). Must equal the network implied by currency.

Response

OK

counterpartyIdstring uuid required
userIdstring uuid
businessIdstring uuid
identityType'CONSUMER' | 'BUSINESS' required
counterpartyAddressstring

Set for on-chain counterparties.

paymentHashstring

Set for Lightning (non-invoice) counterparties.

invoicestring

Set when declared with a bolt11 Lightning invoice.

memostring

Decoded memo from the bolt11 invoice, when present.

networkstring required
type'SELF_HOSTED' | 'VASP' required
subType'OWNED' | 'THIRD_PARTY' | 'VASP' required
counterpartyDataobject

IVMS-oriented payload; shape depends on counterparty type / subType.

walletVerifiedboolean

Present only for on-chain SELF_HOSTED + OWNED counterparties. true when wallet ownership has been verified (TRWalletVerification.status === VERIFIED); false when unverified. Omitted for Lightning OWNED (wallet verification does not apply), VASP, and THIRD_PARTY.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "counterpartyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "userId": "8ae384b7-ce6b-4b00-a4ec-1bcb9a5e5d1d",
  "identityType": "CONSUMER",
  "counterpartyAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
  "network": "Eth",
  "type": "SELF_HOSTED",
  "subType": "OWNED",
  "walletVerified": true,
  "createdAt": "2026-05-14T12:00:00.000Z",
  "updatedAt": "2026-05-14T12:00:00.000Z"
}