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 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.

Body

application/json
chain
string
required

Chain the deposit settled on, for example ETH. Stored lowercase and compared case-insensitively with your wallet address book entries, so use the same chain token there.

Maximum string length: 32
txid
string
required

On-chain transaction hash. Deduped together with wallet_address.

Maximum string length: 128
wallet_address
string
required

The destination wallet you received the deposit on. An XRP X-address is split into its classic address and tag.

Maximum string length: 128
amount
string
required

Deposit amount as a decimal string, zero or greater, with up to 18 decimal places.

currency
string
required

Deposit asset, e.g. "USDC".

Maximum string length: 16
originator_data
object

Originator details from the sending VASP, if known, as a flat object such as {"name": "..."}. Didit reads name (or full_name), first_name, last_name and vendor_data from it.

beneficiary_data
object

Beneficiary details (your customer), as a flat object such as {"name": "..."}. Didit matches name against the holder_name of the matched address book entry, and sets wallet_address and chain from the request.

originating_vasp
object

Optional description of the sending VASP. It stays on this transfer only (metadata.originating_vasp, and the transfer's originator VASP in GET /v3/travel-rule/transfers/); it never creates, edits or links a shared VASP directory entry.

memo
string

Optional. The deposit's destination tag or memo on a memo network: on a shared deposit address it is what tells your customers apart, and the address-book entry for that memo is matched. 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
utxo
object

Optional, UTXO chains only. The deposit transaction's inputs and outputs: the sender's wallet is the declared originator_data.wallet_address, else the largest input.

Response

A transfer for this txid and wallet_address was already registered; the existing one is returned unchanged (created is false).

transaction_id
string<uuid>

Didit transaction UUID for the inbound deposit.

txn_id
string

txn_id of the inbound transaction: Didit-generated when Didit created the transaction, or your own when an unclaimed deposit was reused.

created
boolean

true when this call registered the transfer (HTTP 201); false when a transfer for the same txid and wallet_address already existed (HTTP 200).

travel_rule
object

Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. While an inbound transfer's wallet ownership is unconfirmed, the counterparty's originator_data and beneficiary_data come back masked (the first letter of each word is kept; the wallet, chain and VASP routing stay readable) and data_masked is true.

Last modified on November 11, 2026