> ## 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.

# Beneficiary Models

## BankAccount

```json theme={null}
{
  "account_number": "string",
  "bank_address_line_1": "string",
  "bank_country_code": "string",
  "bank_currency_code": "string",
  "bank_identifier": "string",
  "bank_identifier_type": "string",
  "bank_name": "string",
  "correspondent_account": "string",
  "correspondent_swift_code": "string",
  "iban": "string",
  "inn": "string",
  "kbk": "string",
  "kio": "string",
  "kpp": "string",
  "purpose_of_payment": "string",
  "reason_for_trade": "string",
  "reference_information": "string",
  "russian_central_bank_account": "string",
  "swift_code": "string",
  "vo": "string",
  "account_id": "string"
}
```

Bank account data. Refer to the [Metadata API](/api/metadata/get-beneficiary-metadata) for valid field combinations.

**Fields**

<ResponseField name="account_number" type="string">
  The account number of the bank account
</ResponseField>

<ResponseField name="bank_address_line_1" type="string">
  The first address line of the bank
</ResponseField>

<ResponseField name="bank_country_code" type="string" required>
  The ISO 3166-1 alpha-2 code of the bank's country
</ResponseField>

<ResponseField name="bank_currency_code" type="string" required>
  The ISO 4217 code of the bank account's currency
</ResponseField>

<ResponseField name="bank_identifier" type="string">
  The identifier of the bank
</ResponseField>

<ResponseField name="bank_identifier_type" type="string">
  The identifier type of the bank
</ResponseField>

<ResponseField name="bank_name" type="string">
  Name of the bank account holder
</ResponseField>

<ResponseField name="correspondent_account" type="string">
  The account for the correspondent account of the bank
</ResponseField>

<ResponseField name="correspondent_swift_code" type="string">
  The SWIFT code for the correspondent account of the bank
</ResponseField>

<ResponseField name="iban" type="string">
  The IBAN of the bank account
</ResponseField>

<ResponseField name="inn" type="string">
  The INN of the bank account
</ResponseField>

<ResponseField name="kbk" type="string">
  The KBK of the bank account
</ResponseField>

<ResponseField name="kio" type="string">
  The KIO of the bank account
</ResponseField>

<ResponseField name="kpp" type="string">
  The KPP of the bank account
</ResponseField>

