# Accounts - v4.0

Overview
Endpoints
- GET /accounts
- GET /accounts/{AccountId}
Data Model
Usage Examples

# Overview

The accounts resource is used by an AISP to retrieve full list of accounts and account infromation that the PSU has authorised to access.

This resource description should be read in conjunction with a compatible Account Information Services API Profile.

# Endpoints

Endpoints for the resource - and available methods.

	Resource	HTTP Operation	Endpoint	Mandatory?	Scope	Grant Type	Idempotency Key	Parameters	Request Object	Response Object
1	accounts	GET	GET /accounts	Mandatory	accounts	Authorization Code	No	Pagination		OBReadAccount6
2	accounts	GET	GET /accounts/{AccountId}	Mandatory	accounts	Authorization Code	No			OBReadAccount6

# GET /accounts

First Step The first step for an AISP after an account-request is authorised - is to call the GET /accounts endpoint.

An AISP will be given the full list of accounts (the AccountId(s)) that the PSU has authorised the AISP to access. The AccountId(s) returned may then be used to retrieve other resources for a specific AccountId. The selection of authorised accounts happens only at the ASPSP's interface.

# GET /accounts/{AccountId}

An AISP may retrieve the account information resources for the AccountId (which is retrieved in the call to GET /accounts).

# Data Model

The OBReadAccount6 object will be used for the call to:

GET /accounts/{AccountId}
GET /accounts

# Resource Definition

This resource represents the account to which credit and debit entries are made. Each account resource will have a unique and immutable AccountId.

# UML Diagram

OBReadAccount6

# Notes

The Account and Servicer structure has been designed to:
- Reflect the DebtorAccount and DebtorAgent (and similarly for CreditorAccount and CreditorAgent) structures in the PISP use case.
- Having a SchemeName for the Account and Servicer blocks means we can be flexible to accommodate multiple types of accounts.
For common Domestic UK identification schemes:
- Account/Account
  - Where "UK.OBIE.SortCodeAccountNumber" is specified as the SchemeName, the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field).
  - Where "UK.OBIE.IBAN" is specified as the SchemeName, the Identification field must be populated with the full IBAN.
  - Where "UK.OBIE.PAN" is specified as the SchemeName, the Identification field must be populated with the primary PAN linked to the account. An ASPSP may choose to mask digits returned in the Identification field.
- Account/Servicer
  - Where "UK.OBIE.BICFI" is populated as the SchemeName, the Identification field must be populated with the BIC.
The SecondaryIdentification field is used to identify an account in addition to the primary Account/Identification field. SecondaryIdentification may be populated with a roll number for building societies, or a currency code where an account has multiple currency sub-accounts.
The SwitchStatus field is used to indicate that an account is undergoing an account switch.
- An ASPSP may populate this field with the value UK.CASS.NotSwitched to indicate that the account has not been switched.
- Once an account switch has been completed, an ASPSP may populate this field with the value UK.CASS.SwitchCompleted
The following fields are optional only for accounts that are switched. For all other accounts, the fields must be populated by the ASPSP.
- Data.Currency
- Data.AccountCategory
- Data.AccountTypeCode

# Permission Codes

The resource differs depending on the permissions (ReadAccountsBasic and ReadAccountsDetail) used to access the resource. In the event that the resource is accessed with both ReadAccountsBasic and ReadAccountsDetail, the most detailed level (ReadAccountsDetail) must be used.

These objects must not be returned without the ReadAccountsDetail permission:
- OBReadAccount6/Data/Account/Account
- OBReadAccount6/Data/Account/Servicer
- OBReadAccount6/Data/Account/StatementFrequencyAndFormat
If the ReadAccountsDetail is granted by the PSU:
- OBReadAccount6/Data/Account/Account must be returned (1..*)
- OBReadAccount6/Data/Account/Servicer may be returned if applicable to the account and ASPSP (0..1)
- OBReadAccount6/Data/Account/StatementFrequencyAndFormat may be returned (0..*)

If the ReadPAN permission is granted by the PSU, the ASPSP may choose to populate the OBReadAccount6/Data/Account/Account/Identification with the unmasked PAN (if the PAN is being populated in the response).

