Account

idstring<uuid>

internal ID of account

dataholderstring<uuid>required

internal ID of the data holder associated with this account

userstring<uuid>

ID of the user associated with this account

appstring

The app associated with this account

connectionstring<uuid>

internal ID of the connection associated with this account

currencyCurrencyrequired

ISO 4217 currency code

Example: USD, EUR, AUD, NZD

externalIdstring

external ID used by the account providers

statusAccountStatus

Possible values: [OPEN, CLOSED, ALL]

typeAccountTyperequired

Possible values: [PERSONAL, BUSINESS, UNSPECIFIED]

subtypeAccountSubtype

Possible values: [CHARGECARD, CREDITCARD, CURRENTACCOUNT, EMONEY, INVESTMENT, LOAN, OTHER, PENSION, MORTGAGE, PREPAIDCARD, SAVINGS, UNSPECIFIED]

namestring

nicknamestring

accountNumber object[]

Array [

schemeNumberSchemerequired

Possible values: [SORTCODE, IBAN, PAN, BIC, BBAN_SE, BBAN_DK, BBAN_NO, BECS, BSB_NO, MASKED, UNKNOWN, ABN, EMAIL, TELEPHONE, BPAY, ORG_ID]

numberstringrequired

]

Account
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataholder": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "app": "string",
  "connection": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": "USD, EUR, AUD, NZD",
  "externalId": "string",
  "status": "OPEN",
  "type": "PERSONAL",
  "subtype": "CHARGECARD",
  "name": "string",
  "nickname": "string",
  "accountNumber": [
    {
      "scheme": "SORTCODE",
      "number": "string"
    }
  ]
}