Skip to main content
GET
Retrieve errors in beneficiaries creation using Mass Beneficiaries service
View all the errored beneficiaries in a mass beneficiaries instruction.
Please note that if the mass beneficiaries status is not “created”, then the list returned can be empty or incomplete.

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 beneficiary creation errors

code
string

A short code for the error

details
string

Error details

message
string

The error message

request_index
number

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