<ResponseField name="purpose_of_payment" type="string">
  The [purpose of payment](#purposeofpayment) is mandatory when the beneficiary account has specific currency types. See the section [PurposeOfPayment](#purposeofpayment) for the currencies and their acceptable values.
</ResponseField>

<ResponseField name="reason_for_trade" type="string">
  The reason for trade of the bank account
</ResponseField>

<ResponseField name="reference_information" type="string">
  The reference information which will be used as the default payment reference during payment initiation.
</ResponseField>

<ResponseField name="russian_central_bank_account" type="string">
  The Russian central account number of the bank account
</ResponseField>

<ResponseField name="swift_code" type="string">
  The SWIFT code of the bank account
</ResponseField>

<ResponseField name="vo" type="string">
  The VO of the bank account
</ResponseField>

<ResponseField name="account_id" type="string" required>
  The identifier of the bank account
</ResponseField>

## BeneficiaryCoreData

```json theme={null}
{
  "name": "string",
  "email_addresses": [
    "string"
  ],
  "email_notification": "boolean",
  "address_line_1": "string",
  "street_name": "string",
  "building_number": "string",
  "floor": "string",
  "apartment_office_number": "string",
  "city": "string",
  "state_region": "string",
  "post_code": "string",
  "country_code": "string"
}
```

This model is a representation of a beneficiary's core data.

**Fields**

<ResponseField name="name" type="string" required>
  The name of the beneficiary
</ResponseField>

<ResponseField name="email_addresses" type="array">
  The list of beneficiary's email addresses
</ResponseField>

<ResponseField name="email_notification" type="boolean" required>
  Whether the beneficiary should receive email notification of payments
</ResponseField>

<ResponseField name="address_line_1" type="string">
  The first address line of the beneficiary
</ResponseField>

<ResponseField name="street_name" type="string">
  The street name of the beneficiary\*
</ResponseField>

<ResponseField name="building_number" type="string">
  The building number of the beneficiary\*
</ResponseField>

<ResponseField name="floor" type="string">
  The floor of the beneficiary\*
</ResponseField>

<ResponseField name="apartment_office_number" type="string">
  The apartment/office number of the beneficiary\*
</ResponseField>

<ResponseField name="city" type="string" required>
  The city of the beneficiary\*
</ResponseField>

<ResponseField name="state_region" type="string">
  The state/region of the beneficiary\*
</ResponseField>

<ResponseField name="post_code" type="string">
  The postcode of the beneficiary
</ResponseField>

<ResponseField name="country_code" type="string" required>
  The ISO 3166-1 alpha-2 code of the beneficiary's country
</ResponseField>

\* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.

## Beneficiary

```json theme={null}
{
  "name": "string",
  "email_addresses": [
    "string"
  ],
  "email_notification": "boolean",
  "address_line_1": "string",
  "street_name": "string",
  "building_number": "string",
  "floor": "string",
  "apartment_office_number": "string",
  "city": "string",
  "state_region": "string",
  "post_code": "string",
  "country_code": "string",
  "bank_accounts": [
    {
      "account_number": "string",
      "bank_address_line_1": "string",
      "bank_country_code": "string",
      "bank_currency_code": "string",
      "bank_identifier": "string",
      "bank_identifier_type": "string",
      "bank_name": "string",
      "correspondent_account": "string",
      "correspondent_swift_code": "string",
      "iban": "string",
      "inn": "string",
      "kbk": "string",
      "kio": "string",
      "kpp": "string",
      "purpose_of_payment": "string",
      "reason_for_trade": "string",
      "reference_information": "string",
      "russian_central_bank_account": "string",
      "swift_code": "string",
      "vo": "string",
      "account_id": "integer"
    }
  ],
  "beneficiary_id": "string",
  "created": "string",
  "aml_status": "string",
  "active": "string",
  "beneficiary_reference": "string",
}
```

This model is a representation of a beneficiary.

**Fields**

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

<ResponseField name="email_addresses" type="array">
  The list of beneficiary's email addresses
</ResponseField>

<ResponseField name="email_notification" type="boolean" required>
  Whether the beneficiary should receive email notification of payments (Always)
</ResponseField>

<ResponseField name="address_line_1" type="string">
  The first address line of the beneficiary
</ResponseField>

<ResponseField name="street_name" type="string">
  The street name of the beneficiary\*
</ResponseField>

<ResponseField name="building_number" type="string">
  The building number of the beneficiary\*
</ResponseField>

<ResponseField name="floor" type="string">
  The floor of the beneficiary\*
</ResponseField>

<ResponseField name="apartment_office_number" type="string">
  The apartment/office number of the beneficiary\*
</ResponseField>

<ResponseField name="city" type="string" required>
  The city of the beneficiary\* (Always)
</ResponseField>

<ResponseField name="state_region" type="string">
  The state/region of the beneficiary\*
</ResponseField>

<ResponseField name="post_code" type="string">
  The postcode of the beneficiary
</ResponseField>

<ResponseField name="country_code" type="string" required>
  The ISO 3166-1 alpha-2 code of the beneficiary's country (Always)
</ResponseField>

<ResponseField name="bank_accounts" type="array" required>
  The list of beneficiary's [bank accounts](#bankaccount) (Always)
</ResponseField>

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

<ResponseField name="created" type="string" required>
  Creation date of the beneficiary (Always)
</ResponseField>

<ResponseField name="aml_status" type="string" required>
  [AML status](#amlstatus) of the beneficiary (Always)
</ResponseField>

<ResponseField name="active" type="boolean" required>
  True if beneficiary is active, False otherwise (Always)
</ResponseField>

<ResponseField name="beneficiary_reference" type="string">
  Unique external reference ID submitted by the client for the beneficiary.
</ResponseField>

\* This field and the related rule becomes operational from October 2024. Further communication will follow over emails. Please note, it does not apply to Ebury Mass Payments customers in Production.

## AMLStatus

AML status of the Beneficiary

**Values**

| Value | Description |
| - | - |
| `OK` | Beneficiary checks completed, ready to be paid |
| `Pending Review` | Reviewing beneficiary information |
| `Pending information` | Awaiting beneficiary information |
| `Blocked` | Client account blocked |

## PurposeOfPayment

Valid purpose of payment values.

When country is China, the following purpose of payment values are mandatory only for CNY currency.
[See values list](/api/resources/chn-pop-codes)

When country is United Arab Emirates, the following purpose of payment values are mandatory for all currencies.
[See values list](/api/resources/uae-pop-codes)