This document supersedes the Open Banking Directory Usage (Directory Sandbox) document.
Open Banking Directory Team
Updated document in3.Getting Started Checklist: Certificate profilesupdated with OpenSSL eIDAS PSD2 Certificate Signing Request Profiles v2.1.
Updated Description and Example for the On Behalf Of item in 6. Create Software Statements.
Open Banking Directory Team
Updated screenshot in 15. Creating and managing ASPSP Authorisation Servers to show new input field: API Resource Discovery Endpoint.
Updated text in 16. Acquiring the List of ASPSP Authorisation Servers to highlight the new field: API Resource Discovery Endpoint.
The purpose of this How To Guide is for ASPSPs and TPPs who want to onboard their software with the Open Banking Directory Sandbox. It is aimed at Primary Technical Contacts (PTC) and Secondary Technical Contacts (STC).
This guide describes the technical steps for creating and maintaining Software Statements, access tokens and ASPSP authorisation servers on the Directory Sandbox environment of the Open Banking Directory.
This guide is structured into these sections:
Log in to the Directory Front End Interface (DFI)
Accessing ASPSP and/or TPP records
Creating Software Statements
Creating a Certificate Signing Request (CSR) for OB ETSI like and OB non-ETSI certificates
Managing Transport and Signing Test Certificates including QWACs and QSeals (eIDAS certificates)
Managing signing and encryption keys
Creating Software Statement Assertions (SSA)
Creating ASPSPs’ lists of Authorisation Servers
Acquiring Access Tokens to consume API services
Acquiring the list of Authorisation Servers
Creating Software Statement Assertions (SSA) via API
Using DFI features via API
The guide is intended for:
ASPSP/TPP Primary Technical Contacts
ASPSP/TPP Secondary Technical Contacts
TSP Primary and Secondary Technical Contacts
3. Getting Started Checklist
Before you begin, it is highly recommended to go through this section first to ensure that you have all the relevant details;
You have been added to the Open Banking Directory as a Primary Technical Contact or Secondary Technical Contact.
You have the ability to run git on your computer. Git is available for all major operating systems. Git is available from https://git-scm.com/downloads and as a package for all major Open Source operating systems.
You have read the following:
Open Banking JIRA Service Desk
How to record issues and support requests.
This document is emailed to participants after enrolment.
This document outlines the set of technical design changes required to the Open Banking Directory Platform with regards to the use of eIDAS certificates for cross-party identification. It outlines the technical components and the expected changes providing the requirements it should adhere to, in order to support the compliance of its participants and enable a well-functioning OB ecosystem.
This document outlines the set of technical design changes required to the Open Banking Directory Platform to enable support for API based enrollment of TPPs with regards to the use of eIDAS certificates for cross-party identification. It outlines the technical components and the expected changes providing the requirements it should adhere to, in order to support the compliance of its participants and enable a well-functioning OB ecosystem. This will be used to inform the detailed design and implementation activities to align the OB Directory Platform with PSD2 Regulatory Technical Standards (“RTS”) and support the related eIDAS requirements.
5. You will be referred to further documents. Please check that you have access to the following documents and submit a request for access to the Service Desk if you don't:
This document outlines the general procedure to generate Certificate Signing Requests (CSR) for Open Banking Public Key Infrastructure (PKI). It focuses on the method required to generate a CSR for Open Banking ETSI like certificates (OBWAC, OBSeal). It includes configuration files to generate CSRs for OBWAC and OBSeal certificates using OpenSSL. Also, example DER encoded QC Statements for all combinations of PSD2 roles.
4. Log in to the Directory Front End Interface (DFI)
This section describes how to log in to the Directory Front End Interface using two-factor authentication.
Step 3: Follow the instructions on the screen to log in to the DFI web application.
5. Access your ASPSP or TPP Records
Once you've logged in to the DFI, you will see a list of directory participants.
Steps to identify your participant
Step 1: Once you log in to the DFI you will see a list of ASPSP/TPP.
Step 2: Click on the particular row (or > button) corresponding to your ASPSP/TPP. This will open up the summary page for your ASPSP/TPP.
If you do not see your ASPSP/TPP in the list, then enter your ASPSP/TPP name or ID and click on search. From the search results click on the row (or > button) corresponding to your ASPSP/TPP. This should open up the summary page for your ASPSP or TPP.
Note: TPPs can see a list of ASPSPs, but not other TPPs. ASPSPs can see a list of all TPPs and ASPSPs. PTC and STC details can only be seen by PTCs or STCs of the same organisation.
6. Create Software Statements
In order for TPPs and ASPSPs to communicate with each other they need to create Software Statements that uniquely identify their application. This section explains the steps to create Software Statements.
Before you start
You are viewing the summary page for your ASPSP or TPP.
Steps to Create Software Statements
Step 1: Scroll down to the Software Statements section
Step 2: Click the Add new statement button.
Step 3: Complete the Add new Software Statement form as shown below:
Must be set to a text string of your choice.
During the PSU consent flow, ASPSPs will display this field as the company trading name requesting access to PSU data. Ensure the name provided is representative of the trading name of the organisation. The trading name should be a name that is registered at your National Competent Authority (NCA).
Example: ACME Limited
Maximum length: 40 characters.
Must be set to a text string of your choice.
The On Behalf Of attribute supports Onward Provisioning
The “On Behalf of” field enables the TPP to provide the details of their agent to the ASPSP by including these within the payload. The ASPSP can then present this information to the PSU by displaying both the agent’s name and the regulated TPP’s name. The CEGs* require that if the customer-facing entity is acting on behalf of a TPP as its agent, the TPP must make the PSU aware of this relationship.
The “On Behalf of” field is classified as optional for implementation, however, it is encouraged that:
TPPs populate this field when using an agent for the purposes of transparency and consistency.
ASPSPs display the information contained in this field to the PSU during their authentication journey, as well as, in their access dashboard, where applicable.
*Currently this is a CEG requirement for AISPs only
Example : The Regulated party is ACME, a registered TPP enrolled onto the Open Banking Directory. They wish to identify another party, ABC Agent, who is an agent acting on behalf of ACME who directly interacts with the ASPSP/ PSU on behalf of ACME. ACME would like the PSU to be informed about ABC Agent in the domain of their ASPSP and would therefore input ABC Agent in the On Behalf Of field.
Software Version must be set to a numeric value, an integer (e.g. 1) or a floating-point number (1.2, 2.2, 3.2 etc.).
Default shows PSD2 role as selected based on the organisation's PSD2 roles as registered on enrollment.
A TPP may have a several roles and can select one specific role for the software statement or all the registered roles.
No role - this can be selected to create a software statement with an Oauth client that can be used to monitor APIs, but without the risk of it being misused to transact with Read/Write APIs.
Must be set to a text string that represents a single Policy URI.
Terms Of Service URI
Must be set to a text string that represents a single Terms of Service URI.
The website or resource root URI.
Link to the TPP logo.
Note: ASPSPs are not obliged to display images hosted by third parties.
Redirect URIs must be set to a text string that represents a single redirect URI.
Wild cards are not allowed; port numbers are not allowed - defaults to https/port 443.
Additional Redirect URIs
Additional Redirect URIs can be added by clicking the Add Redirect URI.
Click the Continue button to create a new software statement.
An OAuth client will be generated automatically
See Step 5: Client Id
Step 5: Verify that the new Software Statement has been created. It should appear on the summary page for the ASPSP or TPP.
The software statement ID (software_id) appears below the software statement name (i.e Test in the above example).
The OAuth client ID (software_client_id) is the Client Id.
The software statement ID and OAuth client ID are given the same value.
To deactivate software statement click on the Deactivate Statement button.
If it has individual transport and signing certificates they will be automatically revoked and moved into the revoked JWKS and PEM stores in the case of OBWACs/OBSeals and OB non-ETSI certificates. QWACs and QSeals will be automatically removed and moved into the revoked JWKS and PEM stores.
If it has individual signing keys and/or encryption keys they will be automatically removed and moved into the revoked JWKS and PEM stores.
The Deactivate Statement button is replaced with an Activate Statement button.
To reactivate the software statement click the Activate Statement button. The transport and signing certificates will have to be generated manually in the case of OBWACs/OBSeals and OB non-ETSI certificates. OBWACs, OBSeals, signing and encryption keys will have to be reassociated with the software statement.
7. Create a Certificate Signing Request (CSR) for Open Banking non-ETSI certificates
ASPSPs and TPPs need to create digital certificates to encrypt messages over the public network, and sign requests. In order to create certificates, ASPSPs and TPPs need to create certificate signing requests. This section explains the steps to create a certificate signing request for Open Banking non-ETSI certificates.
Before you start
You have created a Software Statement for your Organisation.
You know the Software Statement Id as shown on the software statements screen.
You know the Organisation ID of your organisation as shown on the Business Information screen.
Steps to create CSR
Using your own key generation and management policies, a public private key pair must be created. The following is an example using OpenSSL and is for illustration purposes only.
Unix and Mac Users
Open the text terminal window (command line) on your computer and run the following command: openssl req -new -newkey rsa:2048 -sha256 -nodes -out <software_statement_id>.csr -keyout <software_statement_id>.key -subj "/C=GB/O=OpenBanking/OU=<organisation_id>/CN=<software_statement_id>"
Note: Keep O set to OpenBanking
The DN should be "/C=GB/O=OpenBanking/OU=<organisation_id>/CN=<software_statement_id>". There should not be any other fields in the DN.
Install a bash shell emulater.
goto the directory you want to create the CSR.
Open the text terminal window (command line) on your computer and run the following command: openssl req -new -newkey rsa:2048 -sha256 -nodes -out <software_statement_id>.csr -keyout <software_statement_id>.key -subj "//C=GB\O=OpenBanking\OU=<organisation_id>\CN=<software_statement_id>"
Note: KeepOset to OpenBanking
The DN should be windows escaped "//C=GB\O=OpenBanking\OU=<organisation_id>\CN=<software_statement_id>".
You will need to create two private keys and two CSRs - one for the transport certificate and the other for signing certificate.
The following table summarises the fields you will need to set in your CSR. If you add values to additional fields in your CSR tool, eg. State, the CSR will be rejected on upload.
Logical Field Name
Signature Hash Algorithm
Organisational Unit (OU)
OU=The unique identifier for the organisation.
CN=The Software Statement ID (SSID) for the software statement that the certificate has been created for the software
X509v3 Subject Alternative Name:
<Comma separated list of DNS names>
All TPPs and ASPSPs must use the OB issued certificates for their MATLS endpoints that are for OB parties.
The organisation can include multiple DNS qualifed domain name(s) as a comma seperated list.
8. Generate and manage Transport and Signing Certificates for Open Banking non-ETSI certificates
TPP and ASPSPs need to create digital certificates to encrypt messages passing over the network between the participants (ASPSP/TPP) and OB network. This section explains the steps to create digital Open Banking non-ETSI certificates.
Before you start
You need to have,
a transport certificate CSR
a signing certification CSR, and
both the CSRs are generated from two different private keys
Steps to Create Certificates
Step 1: On the ASPSP or TPP summary page click on the > to the right of the newly created Software Statement.
Step 2: Scroll down to the Add certificates section and upload the CSR to generate the Transport certificate. On upload the generated transport certificate appears in the Certificates section.
Step 3: Upload the file for the OB Signing Certificate.
Step 4: Click on the 3 dots on the right, and then click on Get PEM to download the certificates.
If you need to revoke a certificate, click on the Revoke button to revoke the certificate.
9. Generate and manage Transport and Signing Certificates for Open Banking ETSI certificates (OBWAC and OBSeal)
The Open Banking Certificate Authority allows the generation and management of transport and signing certificates that have an ETSI profile, consistent with the structure of their equivalent eIDAS certificates (QWACs and QSeals).
Before you start
You are viewing the summary page for your ASPSP or TPP. Unlike Open Banking non-ETSI certificates, the OB ETSI certificates are not generated at the software statement level/screen, they are generated at the organisation level on the organisation's summary screen.
If you use the obdatat tool referred to in Section 12 to successfully acquire an access token: '-nodes' must be added to the Openssl CSR generation command.
If you copy and paste a QcStatement DER encoded line into your config file: line breaks or whitespaces may be introduced, which may invalidate your CSR.
Generate and manage OBWAC and OBSeal certificates
On the summary page for your ASPSP or TPP, scroll down to the Organisation Certificates sections and upload your CSR for either an OBWAC or OBSeal. The following shows the Organisation Certificates section with several OBWACs and OBSeals.
To the right of each certificate is a menu option (three stacked dots). Click on these and three options appear:
JWKS - a link to the JWKS file
Get PEM - a link to the PEM file
Revoke - click to revoke the certificate
To associate an OBWAC or OBSeal certificate to a Software Statement select it to navigate to the Software Statement's detail screen. In the above case, the Keys/certificates section appears as follows:
The certificates can be associated by selecting the check box for them. Note, OBWAC certificates can be associated to all Software Statements or just one Software Statement. OBSeal certificates can only be associated to one Software Statement.To dissociate a certificate from a Software Statement simply uncheck the Associated check box.
10. Upload and manage QWAC and QSeal (eIDAS) certificates
The Open Banking Certificate Authority allows the upload and management of QWAC and QSeal certificates.
Before you start
You are viewing the summary page for your ASPSP or TPP. QWAC and QSeal certificates are not uploaded on the Software Statement screen, they are uploaded at the organisation level on the organisation's summary screen.
Manage QWAC and QSeal certificates
On the summary page for your ASPSP or TPP, scroll down to the Organisation Certificates sections and upload your QWAC and QSeal certificate. To associate a QWAC or QSeal certificate to a Software Statement select it to navigate to the Software Statement's detail page. The certificates can be associated and dissociated in the same way OBWACs and OBSeals in the section above. Note, QWAC certificates can be associated to all Software Statements or just one Software Statement. QSeal certificates can only be associated to one Software Statement.
11. Upload and manage signing and encryption keys
Instead of the signing certificates mentioned above, signing keys can be used. On the Software Statement's detail page for your ASPSP or TPP, scroll down to the Keys/certificates section and upload your signing key. The certificates can be associated and dissociated in the same way OBWACs and OBSeals in the section above. Note, signing keys can only be associated to one Software Statement.
Encryption keys can be associated and dissociated in the same way as signing keys.
12. Create a Software Statement Assertion (SSA) signed by Open Banking
As a TPP you will need to create a software statement assertion and submit it to ASPSP to receive valid client credentials. These credentials are then used to access any Personal Service User (PSU) resource from the ASPSP. SSAs are essentially JSON Web Tokens (JWT) issued and signed by Open Banking.
There are two ways to generate Software Statement Assertions:
SSA generation using DFI Portal, described in this section
Dynamic SSA generation using the API, described in section 13. Create a Software Statement Assertion (SSA) using an API call
Before you start
You have created a Software Statement for TPP software that you want to register with an ASPSP.
Steps to create a Software Statement Assertion
Step 1: Go back to the ASPSP or TPP summary page and click on the newly created Software Statement.
Step 2: Scroll down to the Software Statement Assertion section and click the Generate
Step 3: The SSA is displayed and can be copied to the clipboard. It can be used to on-board the associated Software Statement with an ASPSP. The plain text contents are also displayed.
Step 1: Make sure you are in the obdatat directory.
Step 2: Copy the two private keys generated in Create Certificate Signing Request (CSR) – one for the signing certificate, one for the transport - to the relevant files in obdatat config folder replacing their empty equivalents (privateKeySigning.key, privateKeyTransport.key).
Step 3: Download the PEM files from the DFI for the signing and transport certificates. Upload them into the config folder replacing their empty equivalents (certSigning.pem, certTransport.pem)
Step 4: Edit obdatat/config/config.json and set the values of its keys as follows:
SoftwareStatementId — the Software Statement ID (software_id) of the software statement created in Create Software Statements.
Client Scopes — one of the following, matching the type of your organisation:
for a TPP, use ASPSPReadAccess TPPReadAccess AuthoritiesReadAccess
for an ASPSP, use ASPSPReadAccess TPPReadAll AuthoritiesReadAccess
Key ID (K ID in image below) — the value of the kid parameter associated with the signing certificate generated in Generate a Transport/Signing Certificate Pair. (Please note that you need to use the signing certificate kid)
org_id must be the Id of the TPP/ASPSP for which you want to generate an SSA.
software _id must be set to the Id of the Software Statement for which you want to generate an SSA; this is displayed under the Software Statement title at the top of the page (see below).
Client Scopes — use one of the following, matching the type of your organisation:
for a TPP use TPPReadAccess
for an ASPSP use ASPSPReadAccess
15. Creating and managing ASPSP Authorisation and Resource Servers
As an ASPSP you can add URIs so that TPPs can find your authorisation servers and other end points. This can be done by using the “Add well-known URI” feature provided to ASPSPs. This section details the steps required to create and manage authorisation servers.
Before you start
You are an ASPSP. You are viewing the summary page for your ASPSP.
Steps to add well-known URI
Step 1: Login to the system, select your ASPSP and scroll down to the Well-known URI section.
Step 2: Click on the Add new URI
Step 3: Enter the details.
Step 4: Click Submit button.
To edit the details click Edit URI button. (You can edit individual URIs.)
To delete the details click Delete URI button. (You can delete individual URIs.)
ASPSPs that have multiple brands can enter a Well-known URI per brand.
ASPSPs can also enter a URL that defines their functional APIs using the input field labelledAPI Resource Discovery Endpoint.
Bearer goes into the Authorisation header to obtain the list of ASPSPs
Step 2: Iterate over the response and filter for the AuthorisationServers
ASPSPs may provide a URL that defines their functional APIs using the input field labelledAPI Resource Discovery Endpoint.
This information will be returned with the AuthorisationServers data.
17. Using the Open Banking Directory APIs
Functionality that was previously only available via the DFI can now be accessed via Open Banking APIs:
manage organisation contacts (CRU)
manage software statements (CRU)
generate software statement assertions
upload/manage signing keys
upload/manage encryption keys
generate/manage OB non-ETSI certs
generate OBWAC/OBSeal certs
upload eIDAS QWAC/QSeal certs
The above require the generation of an organisational OAuth client. The Dynamic Client Registration (DCR) service generates an organisational OAuth client. A full list of services is available on the /wiki/spaces/WOR/pages/1111785878 page.
All queries, issues or support requests need to be routed through JIRA Service Desk (JSD) (see Open Banking JIRA Service Desk for guidance on how to report a query or issue).
JSD will be monitored throughout each day - Monday to Friday, 8am to 6pm UK time - and issues raised will be responded to as follows:
Urgent Support Requests: As they occur depending upon priorities
Queries: Daily morning triage will assign and respond according to priorities
Bugs: Daily triage will assign and respond according to priorities
Any critical blocking bugs will be addressed as they occur depending upon priorities.
19. Definition of Terms
Open Banking Limited (OB)
The Open Banking Implementation Entity is the delivery organisation working with the CMA9 and other stakeholders to define and develop the required APIs, security and messaging standards that underpin Open Banking.
Account Servicing Payment Service Provider (ASPSP)
Account Servicing Payment Service Providers provide and maintain a payment account for a payer as defined by the PSRs and, in the context of the Open Banking Ecosystem are entities that publish Read/Write APIs to permit, with customer consent, payments initiated by third party providers and/or make their customers’ account transaction data available to third party providers via their API end points.
Third Party Providers / Trusted Third Parties (TPP)
Third Party Providers are organisations or natural persons that use APIs developed to Standards to access customer’s accounts, in order to provide account information services and/or to initiate payments. Third Party Providers are either/both Payment Initiation Service Providers (PISPs) and/or Account Information Service Providers (AISPs).
Technical Service Provider (TSP)
An unregulated Technical Service Provider who will only have access to the Directory Sandbox.
Payment Initiation Service Provider (PISP
A Payment Initiation Services Provider provides an online service to initiate a payment order at the request of the payment service user with respect to a payment account held at another payment service provider.
Payment Service Provider (PSP)
A legal entity (and some natural persons) that provide payment services as defined by PSD2 Article 4(11)
Account Information Service Provider (AISP)
An Account Information Service provides account information services as an online service to provide consolidated information on one or more payment accounts held by a payment service user with one or more payment service provider(s).
Payment Service User (PSU)
A Payment Services User is a natural or legal person making use of a payment service as a payee, payer or both
TPP Primary Technical Contact
A Primary Technical Contact is an individual nominated by a TPP to have access to the Directory and will be able to nominate other Directory technical users. This should be a main point of contact on technical configuration and a senior member of staff with responsibility for the management of the Open Banking digital identity.
TPP Secondory Technical Contact
A person that carries out technical operations on behalf of a TPP.
A TPP-STC has the same permissions as a TPP-PTC except for the ability to nominate other Directory technical users.
ASPSP Primary Technical Contact
A Primary Technical Contact is an individual nominated by the ASPSP to have access to the Directory and will be able to nominate other Directory technical users. This should be a main point of contact on technical configuration and a senior member of staff with responsibility for the management of the Open Banking digital identity.
ASPSP Secondory Technical Contact
A person that carries out technical operations on behalf of an ASPSP.
An ASPSP-STC has the same permissions as a ASPSP-PTC except for the ability to nominate other Directory technical users.
A description of a TPP Client Application stored by OB and whose infomation is distributed to ASPSPs using an SSA.
Unique identifer for a TPP Client App that is scheme wide and can be used to revoke a TPP Client App.
Software Statement Assertion (SSA)
Software Statement Assertion represents a formalized assertion describing a TPP Client Application. It includes claims such as Client Name, Redirect URL etc. The SSA is emphermal and is short lived.
For further information on the terms used within this document please refer to the Glossary on the Open Banking website at www.openbanking.org.uk