Skip to main content
GET
Retrieve a single Mass Beneficiary submission
Retrieve a mass beneficiary resource for a given mass_beneficiary_id. The status field will provide the latest status.

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

Response

The Mass Beneficiary resource

A representation of a mass beneficiary.

mass_beneficiary_id
string<uuid>

Unique UUID of the mass beneficiary

error
object

An error message.

Links for the mass beneficiary related information. Each link helps the user agent to fetch resources related to errored beneficiaries, and also those created successfully. The mass_beneficiary_id does not need to be stored as the said resources may be accessed with the provided links.

summary
object

Categorized counters for the mass beneficiary.

status
enum<string>

This is an enumeration of the status of every mass beneficiary instruction

Available options:
pending,
creating,
created,
failed,
unknown