How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yorkshire Building Society Statements API

The Statements API from Yorkshire Building Society — 4 operation(s) for statements.

Yorkshire Building Society Statements API is one of 24 APIs that Yorkshire Building Society 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, an API reference, and a getting-started guide.

This API exposes 4 operations across 4 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version v3.1.2.

Requests are made against a single base URL, https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp.

4 operations 4 paths 43 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3.1.2
Base URL
https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Yorkshire Building Society 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 ASPSP
  • PSUOAuth2Security — 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 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Statements 4
GET
/accounts/{AccountId}/statements
Get Statements
GetAccountsAccountIdStatements 7 params → 200400401403404405406429
GET
/accounts/{AccountId}/statements/{StatementId}
Get Statements
GetAccountsAccountIdStatementsStatementId 6 params → 200400401403404405406429
GET
/accounts/{AccountId}/statements/{StatementId}/file
Get Statements
GetAccountsAccountIdStatementsStatementIdFile 6 params → 200400401403404405406429
GET
/statements
Get Statements
GetStatements 6 params → 200400401403404405406429

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are OBStatement2Detail (15 properties), OBStatement2Basic (14 properties), Links (5 properties), OBError1 (4 properties). Each schema is shown below with its type and property counts.

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…
OBReadStatement2
object
3 properties 1 required
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 responses…
OBStatement2Basic
object
Provides further details on a statement resource.
14 properties 5 required
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.
Meta
object
Meta Data relevant to the payload
3 properties
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 responses…
OBExternalStatementRateType1Code
string
Rate associated with the statement rate type.
OBRate1_1
number
field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
Type_1
string
Statement value type, in a coded form.
File
object
Description_1
string
Description that may be available for the statement fee.
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:…
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
Links
object
Links relevant to the payload
5 properties 1 required
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement interest amount type.
2 properties 2 required
OBExternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account.
OBActiveOrHistoricCurrencyAndAmount_4
object
Amount of money associated with the statement fee type.
2 properties 2 required
OBExternalStatementFeeType1Code
string
Fee type, in a coded form.
OBExternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBStatement2
OBExternalStatementType1Code
string
Statement type, in a coded form.
OBExternalStatementInterestRateType1Code
string
Description that may be available for the statement Interest rate type.
Type_0
string
Statement rate type, in a coded form.
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 respons…
OBExternalStatementFeeRateType1Code
string
Description that may be available for the statement fee rate type.
OBActiveOrHistoricCurrencyAndAmount_3
object
Amount of money associated with the statement benefit type.
2 properties 2 required
OBExternalStatementInterestType1Code
string
Interest amount type, in a coded form.
OBStatement2Detail
object
Provides further details on a statement resource.
15 properties 5 required
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the amount type.
2 properties 2 required
Description_2
string
Description that may be available for the statement interest.
OBError1
object
4 properties 2 required
StatementId
string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
OBExternalStatementAmountType1Code
string
Amount type, in a coded form.
OBReadDataStatement2
object
1 property
OBExternalStatementBenefitType1Code
string
Benefit type, in a coded form.
OBExternalStatementDateTimeType1Code
string
Date time type, in a coded form.
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…
OBExternalStatementValueType1Code
string
Value associated with the statement value type.
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-statements-api-openapi.yml Raw ↑

Other APIs Yorkshire Building Society publishes across the network.

Yorkshire Building Society Dynamic Client Registration API
Yorkshire Building Society Generate Access Token API
Yorkshire Building Society Account Access API
Yorkshire Building Society Accounts API
Yorkshire Building Society Balances API
Yorkshire Building Society Beneficiaries API
Yorkshire Building Society Direct Debits API
Yorkshire Building Society Domestic Payments API
Yorkshire Building Society Domestic Scheduled Payments API
Yorkshire Building Society Domestic Standing Orders API
Yorkshire Building Society Event Subscriptions API
Yorkshire Building Society File Payments API
Where this information came from

This is an independent, third-party profile of Yorkshire Building Society 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.