Yorkshire Building Society Account Information API
OBIE Read/Write Account and Transaction Information (AISP) API v3.1.2 - lets FCA-authorised account information service providers retrieve account, balance, transaction, beneficiary, standing order, direct debit, product, party and statement data for consenting YBS and Chelsea Building Society payment-account customers. FAPI-secured (OAuth2/OIDC, mTLS, PSD2 SCA).
Yorkshire Building Society Account Information API is one of 6 APIs that Yorkshire Building Society publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account Information, AISP, and Open Banking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 29 operations across 28 paths, organized into 12 resource areas, and defines 199 schemas. It is described by OpenAPI 3.0.1, at version v3.1.2.
Requests are made against the base URL https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp.
29 operations
28 paths
199 schemas
1 DELETE27 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Yorkshire Building Society Account Information 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 29
Across 28 paths, the API surfaces 29 operations — 1 DELETE, 27 GET, 1 POST. They span 12 resource areas, including Account Access, Accounts, Balances, Beneficiaries, Direct Debits, Offers, Parties, Products, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Account Access 3
POST
/account-access-consents
Create Account Access Consents
GET
/account-access-consents/{ConsentId}
Get Account Access Consents
DELETE
/account-access-consents/{ConsentId}
Delete Account Access Consents
Accounts 2
GET
/accounts
Get Accounts
GET
/accounts/{AccountId}
Get Accounts
Balances 2
GET
/accounts/{AccountId}/balances
Get Balances
GET
/balances
Get Balances
Beneficiaries 2
GET
/accounts/{AccountId}/beneficiaries
Get Beneficiaries
GET
/beneficiaries
Get Beneficiaries
Direct Debits 2
GET
/accounts/{AccountId}/direct-debits
Get Direct Debits
GET
/direct-debits
Get Direct Debits
Offers 2
GET
/accounts/{AccountId}/offers
Get Offers
GET
/offers
Get Offers
Parties 3
GET
/accounts/{AccountId}/parties
Get Parties
GET
/accounts/{AccountId}/party
Get Parties
GET
/party
Get Parties
Products 2
GET
/accounts/{AccountId}/product
Get Products
GET
/products
Get Products
Scheduled Payments 2
GET
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments
GET
/scheduled-payments
Get Scheduled Payments
Standing Orders 2
GET
/accounts/{AccountId}/standing-orders
Get Standing Orders
GET
/standing-orders
Get Standing Orders
Statements 4
GET
/accounts/{AccountId}/statements
Get Statements
GET
/accounts/{AccountId}/statements/{StatementId}
Get Statements
GET
/accounts/{AccountId}/statements/{StatementId}/file
Get Statements
GET
/statements
Get Statements
Transactions 3
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Transactions
GET
/accounts/{AccountId}/transactions
Get Transactions
GET
/transactions
Get Transactions
Schemas 199
The contract defines 199 schemas that model the data the API accepts and returns. The most detailed are OBTransaction5Detail (23 properties), OBTransaction5Basic (16 properties), OBStatement2Detail (15 properties), OBStandingOrder4Detail (14 properties). Each schema is shown below with its type and property counts.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
ActiveOrHistoricCurrencyCode_0
string
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 currenc…
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…
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
BeneficiaryId
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
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…
BuildingNumber
string
Number that identifies the position of a building on a street.
CountryCode
string
Nation with its own government, occupying a particular territory.
CountrySubDivision
string
Identifies a subdivision of a country eg, state, region, county.
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…
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…
Description_0
string
Specifies the description of the account type.
Description_1
string
Description that may be available for the statement fee.
Description_2
string
Description that may be available for the statement interest.
Description_3
string
Description to describe the purpose of the code
EmailAddress
string
Address for electronic mail (e-mail).
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…
File
object
FinalPaymentDateTime
string
The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All…
FirstPaymentDateTime
string
The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All…
Frequency_0
string
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the we…
Frequency_1
string
Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the we…
FullLegalName
string
Specifies a character string with a maximum length of 350 characters.
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:…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Links
object
Links relevant to the payload
5 properties
1 required
Meta
object
Meta Data relevant to the payload
3 properties
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…
Name_1
string
Name by which a party is known and which is usually used to identify that party.
Name_2
string
Name by which an agent is known and which is usually used to identify that agent.
Name_3
string
Long name associated with the code
NextPaymentDateTime
string
The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All…
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
Number_0
integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the…
Number_1
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
OBAccount3
OBAccount3Basic
object
Unambiguous identification of the account to which credit and debit entries are made.
6 properties
4 required
OBAccount3Detail
object
Unambiguous identification of the account to which credit and debit entries are made.
8 properties
5 required
OBAccount4
OBAccount4Basic
object
Unambiguous identification of the account to which credit and debit entries are made.
8 properties
4 required
OBAccount4Detail
object
Unambiguous identification of the account to which credit and debit entries are made.
10 properties
5 required
OBAccountStatus1Code
string
Specifies the status of account resource in code form.
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.
OBActiveOrHistoricCurrencyAndAmount_0
object
The amount of the first Standing Order
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_1
object
The amount of the next Standing Order.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_2
object
The amount of the final Standing Order
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_3
object
Amount of money associated with the statement benefit type.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_4
object
Amount of money associated with the statement fee type.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the amount type.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money in the cash transaction entry.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_8
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage:…
2 properties
2 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBBalanceType1Code
string
Balance type, in a coded form.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBBeneficiary3
OBBeneficiary3Basic
object
3 properties
OBBeneficiary3Detail
object
5 properties
1 required
OBBranchAndFinancialInstitutionIdentification5_0
object
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 t…
2 properties
2 required
OBBranchAndFinancialInstitutionIdentification5_1
object
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 t…
2 properties
2 required
OBBranchAndFinancialInstitutionIdentification6_0
object
Financial institution servicing an account for the creditor.
4 properties
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the debtor.
4 properties
OBBranchAndFinancialInstitutionIdentification6_2
object
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 t…
4 properties
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
4 properties
2 required
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
4 properties
2 required
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
4 properties
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
4 properties
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry.
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.
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
OBEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer.
OBError1
object
4 properties
2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalAccountRole1Code
string
A party�s role with respect to the related account.
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group).
OBExternalAccountType1Code
string
Specifies the type of account (personal or business).
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalLegalStructureType1Code
string
Legal standing of the party.
OBExternalPartyType1Code
string
Party type, in a coded form.
OBExternalScheduleType1Code
string
Specifies the scheduled payment date type requested
OBExternalStandingOrderStatus1Code
string
Specifies the status of the standing order in code form.
OBExternalStatementAmountType1Code
string
Amount type, in a coded form.
OBExternalStatementBenefitType1Code
string
Benefit type, in a coded form.
OBExternalStatementDateTimeType1Code
string
Date time type, in a coded form.
OBExternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account.
OBExternalStatementFeeRateType1Code
string
Description that may be available for the statement fee rate type.
OBExternalStatementFeeType1Code
string
Fee type, in a coded form.
OBExternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested
OBExternalStatementInterestRateType1Code
string
Description that may be available for the statement Interest rate type.
OBExternalStatementInterestType1Code
string
Interest amount type, in a coded form.
OBExternalStatementRateType1Code
string
Rate associated with the statement rate type.
OBExternalStatementType1Code
string
Statement type, in a coded form.
OBExternalStatementValueType1Code
string
Value associated with the statement value type.
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBParty2
object
13 properties
1 required
OBPartyRelationships1
object
The Party's relationships with other resources.
1 property
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
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.
OBReadAccount3
object
3 properties
1 required
OBReadAccount4
object
3 properties
1 required
OBReadBalance1
object
3 properties
1 required
OBReadBeneficiary3
object
3 properties
1 required
OBReadConsent1
object
2 properties
2 required
OBReadConsentResponse1
object
4 properties
2 required
OBReadDataStatement2
object
1 property
OBReadDataTransaction5
object
1 property
OBReadDirectDebit1
object
3 properties
1 required
OBReadOffer1
object
3 properties
1 required
OBReadParty1
object
3 properties
1 required
OBReadParty2
object
3 properties
1 required
OBReadParty3
object
3 properties
1 required
OBReadProduct2
object
Product details of Other Product which is not avaiable in the standard list
3 properties
1 required
OBReadScheduledPayment2
object
3 properties
1 required
OBReadStandingOrder4
object
3 properties
1 required
OBReadStandingOrder5
object
3 properties
1 required
OBReadStatement1
object
3 properties
1 required
OBReadStatement2
object
3 properties
1 required
OBReadTransaction4
object
3 properties
1 required
OBReadTransaction5
object
3 properties
1 required
OBRisk2
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
OBScheduledPayment2
OBScheduledPayment2Basic
object
6 properties
4 required
OBScheduledPayment2Detail
object
8 properties
5 required
OBStandingOrder4
OBStandingOrder4Basic
object
12 properties
2 required
OBStandingOrder4Detail
object
14 properties
3 required
OBStandingOrder5
OBStandingOrder5Basic
object
12 properties
2 required
OBStandingOrder5Detail
object
14 properties
3 required
OBStatement2
OBStatement2Basic
object
Provides further details on a statement resource.
14 properties
5 required
OBStatement2Detail
object
Provides further details on a statement resource.
15 properties
5 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBTransaction5
OBTransaction5Basic
object
Provides further details on an entry in the report.
16 properties
5 required
OBTransaction5Detail
object
Provides further details on an entry in the report.
23 properties
5 required
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction.
4 properties
1 required
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
OB_Amount1_0
string
Cap amount charged for a fee/charge
OB_Amount1_1
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
OB_Amount1_2
string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
OB_Amount1_3
string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_Amount1_4
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_CodeMnemonic
string
The four letter Mnemonic used within an XML file to identify a code
OB_FeeCategory1Code
string
Categorisation of fees and charges into standard categories.
OB_FeeFrequency1Code_0
string
Frequency at which the overdraft charge is applied to the account
OB_FeeFrequency1Code_1
string
How often is the overdraft fee/charge calculated for the account.
OB_FeeFrequency1Code_2
string
How frequently the fee/charge is applied to the account
OB_FeeFrequency1Code_3
string
How frequently the fee/charge is calculated
OB_FeeFrequency1Code_4
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OB_FeeType1Code
string
Fee/Charge Type
OB_InterestCalculationMethod1Code
string
Methods of calculating interest
OB_InterestFixedVariableType1Code
string
Type of interest rate, Fixed or Variable
OB_InterestRateType1Code_0
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_InterestRateType1Code_1
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
OB_MinMaxType1Code
string
Min Max type
OB_OtherCodeType1_0
object
3 properties
2 required
OB_OtherCodeType1_1
object
Other application frequencies that are not available in the standard code list
3 properties
2 required
OB_OtherCodeType1_2
object
Other calculation frequency which is not available in the standard code set.
3 properties
2 required
OB_OtherCodeType1_3
object
Other Fee type which is not available in the standard code set
3 properties
2 required
OB_OtherCodeType1_4
object
Other fee rate type code which is not available in the standard code set
3 properties
2 required
OB_OtherCodeType1_5
object
Other fee rate type which is not in the standard rate type list
3 properties
2 required
OB_OtherCodeType1_6
object
Other application frequencies not covered in the standard code list
3 properties
2 required
OB_OtherCodeType1_7
object
Other calculation frequency which is not available in standard code set.
3 properties
2 required
OB_OtherCodeType1_8
object
Other fee rate type which is not available in the standard code set
3 properties
2 required
OB_OtherFeeChargeDetailType
object
Other Fee/charge type which is not available in the standard code set
4 properties
3 required
OB_OverdraftFeeType1Code
string
Overdraft fee type
OB_Period1Code
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OB_Rate1_0
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_Rate1_1
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
PartyNumber
string
Number assigned by an agent to identify its customer.
PhoneNumber_0
string
Collection of information that identifies a phone number, as defined by telecom services.
PhoneNumber_1
string
Collection of information that identifies a mobile phone number, as defined by telecom services.
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.
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
Reference
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this…
ScheduledPaymentDateTime
string
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respo…
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
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…
StandingOrderId
string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
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…
StatementId
string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
StatusUpdateDateTime
string
Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in res…
StreetName
string
Name of a street or thoroughfare.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
TransactionId
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
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.
Type_0
string
Statement rate type, in a coded form.
Type_1
string
Statement value type, in a coded form.
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…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yorkshire Building Society 5
Other APIs Yorkshire Building Society publishes across the network.
Yorkshire Building Society Payment Initiation API
Yorkshire Building Society Confirmation of Funds API
Yorkshire Building Society Event Subscriptions API
Yorkshire Building Society Dynamic Client Registration API
Yorkshire Building Society Generate Access Token API
#Account Information#AISP#Open Banking