Partner APIs

Bind an application to institution-approved services, customer consent and recoverable operation identities.

An institution decides which services a partner can use, the accounts or programmes involved, limits, prices and responsibilities. Application authentication and customer authority must both be valid for the requested operation.

Existing scoped profile

The local read-only open-banking profile has tenant-local partner credentials, account ownership checks, explicit customer consent and read scopes. Select Local banking profile in the API reference. Its LOCAL_SYNTHETIC evidence covers the stated read and Transfer scope. It supplies no general partner permission for every core operation.

Current Mothership partner setup and sandbox simulation are separate from an activated production Banking as a Service programme.

Prepare an integration

Name the institution sponsor, programme owner and operations recovery owner.
Choose the actual product contract, environment, service scopes and customer consent requirements.
Register the application and configure the documented authentication, callback and key custody arrangement.
Verify permitted reads or commands with synthetic records, then exercise expired grants and cross-tenant/account denial.
Qualify idempotency, callback authenticity, delivery/replay and status recovery before promotion.

Production credentials need the institution’s approved qualification and administrative decision. Keep credentials in the calling backend’s secret store and apply bounded overlap when rotating them.

Target lifecycle and evidence

The proposed extension design describes application registration, credentials, qualification, subscriptions, replay, suspension and retirement. Those design operations remain separate from the current source/profile. Obtain the actual product implementation and contract before adopting that lifecycle.

Retain programme and grant versions, environment, exact methods and schemas, customer consent, request IDs, usage/fee evidence and acceptance results. Suspension prevents affected new work while separate recovery access continues to resolve outstanding obligations. Revocation must be checked at execution as well as at login.