# Data Dictionary

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes	Pattern
OBReadAccount6		OBReadAccount6		OBReadAccount6
Data	1..1	OBReadAccount6/Data		OBReadDataAccount5
Account	0..*	OBReadAccount6/Data/Account	Unambiguous identification of the account to which credit and debit entries are made.	OBAccount6
AccountId	1..1	OBReadAccount6/Data/Account/AccountId	A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.	Max40Text
Status	0..1	OBReadAccount6/Data/Account/Status	Specifies the status of account resource in code form.	For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window).	OBInternalAccountStatus1Code
StatusUpdateDateTime	0..1	OBReadAccount6/Data/Account/StatusUpdateDateTime	Date and time at which the resource status was updated.	ISODateTime
Currency	0..1	OBReadAccount6/Data/Account/Currency	Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.	ActiveOrHistoricCurrencyCode		^[A-Z]{3,3}$
AccountCategory	0..1	OBReadAccount6/Data/Account/AccountCategory	Specifies the type of account (personal or business).	For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window)	OBInternalAccountType1Code
AccountTypeCode	0..1	OBReadAccount6/Data/Account/AccountTypeCode	Specifies the sub type of account (product family group)	For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window)	OBExternalCashAccountType1Code
Description	0..1	OBReadAccount6/Data/Account/Description	Specifies the description of the account type.	Max35Text
Nickname	0..1	OBReadAccount6/Data/Account/Nickname	The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.	Max70Text
OpeningDate	0..1	OBReadAccount6/Data/Account/OpeningDate	Date on which the account and related basic services are effectively operational for the account owner.	ISODate
MaturityDate	0..1	OBReadAccount6/Data/Account/MaturityDate	Maturity date for the account.	ISODate
SwitchStatus	0..1	OBReadAccount6/Data/Account/SwitchStatus	The switch status for the account.	For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window)	OBInternalSwitchStatusCode
Account	0..*	OBReadAccount6/Data/Account/Account	Provides the details to identify an account.	OBCashAccount5
SchemeName	1..1	OBReadAccount6/Data/Account/Account/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window).	OBInternalAccountIdentification4Code
Identification	1..1	OBReadAccount6/Data/Account/Account/Identification	Identification assigned by an institution to identify an account. This identification is known by the account owner.	Max256Text
Name	0..1	OBReadAccount6/Data/Account/Account/Name	The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.	Max350Text
SecondaryIdentification	0..1	OBReadAccount6/Data/Account/Account/SecondaryIdentification	This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).	Max34Text
LEI	0..1	OBReadAccount6/Data/Account/Account/LEI	Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".	Max20Text		[A-Z0-9]{18,18}[0-9]{2,2}
StatementFrequencyAndFormat	0..*	OBReadAccount6/Data/Account/StatementFrequencyAndFormat	The frequency and format of the statements delivered for the account	StatementFrequencyAndFormat
DeliveryAddress	0..1	OBReadAccount6/Data/Account/StatementFrequencyAndFormat/DeliveryAddress	The address the statement is delivered to	OBPostalAddress7
Frequency	0..1	OBReadAccount6/Data/Account/StatementFrequencyAndFormat/Frequency		For a full list of enumeration values refer to `OB_Internal_CodeSet` here (opens new window)	OBFrequency2Code
CommunicationMethod	0..1	OBReadAccount6/Data/Account/StatementFrequencyAndFormat/CommunicationMethod		For a full list of enumeration values refer to `External_CodeSet` here (opens new window)	OBExternalCommunicationMethod2Code
Format	0..1	OBReadAccount6/Data/Account/StatementFrequencyAndFormat/Format		For a full list of enumeration values refer to `External_CodeSet` here (opens new window)	ExternalDocumentFormat1Code
Servicer	0..1	OBReadAccount6/Data/Account/Servicer	Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.	OBBranchAndFinancialInstitutionIdentification5
Name	0..1	OBReadAccount6/Data/Account/Servicer/Name	Name of Service User.	Max140Text
SchemeName	1..1	OBReadAccount6/Data/Account/Servicer/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	For a full list of enumeration values refer to `Internal_CodeSet` here (opens new window)	OBInternalFinancialInstitutionIdentification4Code
Identification	1..1	OBReadAccount6/Data/Account/Servicer/Identification	Unique and unambiguous identification of the servicing institution.	Max35Text

# Reused Classes

# OBPostalAddress7

The OBPostalAddress7 class is defined in the payment-initiation-api-profile page

# Usage Examples

# Bulk - Detail Permission

The call to GET /accounts is the first step after an account-request is authorised. This will allow the AISP to discover which accounts (and AccountId values) are associated with the authorisation of consent. In this scenario, AccountId 22289 has a building society roll number; and AccountId 31820 does not. The ReadAccountsDetail permission has been granted.

