Skip to main content
POST
Prepare a pay-out route ownership proof
Requires scope: manage:pay-outs — see Required scopes. Returns the exact text the owner of a self-custody wallet must sign to prove they control it, so the pay-out route can finish registering. A route parks at AWAITING_OWNERSHIP_PROOF when its destination requires a Travel-Rule ownership proof and the source wallet is self-custody. Venly holds no key for that wallet, so only its owner can sign. This step is stateless — nothing is stored, and there’s no id or expiry. Calling it twice for the same route returns an equivalent message, so it’s safe to repeat.
The owner signs message verbatim. Don’t reformat, re-encode, pretty-print or reconstruct it — the signature is checked against those exact bytes.Only an externally-owned account can sign: the scheme is EIP-191, and ERC-1271 contract signatures are not supported. Self-custody wallets are single-key wallets only for now.
The message is date-bound (signedOnUtc), so a proof prepared on one day can’t be submitted against a message built for another. Sign and submit in the same session. Submit the result with Submit a route ownership proof. See Pay-outs.

Authorizations

Headers

x-tenant-id
string<uuid>

Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.

Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones you may use. Send the header once: a repeated header is rejected the same way.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

accountId
string<uuid>
required

Unique account identifier

routeId
string<uuid>
required

Unique pay-out route identifier

Response

The message to sign

success
boolean

Indicates whether the request was successful

result
object

The message a self-custody wallet owner must sign to prove they control the route's source wallet.