Skip to main content
GET
Retrieve successfully created Beneficiaries
View all the created beneficiaries in a mass beneficiaries instruction.
Please note that if the mass beneficiaries status is “pending” then an empty list will be returned.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

Path Parameters

mass_beneficiary_id
string
required

The unique ID of the mass beneficiary

Query Parameters

client_id
string
required

The ID of the client

page
integer<int32>

The desired page number for pagination. By default is 1.

page-size
integer<int32>

The number of items per page for pagination. By default is 50.

Response

List of successfully created beneficiaries

request_index
number

The original position of the beneficiary on the submission file. Starts at 0

beneficiary_id
string

The ID of the created beneficiary

Links for the created beneficiary.