Skip to main content
POST
Retrieve addresses

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