Skip to main content
POST
curl
Didit’s wallet registration API adds an address book entry and returns its read-only ownership_proof metadata. The response includes the selected proof and latest attempt separately, plus reuse status and current network eligibility. See ownership proof metadata. These fields are response-only; a self-declaration alone is not a network control proof.

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.

Headers

Idempotency-Key
string

Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409 idempotency_key_reused, and while the first request is still running, 409 idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.

Required string length: 1 - 255

Body

application/json
address
string
required

The wallet address. An XRP X-address is stored as its classic address and its tag, so it matches transfers that name either form.

Maximum string length: 128
chain
string

Chain token for the address, for example ETH or BTC. When Didit routes or registers a transfer, it matches address book entries on the wallet address and, when the transfer carries a chain, on this value too, ignoring case. A transfer's chain is beneficiary_data.chain, filled from the transaction's crypto chain or currency symbol (for example ETH) when you do not send it, or the chain of an after-deposit registration, so use the same token everywhere. An entry with an empty chain matches any chain. Known chains are stored under one canonical identifier whatever spelling you send: "ethereum", "Ethereum" and "ERC20" are all stored as ETH, "BNB Smart Chain" and "BEP20" as BNB, "tron" as TRX. An unknown chain name is kept as given.

Maximum string length: 32
holder_vendor_data
string
Maximum string length: 255
holder_name
string
Maximum string length: 255
entity_type
string
default:individual
Maximum string length: 16
self_declared
boolean
default:false

Write-only. When true, the entry is created already ownership-verified via a SELF_DECLARATION proof. Returns 400 when allow_self_declaration is off in your Travel Rule settings.

travel_address
string

Optional. The counterparty VASP's travel address for this wallet, enabling TRP routing for the assets TRP carries (BTC, ETH, and USDC on a named network). An invalid travel address returns 400.

Maximum string length: 512
memo
string

Optional. The destination tag or memo that is part of the wallet. XRP: a destination tag, a whole number from 0 to 4294967295 (a JSON number is accepted). XLM: a text memo of up to 28 bytes, a 64-bit id or a 32-byte hash in hex. EOS: up to 256 bytes. ATOM: up to 256 characters. HBAR: up to 100 bytes. Bitcoin, EVM, Solana, Tron, Litecoin, Bitcoin Cash, Dogecoin and Lightning wallets take no memo: one there is a 400. Alias: destinationTag or destination_tag.

Maximum string length: 256

Response

The created entry.

uuid
string<uuid>
address
string

The wallet address; "" for an entry imported by its hash only. Unique per application, chain and memo, comparing the address without regard to case. After you delete an entry, you can register the same address again.

chain
string

Chain token for the address, for example ETH or BTC. When Didit routes or registers a transfer, it matches address book entries on the wallet address and, when the transfer carries a chain, on this value too, ignoring case. A transfer's chain is beneficiary_data.chain, filled from the transaction's crypto chain or currency symbol (for example ETH) when you do not send it, or the chain of an after-deposit registration, so use the same token everywhere. An entry with an empty chain matches any chain. A Lightning payee (a node id or a Lightning Address) registered on bitcoin is stored lowercased on LIGHTNING, where Lightning transfers are matched. Known chains are stored under one canonical identifier whatever spelling you send: "ethereum", "Ethereum" and "ERC20" are all stored as ETH, "BNB Smart Chain" and "BEP20" as BNB, "tron" as TRX. An unknown chain name is kept as given.

holder_vendor_data
string

Your internal identifier for the holder.

holder_name
string

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

entity_type
string

Free text, defaults to "individual".

is_ownership_verified
boolean

Read-only. Whether ownership of this address has been proven.

created_at
string<date-time>
travel_address
string

The counterparty VASP's travel address for this wallet, if known. Lets Didit route this beneficiary's transfers over the TRP rail, for the assets TRP carries (BTC, ETH, and USDC on a named network).

address_hash
string

Read-only. SHA-256 of the lowercased address, in lowercase hex. An entry imported by its hash only is matched on it.

memo
string

The destination tag or memo that is part of the wallet on a memo network (XRP, XLM, EOS, ATOM, HBAR); "" for the whole address. An entry with a memo matches only transfers naming that memo; one without matches the whole address.

receiving_travel_address
string
read-only

Your per-wallet travel address for this wallet: give it to the sending VASP so its TRP inquiry names this wallet. Empty for a wallet recorded as another VASP's, while Travel Rule is off, and before your VASP profile is saved.

ownership_proof
object

Current valid proof, preferring the most recently verified proof; otherwise the latest attempt. A failed retry does not replace a current valid proof. This metadata is read-only.

Example:
label
string

Current wallet label, exactly as saved.

owner_type
enum<string>

Wallet owner type.

Available options:
customer,
internal,
vasp
Last modified on November 14, 2026