Page Properties

hidden	true

Resource	accounts
Endpoints	GET /accounts GET /accounts/{AccountId}
Mandatory?	Mandatory Mandatory
SortOrder	02

Table of Contents

outline	true
style	none

Version Control

Version	Date	Author	Comments
3.0	07 Sep 2018	OB R/W API Team	This is the baseline version. No change from RC3.
3.1-draft1	11 Sep 2018	OB R/W API Team	This is the initial draft version for 3.1. Errata Grammatical Fixes
3.1-draft2	05 Oct 2018	OB R/W API Team	Draft2 Changes: Updated example URLs to version 3.1.
3.1-draft3	18 Oct 2018	OB R/W API Team	Draft3 Changes: Account Data Model updated with a typed field for Account/SchemeName and Agent/SchemeName field to reference in Namespaced Enumerations page.
3.1 RC1	14 Nov 2018	OB R/W API Team	RC1 Changes: Updated enumerations to use full UK.OBIE namespace.
3.1	30 Nov 2018	OB R/W API Team	Version 3.1 final release. No changes from Version 3.1 RC1.

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

GET /accounts

Info

title	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 OBReadAccount3 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 "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.

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:
- OBReadAccount3/Data/Account/Account
- OBReadAccount3/Data/Account/Servicer
If the ReadAccountsDetail is granted by the PSU:
- OBReadAccount3/Data/Account/Account must be returned (1..n)
- OBReadAccount3/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 OBReadAccount3/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
OBReadAccount3		OBReadAccount3		OBReadAccount3
Data	1..1	OBReadAccount3/Data		OBReadDataAccount3
Account	0..n	OBReadAccount3/Data/Account	Unambiguous identification of the account to which credit and debit entries are made.	OBAccount3
AccountId	1..1	OBReadAccount3/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	OBReadAccount3/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	OBReadAccount3/Data/Account/AccountType	Specifies the type of account (personal or business).	OBExternalAccountType1Code	Business Personal
AccountSubType	1..1	OBReadAccount3/Data/Account/AccountSubType	Specifies the sub type of account (product family group).	OBExternalAccountSubType1Code	ChargeCard CreditCard CurrentAccount EMoney Loan Mortgage PrePaidCard Savings
Description	0..1	OBReadAccount3/Data/Account/Description	Specifies the description of the account type.	Max35Text
Nickname	0..1	OBReadAccount3/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	OBReadAccount3/Data/Account/Account	Provides the details to identify an account.	OBCashAccount5
SchemeName	1..1	OBReadAccount3/Data/Account/Account/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	OBExternalAccountIdentification4Code
Identification	1..1	OBReadAccount3/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	OBReadAccount3/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	OBReadAccount3/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	OBReadAccount3/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
SchemeName	1..1	OBReadAccount3/Data/Account/Servicer/SchemeName	Name of the identification scheme, in a coded form as published in an external list.	OBExternalFinancialInstitutionIdentification4Code
Identification	1..1	OBReadAccount3/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

Code Block

language	js
theme	Midnight
title	Get Accounts Request
linenumbers	true

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

Code Block

language	js
theme	Midnight
title	Get Accounts Response
linenumbers	true

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/v3.1/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.

Request

Code Block

language	js
theme	Midnight
title	Get Accounts Request
linenumbers	true

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

Code Block

language	js
theme	Midnight
title	Get Accounts Response
linenumbers	true

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/v3.1/aisp/accounts/22289"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Bulk - Basic Permission

The ReadAccountsBasic permission has been granted.

Request

Code Block

language	js
theme	Midnight
title	Get Accounts Request
linenumbers	true

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

Code Block

language	js
theme	Midnight
title	Get Accounts Response
linenumbers	true

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/v3.1/aisp/accounts/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Versions Compared

Old Version 1

New Version Current

Key

Version Control

Endpoints

GET /accounts

GET /accounts/{AccountId}

Data Model

Resource Definition

UML Diagram

Permission Codes

Data Dictionary

Usage Examples

Bulk - Detail Permission

Specific Account - Detail Permission

Bulk - Basic Permission

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Version Control

Endpoints

GET /accounts

GET /accounts/{AccountId}

Data Model

Resource Definition

UML Diagram

Permission Codes

Data Dictionary

Usage Examples

Bulk - Detail Permission

Specific Account - Detail Permission

Bulk - Basic Permission