Sign in
latestOpenAPI 3.1.02026-07-26165182724.7 KB

63e57aa7df45

Counterparty

Declare VASP counterparty

Creates a DECLARED VASP counterparty. Use the VASP search API (POST /vasps) to find a VASP and supply its id as counterpartyVaspId.

The stored counterpartyData always uses entityType LEGAL with counterpartyVaspId; clients do not send entityType on this route.

post/counterparty/vasp

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.

currencystring required

Ledger currency ticker (e.g. SOL, POL, ETH). Must be a supported LedgerCryptoNetworks key.

networkstring required

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

counterpartyVaspIdstring required

VASP id from the id field of a POST /vasps result; must resolve in the directory.

Response

success

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.

createdAtstring date-time required
updatedAtstring date-time required