Skip to main content
GET
curl
Didit’s wallet address book API lists your application’s wallets with current ownership proof metadata and exact totals across all pages.

Ownership proof metadata

Each entry includes read-only ownership_proof: proof_id, method, status, failure_reason, latest_attempt, network_eligible and reuse_status. Didit selects the most recently verified current proof, or the latest attempt when no current proof exists. A rejected retry does not replace a valid proof: read latest_attempt to see that retry separately. With no proof, proof_id, method, status and latest_attempt are null and failure_reason is empty. method is MESSAGE_SIGNING, SATOSHI_TEST, SCREENSHOT or SELF_DECLARATION. failure_reason uses the fixed proof failure codes; it never contains raw diagnostic text. network_eligible describes current discoverability on the wallet’s stored chain and memo. It requires a current control proof, a live application with Travel Rule enabled, and a discoverable VASP profile. It does not mean the wallet was used on the network before or guarantee that a future transfer will be accepted. A verified screenshot or self-declaration alone does not establish network eligibility.

Exact totals

The response includes proof_totals over the entire application-scoped set before limit and offset. count is exact and equals proof_totals.wallets. A wallet can qualify for several methods, so do not add the method counts to calculate distinct verified wallets. Register and update responses return the same ownership metadata, without list totals.

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 wrong, revoked or expired; 403 means no key was sent, 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.

Query Parameters

limit
integer
default:50
Required range: x >= 1
offset
integer
default:0
Required range: x >= 0

Response

200 - application/json

Paginated wallet address book entries.

count
integer

Exact total of application-scoped wallets, equal to proof_totals.wallets, independent of limit and offset.

next
string | null
previous
string | null
results
object[]
proof_totals
object

Exact totals over the entire application-scoped wallet set before limit/offset pagination. Method counts overlap and must not be summed to obtain distinct verified wallets.

Last modified on November 14, 2026