Create an external wallet

Registers a wallet you already control so that AUDD can mint to it or accept a burn from it. AUDD never holds the keys: you supply the address and keep custody.

The wallet and the AUDD asset you intend to mint must be on the same network, so choose the network first with GET /networks and pass one of its subNetworks values.

A newly registered wallet is returned ACTIVE on networks where the address alone is enough. On networks that require the account to exist on chain it stays INACTIVE until it has a balance or some activity; fund it with a small amount of the network's native coin and call PUT /wallets/{id}/sync to re-check.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Registers a wallet you already control. AUDD stores the address only and never holds the keys.

Registers a wallet you already control. AUDD stores the address only and never holds the keys.

string
required
length ≤ 255

The wallet address on the chosen network.

string
required
length ≤ 255

Your distributor company id, as returned by GET /companies.

string
required
length ≤ 255

A friendly name for the wallet, used to identify it in lists.

string
required

The network this wallet is on, given as one of the subNetworks values from GET /networks, for example ETHEREUM_BASE_SEPOLIA. The wallet and the AUDD asset must be on the same network.

string
enum
required

CUSTOMER when AUDD will mint directly to an end user's wallet, DISTRIBUTOR for a wallet your organisation owns and controls. Any other value is rejected with messageKey wallet.invalid_external_wallet_type.

Allowed:
string
length ≤ 255

Optional id of the customer this wallet belongs to.

Headers
string
required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses

400

Invalid input. The body carries a messageKey identifying the rule that failed: wallet.company_id_required, wallet.nick_name_required, wallet.type_required, wallet.network_required, and wallet.invalid_external_wallet_type when type is anything other than DISTRIBUTOR or CUSTOMER. A missing publicKey is rejected with the plain message "must not be blank" and no messageKey, and a network or type outside the allowed values is rejected without a messageKey as well.

401

Unauthorized. The bearer token is missing, expired or invalid.

403

Forbidden. The token lacks the role needed to register an external wallet.

404

Not found. The companyId does not resolve to a company you can see.

500

Internal server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json