Generate Deposit Address

Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Vault Account.

Path parameters

blockchain string required

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

network string required

Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "sepolia" are test networks.

vaultId string required

Represents the unique ID of the specific Vault.

Query parameters

context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Body parameters application/json

context string

data object required

item object required

label string required e.g. yourLabelStringHere

Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".

vaultAccountId string required e.g. 60c9d9921c38030006675ff6

Unique identifier of the vault account.

Response

Returns 201 the resource has been successfully created.

apiVersion string required

Specifies the version of the API that incorporates this endpoint.

E.G. 2026-03-20

requestId string required

Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.

E.G. 601c1710034ed6d407996b30

context string

E.G. yourExampleString

data object required

item object required

address string required

Specifies the specific address's unique string value.

E.G. 2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66

createdTimestamp integer required

Defines the specific UNIX time when the deposit address was created.

E.G. 1624028267

label string required

Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".

E.G. yourLabelStringHere

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json

401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json

403 This vault is not for the provided network. application/json

404 The specified resource has not been found. application/json

409 Address derivation failed due to concurrent requests. Please try again. application/json

415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json

422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json

429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json

500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json