Authenticate your customers in real-time with informed user consent.
Authentication, or Auth for short is the first step for your users in the Okra app experience. Whether you're building a solution with direct payments or just a simple budgeting and finance management app, Auth is the gateway for informed user consent. Your users log in to their bank accounts securely via the Okra app, and through Auth, they authorise Okra to share their financial data with your application.
This enables you retrieve up-to-date account and financial data for your users, and also makes it possible to authorise payment requests through your users' accounts.
How it works
When you embed the Okra app into your application or website workflow, it guides your users through a simple authentication flow for each institution that Okra supports.
When you users connect their accounts for the first time, the Okra API creates a record with their account information. The API also retrieves data for any of the Account data products that you set up when you build your app. When you are building a Payments product, Auth enables you to authorise instant bank-to-bank payments, and to authorise future payments from your users' bank accounts with their informed consent.
How to use
Since Auth is required for both Payment and Account data products, it is enabled by default in every app that you build, both via the App Builder, or when using the API to build with
Check out the Build your app guide for more guidance on creating your Okra app.
Every user's authentication flow is free of charge and will not debit your Okra Wallet.
Auth is not a paid product, because it is required to authenticate users and enable access to other products.
Account connection methods
When you build your app, you can define different authentication options for your users:
- log in using the credentials they have on their internet banking portal, or on their banks' mobile applications, or even through manual authentication using their BVN or account numbers
- select whether they want to connect their personal or business accounts
- connect multiple accounts in the same app instance
These options are easy to configure when you use the App Builder. Dive into the Okra app properties to understand the different parameters you can use when you build with
The Okra app also helps you simplify the user flow by only displaying login methods that are supported by the banks that your user selects. Check out the Coverage guide to learn about supported account types.
Returning user experience
You can configure the Okra app to identify returning users and eliminate redundant authentication or bank selection steps in their user flows. This enables you to:
- reduce the amount of duplicate account connections
- collate data for the same user via different apps
- improve user experience and reduce user friction
Check out the Returning user experience guide for more details on how this feature works.
These are sample requests and responses for the
Get Auth by Customer operation, which returns all Auth records for a single user:
Visit the API reference for a complete list of operations and sample responses.
Was this page helpful?