Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Body

application/json
wallet_address
string
required

The wallet address to verify.

chain
string
required

Chain identifier for the address, e.g. "ethereum", "bitcoin", "solana".

holder_name
string

Name of the wallet holder, used for the beneficiary name match.

vendor_data
string

Your internal identifier for the holder, carried onto the created address-book entry.

transaction_id
string<uuid>

Optional. Didit transaction UUID of a Travel Rule transfer to advance when the proof verifies.

satoshi_deposit_address
string

Optional. A deposit address you control; supplying it enables the SATOSHI_TEST proof method.

callback_url
string

Optional. Where the widget returns the customer after completion.

expires_in_minutes
integer

Optional. Lifetime of the minted link, in minutes. Automatically extended to cover the Satoshi test window when SATOSHI_TEST is offered.

Response

201 - application/json

The minted widget session.

widget_session_id
string<uuid>
token
string

Opaque session token embedded in the widget URL.

url
string

The hosted wallet-ownership widget URL. Open it verbatim in the system browser (never inside a mobile SDK webview).

expires_at
string<date-time>