Declare self-hosted counterparty

Creates a DECLARED self-hosted counterparty for userId + application. For subType OWNED, optional signature and signedMessage verify wallet control; the signed message format and UTC date rules are enforced server-side (embedded DD/MM/YYYY must be yesterday, today, or tomorrow in UTC).

Example signedMessage (replace address, userId, and the date so the date is valid in UTC):

I am verifying ownership of the wallet address {address} as customer {userId}. This message was signed on {DD/MM/YYYY} to confirm my control over this wallet.

Sign it with the wallet that owns address, then send the resulting signature with the same signedMessage text you signed (see request body examples).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Declare a self-hosted counterparty. Provide exactly one owner (userId/businessId) and exactly one identifier (counterpartyAddress/paymentHash/invoice). Wallet ownership is proven separately via POST /counterparty/self-hosted/verify-wallet.

uuid

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

uuid

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

string

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

string

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

string

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

string
required

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

string
required

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

string
enum
required

OWNED or THIRD_PARTY self-hosted counterparty.

Allowed:
string
enum
Allowed:
string
string
string
string
string
string
string
string
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json