Generate Deposit Address
Through this endpoint customers can generate a new Receiving/Deposit Addresses into their Vault Account.
Path Parameters
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
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.
Represents the unique ID of the specific Vault.
Query Parameters
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.
Request Body Schema application/json
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.
Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".
Unique identifier of the vault account.
Response Schema
-
201Content-Type: application/json
The resource has been successfully created.
-
400Content-Type: application/json
The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.
-
401Content-Type: application/json
The provided API key is invalid. Please, generate a new one from your Dashboard.
-
403Content-Type: application/json
This vault is not for the provided network.
-
404Content-Type: application/json
The specified resource has not been found.
-
409Content-Type: application/json
Address derivation failed due to concurrent requests. Please try again.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
-
429Content-Type: application/json
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.
-
500Content-Type: application/json
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.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
Specifies the specific address's unique string value.
Defines the specific UNIX time when the deposit address was created.
Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
resource_not_found
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
unsupported_media_type
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
invalid_request_body_structure
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
request_limit_reached
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Vaultody and it's unique for every request.
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.
unexpected_server_error
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Credits Cost : 500 Credits for 1 Results
cb233681a8ee35665296c1824c1f67bc46691788
PSqeqRLap8rBc/wogNU1DeGGUPb2VyVtg6GiBOaBnYQ=
1681885776
zYgKeueoOq
{
"context": "yourExampleString",
"data": {
"item": {
"label": "yourLabelStringHere",
"vaultAccountId": "60c9d9921c38030006675ff6"
}
}
}
-
201Content-Type: application/json
The resource has been successfully created.
-
400Content-Type: application/json
The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.
-
401Content-Type: application/json
The provided API key is invalid. Please, generate a new one from your Dashboard.
-
403Content-Type: application/json
This vault is not for the provided network.
-
404Content-Type: application/json
The specified resource has not been found.
-
409Content-Type: application/json
Address derivation failed due to concurrent requests. Please try again.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
-
429Content-Type: application/json
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.
-
500Content-Type: application/json
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.
{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"address": "2MtzNEqm2D9jcbPJ5mW7Z3AUNwqt3afZH66",
"createdTimestamp": 1624028267,
"label": "yourLabelStringHere"
}
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "uri_not_found",
"message": "The specified URI has not been found. Check the URI and try again.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "limit_greater_than_allowed",
"message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_pagination",
"message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "missing_api_key",
"message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_api_key",
"message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "endpoint_not_allowed_for_plan",
"message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "endpoint_not_allowed_for_api_key",
"message": "This endpoint is not available for your API key.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "feature_mainnets_not_allowed_for_plan",
"message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "vault_as_a_service_deposit_addresses_limit_reached",
"message": "You have reached the maximum Deposit Addresses count which is currently {depositAddressesCount}. Please, upgrade your plan in order to have a higher Deposit Address count.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "vault_as_a_service_provided_network_is_not_suitable_for_this_vault_type",
"message": "This vault is not for the provided network.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "resource_not_found",
"message": "The specified resource has not been found.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_data",
"message": "The data provided seems to be invalid.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "address_derivation_conflict",
"message": "Address derivation failed due to concurrent requests. Please try again.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "unsupported_media_type",
"message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_request_body_structure",
"message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "request_limit_reached",
"message": "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.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2026-03-20",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "unexpected_server_error",
"message": "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.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}