Skip to main content
POST
/
v3
/
api
/
custody
/
wallets
/
addresses
/
generate
Retrieve an address for a wallet
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/custody/wallets/addresses/generate \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "walletId": "ZTEST-NOBENF-XSC2OKBERS",
  "currencyId": "eth-eth",
  "subClient": "<string>"
}
'
{
  "address": "<string>",
  "ledger": "<string>",
  "walletId": "<string>",
  "walletOwner": {
    "id": "<string>",
    "name": "<string>",
    "address": {
      "address1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "address2": "<string>",
      "zipCode": "<string>"
    }
  },
  "custodian": {
    "id": "<string>",
    "name": "<string>",
    "address": {
      "address1": "<string>",
      "city": "<string>",
      "country": "<string>",
      "address2": "<string>",
      "zipCode": "<string>"
    }
  },
  "integrityDetails": {
    "signature": "<string>",
    "zodiaPublicKey": "<string>"
  },
  "currencyId": "<string>"
}

Authorizations

X-Signature
string
header
required

Headers

submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json
walletId
string
required

Generate/retrieve an address for a given wallet ID

Example:

"ZTEST-NOBENF-XSC2OKBERS"

currencyId
string

Currency ID for multi-ledger wallet; will throw '400' error if the currency is not supported by the wallet

Example:

"eth-eth"

subClient
string

Use for validation; will throw an error if the sub-client is already existing on any wallet address under unified wallet

Maximum string length: 128

Response

OK

address
string
required

On-chain address

Maximum string length: 128
ledger
string
required

Ledger associated with the address

Maximum string length: 6
walletId
string
required

Wallet ID associated with the address

Maximum string length: 128
walletOwner
object
required
custodian
object
required
integrityDetails
object
required
currencyId
string

Currency ID associated with the address

Maximum string length: 128