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
address
string
required
chain
string
holder_vendor_data
string
holder_name
string
entity_type
string
default:individual
self_declared
boolean
default:false

Write-only. When true, the entry is created already ownership-verified via a SELF_DECLARATION proof.

travel_address
string

Optional. The counterparty VASP's travel address for this wallet, enabling TRP routing.

Response

The created entry.

uuid
string<uuid>
address
string

The wallet address. Unique per application and chain among non-deleted entries.

chain
string | null

Free-text chain identifier, e.g. "ethereum", "bitcoin".

holder_vendor_data
string | null

Your internal identifier for the holder.

holder_name
string | null

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>
self_declared
boolean

Whether the entry was created as a self-declared ownership proof.

travel_address
string | null

The counterparty VASP's travel address for this wallet, if known. Lets Didit route this beneficiary's transfers over the TRP rail.