# Get Accounts Request

GET /accounts HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

# Get Accounts Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Status": "Enabled",
        "MaturityDate": "2019-01-01T06:06:06+00:00",
        "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Description" :  "For paying bills",
        "Nickname": "Bills",
        "OpeningDate": "01-05-2002",
        "SwitchStatus": "UK.CASS.NotSwitched",
        "StatementFrequencyAndFormat": [
          {
            "Frequency": "YEAR",
            "CommunicationMethod": "EMAL",
            "Format": "DPDF",
            "DeliveryAddress": {
              "AddressType": "HOME",
              "StreetName": "Bank Street",
              "BuildingNumber": "11",
              "Floor": "6",
              "PostCode": "Z78 4TY",
              "TownName": "London",
              "Country": "UK"
            }
          }
        ],
        "Servicer": {
          "SchemeName": "UK.OBIE.BICFI",
          "Identification": "8020441910203345",
          "Name": "ServicerName"
        },
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021",
            "LEI": "9193001QZMP2PQT4AK86"
          }
        ]
      },
      {
        "AccountId": "31820",
        "Status": "Enabled",
        "StatusUpdateDateTime": "2018-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Nickname": "Household",
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203348",
            "Name": "Mr Kevin"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/accounts/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

# Specific Account - Detail Permission

An AISP may also retrieve the account resource details specifically for AccountId 22289. The ReadAccountsDetail permission has been granted.

# Get Accounts Request

GET /accounts/22289 HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

# Get Accounts Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Status": "Enabled",
        "MaturityDate": "2019-01-01T06:06:06+00:00",
        "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "Description" :  "For paying bills",
        "AccountTypeCode": "CACC",
        "Nickname": "Bills",
        "OpeningDate": "01-05-2002",
        "SwitchStatus": "UK.CASS.NotSwitched",
        "StatementFrequencyAndFormat": [
          {
            "Frequency": "YEAR",
            "CommunicationMethod": "EMAL",
            "Format": "DPDF",
            "DeliveryAddress": {
              "AddressType": "BIZZ",
              "StreetName": "Bank Street",
              "BuildingNumber": "11",
              "Floor": "6",
              "PostCode": "Z78 4TY",
              "TownName": "London",
              "Country": "UK"
            }
          }
        ],
        "Servicer": {
          "SchemeName": "UK.OBIE.BICFI",
          "Identification": "8020441910203345",
          "Name": "ServicerName"
        },
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021",
            "LEI": "9193001QZMP2PQT4AK86"
          }
        ]
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289"
  },
  "Meta": {
    "TotalPages": 1
  }
}

# Bulk - Basic Permission

The ReadAccountsBasic permission has been granted.

# Get Accounts Request

GET /accounts HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-auth-date:  Sun, 10 Sep 2017 19:43:31 GMT
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json

# Get Accounts Response

HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json

{
  "Data": {
    "Account": [
      {
        "AccountId": "22289",
        "Status": "Enabled",
        "MaturityDate": "2019-01-01T06:06:06+00:00",
        "StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Description" :  "For paying bills",
        "Nickname": "Bills",
        "OpeningDate": "01-05-2002",
        "SwitchStatus": "UK.CASS.NotSwitched",
        "StatementFrequencyAndFormat": [
          {
            "Frequency": "YEAR",
            "CommunicationMethod": "EMAL",
            "Format": "DPDF",
            "DeliveryAddress": {
              "AddressType": "HOME",
              "StreetName": "Bank Street",
              "BuildingNumber": "11",
              "Floor": "6",
              "PostCode": "Z78 4TY",
              "TownName": "London",
              "Country": "UK"
            }
          }
        ],
        "Servicer": {
          "SchemeName": "UK.OBIE.BICFI",
          "Identification": "8020441910203345",
          "Name": "ServicerName"
        },
        "Account": [
          {
            "SchemeName": "UK.OBIE.SortCodeAccountNumber",
            "Identification": "80200110203345",
            "Name": "Mr Kevin",
            "SecondaryIdentification": "00021",
            "LEI": "9193001QZMP2PQT4AK86"
          }
        ]
      },
      {
        "AccountId": "31820",
        "Status": "Enabled",
        "StatusUpdateDateTime": "2018-01-01T06:06:06+00:00",
        "Currency": "GBP",
        "AccountCategory": "Personal",
        "AccountTypeCode": "CACC",
        "Nickname": "Household"
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v4.0/aisp/accounts/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

← Account Access Consents Balances→