Retrieve addresses
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses \
--header 'Content-Type: application/json' \
--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"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses"
payload = {
"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" }
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses"
payload := strings.NewReader("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"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
}
]
}
]{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Network-V3
Retrieve addresses
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 '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"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses"
payload = {
"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" }
}
headers = {
"submitter-id": "<submitter-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'submitter-id': '<submitter-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"submitter-id: <submitter-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses"
payload := strings.NewReader("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("submitter-id", "<submitter-id>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custody.api-zodia.io/v3/api/netwmgmt/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["submitter-id"] = '<submitter-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-APICOM12589-LBT2CZTNYC\"\n ],\n \"cryptoAddressIds\": [\n \"ff91be0d-bca9-4a3f-9193-42106a1bbed2\"\n ],\n \"addresses\": [\n \"0xae8d2fb429ba08fef3c8168f9019b21cb06db7ff\"\n ],\n \"blockchains\": [\n \"ETH\"\n ],\n \"blockchainIds\": [\n \"eth-eth\"\n ],\n \"vaspIds\": [\n \"ff6e590c-53ed-4e49-91e2-7927c1dad21f\"\n ],\n \"addressPurposes\": [\n \"BIDIRECTIONAL\"\n ],\n \"hostedAddress\": false,\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"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
}
]
}
]{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}{
"timestamp": "2021-10-27T14:30:13.912Z",
"title": "Method Not Allowed",
"status": 415,
"details": [
{
"message": "Available methods : GET,POST",
"code": "ER-204"
}
]
}Headers
Email of API user submitting the request
Example:
"api-maker@zodia.io"
Body
application/json
Search by status i.e. ACTIVE or DEACTIVATED
Search by beneficiary IDs
Search by address IDs
Search by on-chain addresses
Search by blockchain i.e. BTC, ETH, ...
Search by blockchain ID i.e. btc-btc or eth-Seth
Search by VASP IPs
Search by purpose of address i.e. INCOMING, OUTGOING or both
Specify if the address hosted or managed by a VASP
Example:
false
Number of items in response (default is 10)
Example:
10
Show child attributes
Show child attributes
⌘I