Skip to main content
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 '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
}

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 statuses i.e. ACTIVE or DEACTIVATED

beneficiaryIds
string[]

Search by specific beneficiary IDs

beneficiaryNames
string[]

Search by beneficiary names

entityTypes
string[]

Search by type i.e. INDIVIDUAL or ORGANISATION

companyIds
string[]

Search by company IDs

paginationLimit
number

Number of items in response (default is 10)

Example:

10

paginationOffset
number
sort
object

Response

OK

items
object[]
required
total
integer<int32>
required