openbanking/conformance-suite

•Updated 4 days ago

The Functional Conformance Suite is an Open Source test tool provided by Open Banking.

Image

100K+

openbanking/conformance-suite repository overview

Open Banking Logo

The Functional Conformance Tool is an Open Source test tool provided by Open Banking⁠. The goal of the suite is to provide an easy and comprehensive tool that enables implementers to test interfaces and data endpoints against the Functional API standard.

The supporting documentation assumes a technical understanding of the Open Banking ecosystem. An introduction to the concepts is available via the Open Banking Website⁠.

To provide feedback, please see the CONTRIBUTING.md⁠.

⁠Release Notes

⁠v1.11.0 - 2026-09-18

Full Release Notes⁠

⁠Download: `docker run --rm -it -p 127.0.0.1:8443:8443 "openbanking/conformance-suite:v1.11.0"` | DockerHub⁠ | Setup Guide⁠

⁠Version table

Release	Standard version
v1.11.0	v4.0.1 Update 1 cVRP (based on OBL 4.0.1)
v1.10.0	v4.0.1
v1.9.7	v4.0.0 - Swagger Update 5 cVRP (based on OBL 4.0.0 Swagger Update 4)
v1.9.6	v4.0.0 - Swagger Update 5 cVRP (based on OBL 4.0.0 Swagger Update 4)
v1.9.5	v4.0.0 - Swagger Update 4
v1.9.2	v4.0.0 - Swagger Update 3
v1.9.0	v4.0.0 - Swagger Update 2
v1.8.0	v4.0.0
v1.7.6	v3.1.11
v1.7.0	v3.1.10
v1.6.12	v3.1.9

⁠Quickstart

Pull and run the latest (stable) tagged Docker image:

> docker run --rm -it -p 127.0.0.1:8443:8443 "openbanking/conformance-suite:v1.11.0"

> docker run --rm -it -p 8443:8443 "openbanking/conformance-suite:v1.11.0"

See Setup Guide⁠

⁠Prerequisites

The tool is compatible with the Open Banking UK R/W specification versions: 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.4, 3.1.5, 3.1.6, 3.1.7, 3.1.8, 3.1.9, 3.1.10, 3.1.11, 4.0.0, 4.0.1.

In order to run a container you'll need docker installed.

⁠Commercial VRP (cVRP) support

cVRP v4.0 and v4.0.1 implementations are supported. The v4.0.1 discovery configuration is:

"apiSpecification": {
          "name": "Commercial Variable Recurring Payments API Specification",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0.1/profiles/vrp-profile.html",
          "version": "v4.0.1",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/Commercial-VRP-API-Spec/refs/tags/v4.0.1/OpenAPI/cvrp-openapi.json",
          "manifest": "file://manifests/cVRP_4.0_variable_recurring_payments.json"
        },

The cVRP v4.0.1 test flow reuses the v4.0 manifest because its requests and assertions are unaffected by the v4.0.1 schema changes. A full sample file named cVRP-v4.0.1-generic-discovery.json is included in the /pkg/discovery/templates directory.

For cVRP v4.0, use:

"apiSpecification": {
          "name": "Commercial Variable Recurring Payments API Specification",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0/profiles/vrp-profile.html",
          "version": "v4.0.0",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/Commercial-VRP-API-Spec/refs/heads/main/OpenAPI/cvrp-openapi.json",
          "manifest": "file://manifests/cVRP_4.0_variable_recurring_payments.json"
        },

A full sample file named cVRP-v4.0-generic-discovery.json has been included in the /pkg/discovery/templates directory.

Please note, the sample file requires the following fields to be updated before use:

openidConfigurationUri
resourceBaseUri

⁠Discovery file info for v4.0.1

⁠AIS

"apiSpecification": {
          "name": "Account and Transaction API Specification",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0.1/profiles/account-and-transaction-api-profile.html",
          "version": "v4.0.1",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v4.0.1/dist/openapi/account-info-openapi.json",
          "manifest": "file://manifests/ob_4.0_accounts_transactions_fca.json"
        },

⁠PIS

"apiSpecification": {
          "name": "Payment Initiation API",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0.1/profiles/payment-initiation-api-profile.html",
          "version": "v4.0.1",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v4.0.1/dist/openapi/payment-initiation-openapi.json",
          "manifest": "file://manifests/ob_4.0_payment_fca.json"
        },

⁠CBPII

"apiSpecification": {
          "name": "Confirmation of Funds API Specification",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0.1/profiles/confirmation-of-funds-api-profile.html",
          "version": "v4.0.1",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v4.0.1/dist/openapi/confirmation-funds-openapi.json",
          "manifest": "file://manifests/ob_4.0_cbpii_fca.json"
        },

⁠VRP

"apiSpecification": {
          "name": "Variable Recurring Payments API Specification",
          "url": "https://openbankinguk.github.io/read-write-api-site3/v4.0.1/profiles/vrp-profile.html",
          "version": "v4.0.1",
          "schemaVersion": "https://raw.githubusercontent.com/OpenBankingUK/read-write-api-specs/v4.0.1/dist/openapi/vrp-openapi.json",
          "manifest": "file://manifests/ob_4.0_variable_recurring_payments.json"
        },

⁠Advanced Logging

There is the ability to enhance logging by setting any of the following env variables

LOG_HTTP_TRACE=true: Enables detailed HTTP trace logging. When set to true, the application will log all HTTP requests and responses, including headers and body content. This can be useful for debugging and monitoring HTTP interactions, but may expose sensitive information in the logs. Use with caution in production environments.
LOG_LEVEL=debug: sets the logging level to debug, providing detailed information about the application's operation. This is useful for diagnosing issues and understanding the application's behavior in detail.
LOG_TRACER=true: enables detailed tracing of the application's execution. This setting provides in-depth information about the application's internal processes, which can be useful for debugging complex issues. Use with caution as it may generate a large volume of log data.
EXPORT_LOG_FILE=true: sets the log output to a file and attaches the log file to the run export zip archive

⁠Support

For support on using the suite use the Open Banking Help Centre⁠.

⁠Licensing

This repository is subject to this MIT Open Licence. Please read our LICENSE.md⁠ for more information

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct, and the process for submitting pull requests.

⁠Useful links

Tag summary

Recent tags

Content type

Image

Digest

sha256:186ada6e6…

Size

96 MB

Last updated

4 days ago

docker pull openbanking/conformance-suite:v1.12.0-beta1