Bank of Ireland (UK) Statements API
The Statements API from Bank of Ireland (UK) — 5 operation(s) for statements.
Bank of Ireland (UK) Statements API is one of 35 APIs that Bank of Ireland (UK) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Statements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 5 paths, and defines 97 schemas. It is described by OpenAPI 3.2.0, at version 4.0.1.
Requests are made against a single base URL, /open-banking/v4.0/aisp.
5 operations
5 paths
97 schemas
5 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Bank of Ireland (UK) Statements API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope.
It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.
TPPOAuth2Security— TPP client credential authorisation flow with the ASPSPPSUOAuth2Security— OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.
Statements 5
GET
/accounts/{AccountId}/statements
Get Statements for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}
Get Statement by StatementId for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}/file
Get Statement file by StatementId for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Statement Transactions for an AccountId
GET
/statements
Get Statements
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are OBTransaction6 (32 properties), OBPostalAddress7 (18 properties), OBStatement2 (16 properties), OBCurrencyExchange5 (7 properties). Each schema is shown below with its type and property counts.
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
Room
string
Information that locates and identifies a room to form part of an address
OBInternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested. For a full list of values see OBInternalStatementInterestFrequency1Code in OBInternalCodeSet [here](https://github.…
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
UnitNumber
string
Number that identifies the unit of a specific address .
StreetName
string
Name of a street or thoroughfare.
OBInternalStatementBenefitType1Code
string
Benefit type, in a coded form. For a full list of values see OBInternalStatementBenefitType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/E…
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
File
object
BookingDateTime
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the st…
OBError1
object
4 properties
1 required
Meta
object
Meta Data relevant to the payload
3 properties
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
Floor
string
Number that identifies the level within a building
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
ExternalEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer. For a full list of enumeration values refer to ExternalEntryStatus1Code in ISOExternalCodeS…
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
Description_2
string
Description that may be available for the statement interest.
OBInternalStatementInterestRateType1Code
string
This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross).
OBInternalStatementRateType1Code
string
Statement rate type, in a coded form. For a full list of values see OBInternalStatementRateType1Code in OBInternalCodeSet [here](https://github.com/OpenBanking…
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBInternalStatementAmountType1Code
string
Amount type, in a coded form.
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry. For a full list of enumeration values refer to OBInternalCreditDebitCode in OBInternalCodeSet […
OBReadStatement2
object
3 properties
1 required
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code in ISOExtern…
OBInternalStatementDateTimeType1Code
string
Date time type, in a coded form. For a full list of values see OBInternalStatementDateTimeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingU…
OBInternalStatementInterestType1Code
string
Interest amount type, in a coded form. For a full list of values see OBInternalStatementInterestType1Code in OBInternalCodeSet [here](https://github.com/OpenBa…
Value
string
Value associated with the statement value type.
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. For a full list of values see OBInternalCreditDebitCode in OBInternalCodeSet [here](https://github.com/Ope…
OBInternalTransactionMutability1Code
string
Specifies the Mutability of the Transaction record. For a full list of enumeration values refer to OBInternalTransactionMutability1Code in OBInternalCodeSet [h…
Name_0
string
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 n…
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
BuildingName
string
Name of a referenced building.
OBInternalStatementFeeType1Code
string
Fee type, in a coded form. For a full list of values see OBInternalStatementFeeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For more information and a full list of values see Ex…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction. For a full list of enumeration values refer to OBInternalCardSchemeType1Code in OBInte…
4 properties
1 required
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OBReadDataTransaction6
object
1 property
OBTransactionCashBalance
object
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied…
3 properties
3 required
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
OBInternalStatementValueType1Code
string
Statement value type, in a coded form. For a full list of values see OBInternalStatementValueType1Code in OBInternalCodeSet [here](https://github.com/OpenBanki…
TransactionId
string
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
Rate
string
Rate associated with the statement rate type.
OBInternalStatementFeeRateType1Code
string
This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see OBInternalStatementFeeRateType1Code in OBInternalCodeSet [her…
OBStatement2
object
Provides further details on a statement resource.
16 properties
5 required
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBBalanceType1Code
string
Balance type, in a coded form. For a full list of enumeration values refer to ExternalBalanceType1Code in ISOExternalCodeSet [here](https://github.com/OpenBank…
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…
ActiveOrHistoricCurrencyCode_1
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBExtendedProprietaryBankTransactionCode
object
Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
3 properties
1 required
DateTime
string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in response…
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
LEI
string
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 "Finan…
OBReadTransaction6
object
3 properties
1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
OBTransaction6
object
Provides further details on an entry in the report.
32 properties
5 required
StartDateTime
string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respon…
OBRate1_1
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
TransactionReference
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
CreationDateTime
string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
ValueDateTime
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit…
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
5 properties
EndDateTime
string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in response…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties
2 required
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement benefit type.
2 properties
2 required
OBCreditDebitCode_2
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. For a full list of enumeration values…
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
5 properties
OBReadDataStatement2
object
1 property
OBIntermediaryAgent
object
The intermediary agent associated with this transaction.
6 properties
Description_1
string
Description that may be available for the statement fee.
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
OBInternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account. For a full list of values see OBInternalStatementFeeFrequency1Code in OBInternalCodeSet [here](https://github…
OBExternalPurpose1Code
string
For a full list of enumeration values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
5 properties
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
StatementId
string
Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable.
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
5 properties
OBInternalStatementType1Code
string
Statement type, in a coded form. For a full list of values see OBInternalStatementType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bank of Ireland (UK) 12
Other APIs Bank of Ireland (UK) publishes across the network.
Bank of Ireland (UK) Dynamic Client Registration API
Bank of Ireland (UK) Account Access Consents API
Bank of Ireland (UK) Accounts API
Bank of Ireland (UK) ATM API
Bank of Ireland (UK) Balances API
Bank of Ireland (UK) BCA API
Bank of Ireland (UK) Beneficiaries API
Bank of Ireland (UK) Branch API
Bank of Ireland (UK) CCC API
Bank of Ireland (UK) Direct Debits API
Bank of Ireland (UK) Domestic Payment Consents API
Bank of Ireland (UK) Domestic Payments API
#Statements
Where this information came from
This is an independent, third-party profile of Bank of Ireland (UK) Statements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.