1 Version Control
2 Endpoints
- 2.1 GET /accounts
- 2.2 GET /accounts/{AccountId}
3 Data Model
- 3.1 Resource Definition
- 3.2 UML Diagram
- 3.3 Permission Codes
- 3.4 Data Dictionary
4 Usage Examples
- 4.1 Bulk - Detail Permission
  - 4.1.1 Get Accounts Request
  - 4.1.2 Get Accounts Response
- 4.2 Specific Account - Detail Permission
  - 4.2.1 Get Accounts Request
  - 4.2.2 Get Accounts Response
- 4.3 Bulk - Basic Permission
  - 4.3.1 Get Accounts Request
  - 4.3.2 Get Accounts Response

Version Control

Version	Date	Author	Comments

Version	Date	Author	Comments
3.0-draft1	18-Apr-2018	OB R/W API Team	Initial draft for Version 3.0 Moved enumerations up to parent document
3.0-draft4	Jun 4, 2018	OB R/W API Team	Clarified use of Idempotency Key in endpoint table.
3.0-draft5	Jun 13, 2018	OB R/W API Team	Draft5 changes: Updated examples to change UTC to GMT to be in line with https://tools.ietf.org/html/rfc7231#page-66 P21 changes: Genericised guidelines on UK domestic identification schemes. Internationalisation for the Servicer object. SchemeName updated to Max40Text - so that additional schemes can be agreed and specified outside of the OB standard. Internationalisation for the Account object. SchemeName updated to Max40Text - so that additional schemes can be agreed and specified outside of the OB standard. Identification updated to Max256Text - so that schemes that require an email address can be accommodated.
3.0-draft6/rc1	Jun 27, 2018	OB R/W API Team	Draft6 Changes: Clarified how the ReadPAN permission affects the resource. Updated definition of Name field in the Account object for clarity. Have specified usage that it is "The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account." Updated Usage Examples to reflect namespacing for the SchemeName
3.0-draft7	Jul 17, 2018	OB R/W API Team	No Change
3.0-RC2	Jul 19, 2018	OB R/W API Team	No Change
3.0-RC3	Aug 6, 2018	OB R/W API Team	No Change
3.0	Sep 7, 2018	OB R/W API Team	This is the baseline version. No change from RC3.

Endpoints

Endpoints for the resource - and available methods.

	Resource	HTTP Operation	Endpoint	Mandatory?	Scope	Grant Type	Idempotency Key	Parameters	Request Object	Response Object

	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		OBReadAccount2
2	accounts	GET	GET /accounts/{AccountId}	Mandatory	accounts	Authorization Code	No			OBReadAccount2

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 OBReadAccount2 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

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 "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 "IBAN" is specified as the SchemeName, the Identification field must be populated with the full IBAN
  - Where "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 "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.

Permission Codes

The resource differs depending on the permissions (ReadAccountsBasic and ReadAccountsDetail) used to access resource. In the event 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:
- OBReadAccount2/Data/Account/Account
- OBReadAccount2/Data/Account/Servicer
If the ReadAccountsDetail is granted by the PSU:
- OBReadAccount2/Data/Account/Account must be returned (1..n)
- OBReadAccount2/Data/Account/Servicer may be returned if applicable to the account and ASPSP (0..1)

If the ReadPAN permission is granted by the PSU - the ASPSP may choose to populate the OBReadAccount2/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

Name	Occurrence	XPath	EnhancedDefinition	Class	Codes
OBReadAccount2		OBReadAccount2		OBReadAccount2
Data	1..1	OBReadAccount2/Data		OBReadDataAccount2
Account	0..n	OBReadAccount2/Data/Account	Unambiguous identification of the account to which credit and debit entries are made.	OBAccount2
AccountId	1..1	OBReadAccount2/Data/Account/AccountId	A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.	Max40Text
Currency	1..1	OBReadAccount2/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}$
AccountType	1..1	OBReadAccount2/Data/Account/AccountType	Specifies the type of account (personal or business).	OBExternalAccountType1Code	Business Personal
AccountSubType	1..1	OBReadAccount2/Data/Account/AccountSubType	Specifies the sub type of account (product family group).	OBExternalAccountSubType1Code	ChargeCard CreditCard CurrentAccount EMoney Loan Mortgage PrePaidCard Savings
Description	0..1	OBReadAccount2/Data/Account/Description	Specifies the description of the account type.	Max35Text
Nickname	0..1	OBReadAccount2/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
Account	0..n	OBReadAccount2/Data/Account/Account	Provides the details to identify an account.	OBCashAccount3
SchemeName	1..1	OBReadAccount2/Data/Account/Account/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	Max40Text
Identification	1..1	OBReadAccount2/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	OBReadAccount2/Data/Account/Account/Name	Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.	Max70Text
SecondaryIdentification	0..1	OBReadAccount2/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
Servicer	0..1	OBReadAccount2/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.	OBBranchAndFinancialInstitutionIdentification4
SchemeName	1..1	OBReadAccount2/Data/Account/Servicer/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	Max40Text
Identification	1..1	OBReadAccount2/Data/Account/Servicer/Identification	Unique and unambiguous identification of the servicing institution.	Max35Text

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.

Request

Get Accounts Request

GET /accounts HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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

Response

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",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Nickname": "Bills",
        "Account": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "80200110203345",
          "Name": "Mr Kevin",
          "SecondaryIdentification": "00021"
        }
      },
      {
        "AccountId": "31820",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Nickname": "Household",
        "Account": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "80200110203348",
          "Name": "Mr Kevin"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/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.

Request

Get Accounts Request

GET /accounts/22289 HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time: 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

Response

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",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Nickname": "Bills",
        "Account": {
          "SchemeName": "UK.OBIE.SortCodeAccountNumber",
          "Identification": "80200110203345",
          "Name": "Mr Kevin",
          "SecondaryIdentification": "00021"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/22289"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Bulk - Basic Permission

The ReadAccountsBasic permission has been granted.

Request

Get Accounts Request

GET /accounts HTTP/1.1
Authorization: Bearer Az90SAOJklae
x-fapi-financial-id: OB/2017/001
x-fapi-customer-last-logged-time:  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

Response

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",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Nickname": "Bills"
      },
      {
        "AccountId": "31820",
        "Currency": "GBP",
        "AccountType": "Personal",
        "AccountSubType": "CurrentAccount",
        "Nickname": "Household"
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Accounts v3.0

Version Control

Endpoints

GET /accounts

GET /accounts/{AccountId}

Data Model

Resource Definition

UML Diagram

Permission Codes

Data Dictionary

Usage Examples

Bulk - Detail Permission

Get Accounts Request

Get Accounts Response

Specific Account - Detail Permission

Get Accounts Request

Get Accounts Response

Bulk - Basic Permission

Get Accounts Request

Get Accounts Response