Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Counterparty

Declare self-hosted counterparty

Creates a DECLARED self-hosted counterparty for the given owner (userId or businessId) and application.

Wallet ownership for subType OWNED is proven separately via POST /counterparty/self-hosted/verify-wallet. The signed message format and UTC date rules for that flow are documented on VerifySelfHostedWalletRequest.

post/counterparty/self-hosted

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.

subType'OWNED' | 'THIRD_PARTY' required

OWNED or THIRD_PARTY self-hosted counterparty.

entityType'NATURAL' | 'LEGAL'
firstNamestring
lastNamestring
dateOfBirthstring date

ISO 8601 date string (YYYY-MM-DD).

placeOfBirthstring
countrystring

ISO 3166-1 alpha-2 country code (two uppercase letters).

entityAddressstring
legalNamestring
leistring

Legal Entity Identifier (20-character alphanumeric).

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