Skip to main content
POST
/
v3
/
api
/
netwmgmt
/
addresses
Retrieve addresses
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "statuses": [
    "ACTIVE"
  ],
  "beneficiaryIds": [
    "BNF-APICOM12589-LBT2CZTNYC"
  ],
  "cryptoAddressIds": [
    "ff91be0d-bca9-4a3f-9193-42106a1bbed2"
  ],
  "addresses": [
    "0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff"
  ],
  "blockchains": [
    "ETH"
  ],
  "blockchainIds": [
    "eth-eth"
  ],
  "vaspIds": [
    "ff6e590c-53ed-4e49-91e2-7927c1dad21f"
  ],
  "addressPurposes": [
    "BIDIRECTIONAL"
  ],
  "hostedAddress": false,
  "paginationLimit": 10,
  "paginationOffset": 123,
  "sort": {
    "by": "id",
    "order": "ASC"
  }
}
'
[
  {
    "total": 123,
    "items": [
      {
        "cryptoAddressId": "ff6e590c-53ed-4e49-91e2-7927c1dad21f",
        "address": "0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff",
        "blockchain": "ETH",
        "blockchainId": "eth-eth",
        "status": "ACTIVE",
        "addressPurpose": [
          "INCOMING",
          "OUTGOING"
        ],
        "vaspId": "ff6e590c-53ed-4e49-91e2-7927c1dad21f",
        "createdAt": "2021-05-11T04:43:43Z",
        "beneficiaryId": "BNF-ZTEST-LBT2CZTNYC",
        "notes": "test notes",
        "hostedAddress": true
      }
    ]
  }
]

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
statuses
string[]

Search by status i.e. ACTIVE or DEACTIVATED

beneficiaryIds
string[]

Search by beneficiary IDs

cryptoAddressIds
string[]

Search by address IDs

addresses
string[]

Search by on-chain addresses

blockchains
string[]

Search by blockchain i.e. BTC, ETH, ...

blockchainIds
string[]

Search by blockchain ID i.e. btc-btc or eth-Seth

vaspIds
string[]

Search by VASP IPs

addressPurposes
string[]

Search by purpose of address i.e. INCOMING, OUTGOING or both

hostedAddress
boolean

Specify if the address hosted or managed by a VASP

Example:

false

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number
sort
object

Response

OK

total
integer
required
items
object[]
required