Retrieve beneficiaries
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries \
--header 'Content-Type: application/json' \
--header 'submitter-id: <submitter-id>' \
--data '
{
"statuses": [
"ACTIVE"
],
"beneficiaryIds": [
"BNF-ZTEST-LBT2CZTNYC"
],
"beneficiaryNames": [
"My Bene"
],
"entityTypes": [
"INDIVIDUAL"
],
"companyIds": [
"TEST"
],
"paginationLimit": 10,
"paginationOffset": 123,
"sort": {
"by": "id"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries"
payload = {
"statuses": ["ACTIVE"],
"beneficiaryIds": ["BNF-ZTEST-LBT2CZTNYC"],
"beneficiaryNames": ["My Bene"],
"entityTypes": ["INDIVIDUAL"],
"companyIds": ["TEST"],
"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-ZTEST-LBT2CZTNYC'],
beneficiaryNames: ['My Bene'],
entityTypes: ['INDIVIDUAL'],
companyIds: ['TEST'],
paginationLimit: 10,
paginationOffset: 123,
sort: {by: 'id'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries', 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/beneficiaries",
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-ZTEST-LBT2CZTNYC'
],
'beneficiaryNames' => [
'My Bene'
],
'entityTypes' => [
'INDIVIDUAL'
],
'companyIds' => [
'TEST'
],
'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/beneficiaries"
payload := strings.NewReader("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\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/beneficiaries")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\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/beneficiaries")
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-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"beneficiaryId": "BNF-ZTEST-LBT2CZTNYC",
"beneficiaryName": "My Bene",
"registeredAddress": {
"line1": "<string>",
"city": "<string>",
"country": "<string>",
"line2": "<string>",
"zipCode": "<string>",
"state": "<string>"
},
"updatedAt": "2021-10-27T14:30:13.912Z",
"companyId": "ZTEST",
"status": "ACTIVE",
"registrationNumber": "<string>",
"dateOfIncorporation": "2023-11-07T05:31:56Z",
"operatingAddress": {
"line1": "<string>",
"city": "<string>",
"country": "<string>",
"line2": "<string>",
"zipCode": "<string>",
"state": "<string>"
}
}
],
"total": 123
}{
"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 beneficiaries
POST
/
v3
/
api
/
netwmgmt
/
beneficiaries
Retrieve beneficiaries
curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries \
--header 'Content-Type: application/json' \
--header 'submitter-id: <submitter-id>' \
--data '
{
"statuses": [
"ACTIVE"
],
"beneficiaryIds": [
"BNF-ZTEST-LBT2CZTNYC"
],
"beneficiaryNames": [
"My Bene"
],
"entityTypes": [
"INDIVIDUAL"
],
"companyIds": [
"TEST"
],
"paginationLimit": 10,
"paginationOffset": 123,
"sort": {
"by": "id"
}
}
'import requests
url = "https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries"
payload = {
"statuses": ["ACTIVE"],
"beneficiaryIds": ["BNF-ZTEST-LBT2CZTNYC"],
"beneficiaryNames": ["My Bene"],
"entityTypes": ["INDIVIDUAL"],
"companyIds": ["TEST"],
"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-ZTEST-LBT2CZTNYC'],
beneficiaryNames: ['My Bene'],
entityTypes: ['INDIVIDUAL'],
companyIds: ['TEST'],
paginationLimit: 10,
paginationOffset: 123,
sort: {by: 'id'}
})
};
fetch('https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries', 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/beneficiaries",
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-ZTEST-LBT2CZTNYC'
],
'beneficiaryNames' => [
'My Bene'
],
'entityTypes' => [
'INDIVIDUAL'
],
'companyIds' => [
'TEST'
],
'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/beneficiaries"
payload := strings.NewReader("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\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/beneficiaries")
.header("submitter-id", "<submitter-id>")
.header("Content-Type", "application/json")
.body("{\n \"statuses\": [\n \"ACTIVE\"\n ],\n \"beneficiaryIds\": [\n \"BNF-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\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/beneficiaries")
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-ZTEST-LBT2CZTNYC\"\n ],\n \"beneficiaryNames\": [\n \"My Bene\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\"\n ],\n \"companyIds\": [\n \"TEST\"\n ],\n \"paginationLimit\": 10,\n \"paginationOffset\": 123,\n \"sort\": {\n \"by\": \"id\"\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"beneficiaryId": "BNF-ZTEST-LBT2CZTNYC",
"beneficiaryName": "My Bene",
"registeredAddress": {
"line1": "<string>",
"city": "<string>",
"country": "<string>",
"line2": "<string>",
"zipCode": "<string>",
"state": "<string>"
},
"updatedAt": "2021-10-27T14:30:13.912Z",
"companyId": "ZTEST",
"status": "ACTIVE",
"registrationNumber": "<string>",
"dateOfIncorporation": "2023-11-07T05:31:56Z",
"operatingAddress": {
"line1": "<string>",
"city": "<string>",
"country": "<string>",
"line2": "<string>",
"zipCode": "<string>",
"state": "<string>"
}
}
],
"total": 123
}{
"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 statuses i.e. ACTIVE or DEACTIVATED
Search by specific beneficiary IDs
Search by beneficiary names
Search by type i.e. INDIVIDUAL or ORGANISATION
Search by company IDs
Number of items in response (default is 10)
Example:
10
Show child attributes
Show child attributes
⌘I