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

# Account Models

These models are returned by the [get all accounts](#retrieve-a-list-of-accounts), [get an account](#retrieve-an-account) and [get currency accounts](#retrieve-currency-accounts) endpoints.

## AccountData

```json theme={null}
[
  {
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      },
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      }
    ],
    "currency": "currency",
    "status": "account_status"
  },
  {
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      },
      {
        "account_address": "account_address",
        "account_name": "account_name",
        "account_number": "account_number",
        "account_number_type": "account_number_type",
        "bank_identifier": "bank_identifier",
        "bank_identifier_type": "bank_identifier_type"
      }
    ],
    "currency": "currency",
    "status": "account_status"
  }
]
```

This model is a representation of an account within Ebury.

**Fields**

<ResponseField name="currency" type="string">
  Identification of the currency in which the account is held. Always present.
</ResponseField>

<ResponseField name="account_details" type="array">
  The list of [`AccountDetail`](#accountdetails)s for this `currency`. Always present.
</ResponseField>

<ResponseField name="status" type="string">
  The [`AccountStatus`](#accountstatus) of the account. Always present.
</ResponseField>

<ResponseField name="account_id" type="string">
  The UUID of the account. Always present.
</ResponseField>

<ResponseField name="account_type" type="string">
  The [`AccountType`](#accounttype) of the account. Always present.
</ResponseField>

<ResponseField name="account_subtype" type="string">
  The [`AccountSubType`](#accountsubtype) of the account. Always present.
</ResponseField>

## AccountDetails

```json theme={null}
{
    "account_id": "uuid",
    "account_subtype": "account_subtype",
    "account_type": "account_type",
    "account_details": [
        {
            "account_address": "account_address",
            "account_name": "account_name",
            "account_number": "account_number",
            "account_number_type": "account_number_type",
            "bank_identifier": "bank_identifier",
            "bank_identifier_type": "bank_identifier_type"
        },
        {
            "account_address": "account_address",
            "account_name": "account_name",
            "account_number": "account_number",
            "account_number_type": "account_number_type",
            "bank_identifier": "bank_identifier",
            "bank_identifier_type": "bank_identifier_type"
        }
    ],
    "currency": "currency",
    "status": "account_status"
}
```

This model is a representation of account data associated with an Account.

**Fields**

<ResponseField name="account_address" type="string">
  The address of the account. Always present.
</ResponseField>

<ResponseField name="account_name" type="string">
  The name or names of the account owner(s) represented at an account level. Always present.
</ResponseField>

<ResponseField name="account_number" type="string">
  The number of the account. Always present.
</ResponseField>

<ResponseField name="account_number_type" type="string">
  The [`AccountNumberType`](#accountnumbertype) of the account number. Always present.
</ResponseField>

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

<ResponseField name="bank_identifier_type" type="string">
  The [`BankIdentifierType`](#bankidentifiertype) of the bank identifier. Always present.
</ResponseField>

## AccountStatus

This is an enumeration of the statuses of an account.

**Values**

| Value | Description |
| - | - |
| `Enabled` | Account is enabled. |
| `Disabled` | Account is disabled. |

## CurrencyAccount

```json theme={null}
{
  "account_id": "int",
  "currency": "currency"
}
```

This model is a simplified representation of a currency account, used primarily for filtering and selection purposes.

**Fields**

<ResponseField name="account_id" type="integer">
  The numeric ID of the currency account. Always present.
</ResponseField>

<ResponseField name="currency" type="string">
  The ISO 4217 currency code for the account (e.g., "GBP", "EUR", "USD"). Always present.
</ResponseField>

## AccountType

This is an enumeration of the types of an account.

**Values**

| Value | Description |
| - | - |
| `Personal` | Individual account. |
| `Business` | Corporate account. |

## AccountSubType

This is an enumeration of sub types of an account (product family group).

**Values**

| Value | Description |
| - | - |
| `EMoney` | |

## AccountNumberType

This is an enumeration of number types of an account.

**Values**

| Value | Description |
| - | - |
| `IBAN` | |
| `BBAN` | |

## BankIdentifierType

This is an enumeration of bank identifier types, to comply with ISO20022 `code`s related to [Clearing System Identification](https://www.iso20022.org/sites/default/files/2020-05/ExternalCodeSets_1Q2020_February2020_v1.xls), with the addition of `SWBIC` for swift international payments.

**Values**

| Value | Description |
| - | - |
| `SWBIC` | Used for swift international payments. |
| *other* | Please refer to `ExternalClearingSystemIdentification1Code` inside [Clearing System Identification](https://www.iso20022.org/sites/default/files/2020-05/ExternalCodeSets_1Q2020_February2020_v1.xls) of ISO20022. |