1. Open Banking API Platform
  2. Data model
Reference

The tables behind Open Banking API Platform

Open Banking API Platform ships with 15 tables, grouped here by the feature that uses them. Every record your team works with lives in one of them, and you can add fields and tables in Proto.

Tables
15
Features
7, plus shared settings
Change it
Add fields and tables in Proto

How the model is organised

Organization and people

Organizations owns operating scope; team members links Users to that scope. Financial counterparties records eligible banks and custodians.

Instruction and decision

Bank instructions connects to its account lines, access requests, review decisions, attachments, provider evidence and operation receipts.

Provider account data

Financial accounts belongs to a counterparty and connects dated account snapshots and source-identified reconciliation items.

Reference values

Exchange rates holds read-only effective currency rates.

Every table, by feature

Organizations and counterparties

4 tablesAbout this feature
  • Organizations

    Banking organizations whose treasury operations are run in this app.

  • Team members

    Preparers, approvers, auditors and administrators working in the organization.

    Linked to Users, Organizations
  • Users

    Users

    Linked to Users
  • Financial counterparties

    Banks, custodians and settlement counterparties eligible for banking instructions.

    Linked to Organizations

Financial accounts

4 tablesAbout this feature
  • Financial accounts

    Provider-held financial accounts owned by a counterparty.

    Linked to Financial counterparties
  • Instruction accounts

    Debit and credit account scopes that make an instruction balanced.

    Linked to Bank instructions, Financial accounts
  • Account snapshots

    Dated provider balance snapshots for a financial account.

    Linked to Financial accounts
  • Financial counterparties

    Banks, custodians and settlement counterparties eligible for banking instructions.

    Linked to Organizations

Bank instructions

5 tablesAbout this feature
  • Bank instructions

    Typed banking instructions moving through authorization, submission and confirmation.

    Linked to Organizations, Team members, Financial counterparties
  • Instruction accounts

    Debit and credit account scopes that make an instruction balanced.

    Linked to Bank instructions, Financial accounts
  • Financial accounts

    Provider-held financial accounts owned by a counterparty.

    Linked to Financial counterparties
  • Financial counterparties

    Banks, custodians and settlement counterparties eligible for banking instructions.

    Linked to Organizations
  • Organizations

    Banking organizations whose treasury operations are run in this app.

Independent review

5 tablesAbout this feature
  • Review decisions

    Independent approver decisions recorded against a frozen instruction revision.

    Linked to Bank instructions, Team members
  • Bank instructions

    Typed banking instructions moving through authorization, submission and confirmation.

    Linked to Organizations, Team members, Financial counterparties
  • Team members

    Preparers, approvers, auditors and administrators working in the organization.

    Linked to Users, Organizations
  • Operation receipts

    Idempotent operation receipts with stable operation keys and actual effect references.

    Linked to Bank instructions
  • Record attachments

    Supporting documents attached to a banking instruction.

    Linked to Bank instructions, Team members

Access consents

4 tablesAbout this feature
  • Access consents

    Access consents to activate verified bank-data access against a banking instruction.

    Linked to Bank instructions, Organizations
  • Bank instructions

    Typed banking instructions moving through authorization, submission and confirmation.

    Linked to Organizations, Team members, Financial counterparties
  • Organizations

    Banking organizations whose treasury operations are run in this app.

  • Review decisions

    Independent approver decisions recorded against a frozen instruction revision.

    Linked to Bank instructions, Team members

Provider evidence

4 tablesAbout this feature
  • Bank instructions

    Typed banking instructions moving through authorization, submission and confirmation.

    Linked to Organizations, Team members, Financial counterparties
  • Bank evidence

    Provider statements, confirmations, settlement notices and corrections for an instruction.

    Linked to Bank instructions
  • Record attachments

    Supporting documents attached to a banking instruction.

    Linked to Bank instructions, Team members
  • Operation receipts

    Idempotent operation receipts with stable operation keys and actual effect references.

    Linked to Bank instructions

Reconciliation and receipts

6 tablesAbout this feature
  • Reconciliation items

    Source-identified provider movements matched against banking instructions.

    Linked to Financial accounts, Bank instructions
  • Account snapshots

    Dated provider balance snapshots for a financial account.

    Linked to Financial accounts
  • Financial accounts

    Provider-held financial accounts owned by a counterparty.

    Linked to Financial counterparties
  • Bank instructions

    Typed banking instructions moving through authorization, submission and confirmation.

    Linked to Organizations, Team members, Financial counterparties
  • Operation receipts

    Idempotent operation receipts with stable operation keys and actual effect references.

    Linked to Bank instructions
  • Bank evidence

    Provider statements, confirmations, settlement notices and corrections for an instruction.

    Linked to Bank instructions

Shared and settings

1 table
  • Exchange rates

    Read-only effective exchange rates for this app.

Keys and references

The instruction’s record number identifies the request in day-to-day work. Provider instruction ID connects it to a provider submission. Provider event ID distinguishes bank evidence and reconciliation items from provider sources. Operation key identifies a guarded action, while expected revision and source revision preserve the instruction state used for an operation or decision. Parent, Instruction, Account, Owner, Reviewer and Organization references keep related records connected.

Migration order

  1. Organizations and people. Import Organizations and Users, then team members with their organization and user references.
  2. Counterparties and accounts. Add financial counterparties, then financial accounts with provider identifiers and owners.
  3. Instructions and account scope. Import bank instructions before instruction accounts and other children that reference them.
  4. Decisions and evidence. Add review decisions, access consents, bank evidence, record attachments and operation receipts with their parent links.
  5. Provider account history. Load account snapshots and reconciliation items with their source identifiers and account links. Add exchange rates if they are used in the operating cycle.

Set up Open Banking API Platform your way.

Start free, then use Proto to change fields, steps and approvals before your team goes live.

How to get started