curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries \
--header 'Content-Type: application/json' \
--header 'X-Signature: <api-key>' \
--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",
"order": "ASC"
}
}
'{
"items": [
{
"beneficiaryId": "BNF-ZTEST-LBT2CZTNYC",
"entityType": "INDIVIDUAL",
"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
}curl --request POST \
--url https://api.custody.api-zodia.io/v3/api/netwmgmt/beneficiaries \
--header 'Content-Type: application/json' \
--header 'X-Signature: <api-key>' \
--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",
"order": "ASC"
}
}
'{
"items": [
{
"beneficiaryId": "BNF-ZTEST-LBT2CZTNYC",
"entityType": "INDIVIDUAL",
"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
}Email of API user submitting the request
"api-maker@zodia.io"
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)
10
Show child attributes