Getting started

#Getting a partner account

Partner accounts are created by us. Write to [email protected] with the name you trade under and the email that will own the account; you then manage everything below at open-banking.io/app/partner with that login.

On staging (https://staging.open-banking.io) you can build and test the whole journey against the sandbox's Mock ASPSP before any of the production steps below: a staging partner account and Connect client are all you need.

#Before your first production user

Two things must exist before a user can complete Connect against your production client:

1. an active Enable Banking application on your partner account, and
2. a Connect client (client id obc_…, client secret obs_…, redirect URIs).

Activate the application first. While an application is on file but not yet activated, every bank connection your users attempt fails with partner_app_inactive until it is.

#Enable Banking application

Not needed on staging. For production you need an Enable Banking account with KYB completed — start that first; it takes days, not hours. Your partner account then carries its own Enable Banking application, so every bank session opened by your users is signed with your credentials, not ours. The provisioning is done by us, on your behalf:

• We generate the RSA-4096 keypair and the self-signed certificate; the private key never leaves the server unencrypted.
• You register an application in the Enable Banking control panel under your own KYB, we upload the certificate and record the application id, and we activate it once Enable Banking has approved it. Your partner page shows the state: not provisioned, awaiting activation, active.
• Once the application is activated, credential changes take effect within 60 seconds.

#Branding

Under Partner → Connect branding you set what your users see while they are on open-banking.io: a display name, a logo, an accent colour, and support and terms links. Every Connect screen — login, bank picker, consent — wears them, with a "Back to {your name}" button that returns the user to your callback with error=access_denied. The emailed code (challenge=pin_code) is titled "Your code to connect your bank to {your name}" and explains that open-banking.io sends it on your behalf; the magic-link email stays ours.

• The logo must be an https:// URL; it is fetched and served through our own host, never hot-linked.
• Support and terms links must live under your registered domain when one is pinned.
• The accent is a #rrggbb colour; it drives buttons and links on the Connect screens.

Without branding, the screens show your partner account's name in the header, your client's display name on the consent card, and no logo, accent or links.

#Connect client

Under Partner → Connect clients you create a client and register its redirect URIs.

• The client secret is shown once. Rotating it keeps the previous secret valid for 24 hours.
• Redirect URIs must be absolute https:// URLs (or http://localhost for development) with no fragment, matched exactly.
• Revoking a client stops new authorisations immediately; keys already issued keep working until they are revoked themselves.