Skip to main content
Weavr Multi Product API
Beneficiaries

Get all beneficiaries

GET/beneficiaries

Retrieves the beneficiaries that match the query parameters.

Request

Query parameters

Responses

200OK

Success

Headers
Body
application/json
{}
objectobject · 3 fields
Response example
{  "beneficiaries": [    {      "trustLevel": "TRUSTED",      "externalRefs": [        "string"      ],      "group": "string",      "beneficiaryInformation": {        "businessName": "string"      },      "beneficiaryDetails": {        "instrument": {          "id": "string",          "type": "managed_cards"        }      },      "id": "string",      "relatedOperationBatches": [        {          "batchId": "string",          "operation": "CREATE"        }      ],      "state": "INITIALISED",      "validationFailure": "INSTRUMENT_DETAILS_NOT_FOUND"    }  ],  "count": 0,  "responseCount": 0}