Overview
Authenticate your customers in real-time

Need Seamless Bank to Bank Payments?
Looking for bank-to-bank transfer capabilities and don't have a payment processor yet? Check out our Payments API for a money movement solution.
Overview
Use the Okra Widget to instantly authenticate any of your customer’s bank account(s) with internet/online banking credentials or USSD. Once connected, you are automatically granted access to pull any additional product(s).
Before you can provide services to your user, you have to ensure that they are the owner of their account and that the information they provided to you is authentic. Our Auth product works across all banks and when used in tandem with our other products like [Identity](doc: identity), can help fight fraud and manage risk for every customer.
Configuring widget for authentication
You can authenticate an end-user account using the Okra widget. For a comprehensive guide on how you can authenticate using the Okra widget check this guide.
Returning user experience
Prevent duplicate account connections during account linking of your customers in your app by simply creating a seamless returning user experience. This guide will show you how to implement the returning user experience in your app.
Authenticate for payments
Check a customer's balance before debiting
Avoid NSFs by checking a customer's balance before debiting their account.
For example, your app might allow users to accumulate a credit balance that they can cash out to a bank account, or it might allow users to pay you using their bank account information. Okra also offers options to transfer money with your existing payment partners and avoid having to store a user's bank account information at all.
Check this guide, to learn how it works.
Auth schema
Field | Description |
---|---|
idObjectID | Unique Auth ID (Unique Okra Identifier) |
validatedBoolean | Customer Authentication Status |
bankObjectID | Unique Bank ID (Unique Okra Identifier) See Bank Availability ] |
customerObjectID | Unique Customer ID (Unique Okra Identifier) See Manage Customers ] |
recordObjectID | Unique Record ID (Unique Okra Identifier) See Records |
ownerObjectID | Unique Company ID (Unique Okra Identifier) (Your Client Token) |
envString | Okra API env the Auth was pulled from production or production-sandbox |
created_atDate | Date of Authentication |
last_updatedObject | Last Date of Authentication |
Auth endpoints
For a list of Auth endpoints, visit Auth reference
Updated 2 months ago