API Explorer

Conformator

Conformator

Conformator lets a regulator test the open banking APIs of the banks, payment service providers and third-party providers it supervises against the agreed standard. The regulator reviews the results and issues conformance reports.

The name is the Latin conformator, "one who shapes": the regulator sets the shape, and Conformator checks each participant's API against it.

From the rules to a signed report

  1. Define: the rules are recorded as requirements, and the tests that check each one are grouped into versioned suites. A suite's endpoints come from a standard OBP implements, or from an OpenAPI document.
  2. Admit: each participant is registered and given a space of its own, kept apart from everyone else's.
  3. Test: participants run the suites against their own non-production systems, as often as they need.
  4. Review: participants submit their results with evidence. Reviewers assess them, and an approver who did not assess makes the decision. Participants can ask for waivers and appeal.
  5. Report: approval issues a report signed with Ed25519. Anyone can check a report by its reference, without trusting the site that shows it.

How it uses OBP-API

Conformator is two Platform Apps in the OBP-Frontend repository: the web app (apps/conformator) and the runner (apps/conformator-runner). The runner carries out the tests and records each result. Both keep their records in OBP-API as Dynamic Entities, in a central space and in each participant's space, and each declares the Scopes it needs.

Each participant has an here, which regulator staff create when they register it, naming its first admin. From then on the participant's admins add and remove their own people. Conformator gives the Organisation's members the participant Roles in the participant's space, and takes them away from people who leave, with DELETE /obp/v7.0.0/banks/BANK_ID/entitlements/ENTITLEMENT_ID.