> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ebury.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mass Beneficiary Models

## MassBeneficiary

This model is a representation of a mass beneficiary.

**Fields**

<ResponseField name="mass_beneficiary_id" type="string" required>
  Unique UUID of the mass beneficiary. (Always)
</ResponseField>

<ResponseField name="error" type="object" required>
  The generic [error message](/api/getting-started#error-handling) for the mass beneficiary request, if any. (Always)
</ResponseField>

<ResponseField name="links" type="object" required>
  The [MassBeneficiaryLinks](#massbeneficiarylinks). (Always)
</ResponseField>

<ResponseField name="summary" type="object" required>
  The [MassBeneficiarySummary](#massbeneficiarysummary). (Always)
</ResponseField>

<ResponseField name="status" type="string" required>
  The [MassBeneficiaryStatus](#massbeneficiarystatus). (Always)
</ResponseField>

```json theme={null}
{
  "mass_beneficiary_id": "uuid",
  "error": {
    "code": "string",
    "message": "string",
    "details": "string"
  },
  "links": {
    "errors_href": "/mass-beneficiaries/$mass_beneficiary_id/errors",
    "created_href": "/mass-beneficiaries/$mass_beneficiary_id/beneficiaries",
  },
  "summary": {
    "received": "number",
    "errored": "number",
    "created": "number"
  },
  "status": "string"
}
```

## MassBeneficiaryStatus

The possible values for the "status" of every mass beneficiary instruction.

**Values**

| Value | Description |
| - | - |
| `pending` | The Mass Beneficiary is pending to be processed. |
| `creating` | The Mass Beneficiary is being processed. |
| `created` | The Mass Beneficiary has been successfully processed. |
| `failed` | The Mass Beneficiary has failed during processing. |
| `unknown` | The Mass Beneficiary has an unknown status. |

## MassBeneficiarySummary

This is an object containing categorized counters for the mass beneficiary.

**Fields**

<ResponseField name="received" type="integer" required>
  Total count of received beneficiaries. (Always)
</ResponseField>

<ResponseField name="created" type="integer" required>
  Total count of created beneficiaries. (Always)
</ResponseField>

<ResponseField name="errored" type="integer" required>
  Total count of errored beneficiaries. (Always)
</ResponseField>

## MassBeneficiaryLinks

This is an object containing 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.

**Fields**

<ResponseField name="errors_href" type="string" required>
  The link to the errors endpoint `/mass-beneficiaries/$mass_beneficiary_id/errors` (Always)
</ResponseField>

<ResponseField name="created_href" type="string" required>
  The link to the result endpoint `/mass-beneficiaries/$mass_beneficiary_id/beneficiaries` (Always)
</ResponseField>

## BeneficiaryCreationError

Creation errors of every beneficiary.

**Fields**

<ResponseField name="code" type="string" required>
  A short code for the error. (Always)
</ResponseField>

<ResponseField name="details" type="string" required>
  Error details. (Always)
</ResponseField>

<ResponseField name="message" type="string" required>
  The error message. (Always)
</ResponseField>

<ResponseField name="request_index" type="integer" required>
  The original position of the beneficiary on the submission file. It starts at 0. (Always)
</ResponseField>

## BeneficiaryCreated

Created beneficiaries.

**Fields**

<ResponseField name="request_index" type="integer" required>
  The original position of the beneficiary on the submission file. It starts at 0. (Always)
</ResponseField>

<ResponseField name="beneficiary_id" type="string" required>
  The ID of the created beneficiary. (Always)
</ResponseField>

<ResponseField name="links" type="object" required>
  The [BeneficiaryCreatedLinks](#beneficiarycreatedlinks). (Always)
</ResponseField>

## BeneficiaryCreatedLinks

This is an object containing links for the created beneficiary.

**Fields**

<ResponseField name="beneficiary_href" type="string">
  The link to the single beneficiary endpoint `/beneficiaries/$beneficiary_id`
</ResponseField>