Not a developer?
Check out the Okra App Builder for a no-code way to get started with Okra's Widget and API.
Here's a breakdown of all the Okra Widget properties you can use to customize your widget. To use these options in your app you must first integrate an Okra Widget.
|token||The Client Token associated with your account; is available in the Dashboard.||none|
|key||The key associated with your account; is available in the Dashboard.||none|
|clientName||Displayed on the User Agreement and once a user has successfully linked their Record.||'This Client'|
|env||The Okra API environment on which to create user accounts. Use |
Note: all Production requests apart from the 100 Records on our Startup Plan are billed.
|countries||Countries to support. It shows banks from this country||['NG']|
Please contact [email protected] for access to our ZA, and KY (South Africa and Kenya) banks.
|products||A list of Okra products you wish to use.||['auth', 'balance', 'identity']|
Valid products are:
In Production, you will be billed for each product that you specify when initializing the Okra Widget.
Example: ['auth', 'transactions']. Auth is free and automatically selected as users must be authenticated before accessing other products.
|source||The integration type you are using. Options Include:|
|mode||Widget background color|
primary - Primary Color
light - Light Transparent
dark - Dark transparent
|callback_url||Specify a callback to associate with a Record. Okra fires a callback when the Record requires updated credentials, when new data is available, or when Auth numbers have been successfully verified.||none|
|redirect_url||Specify a URL to redirect your customers when they click on the Done button at the end of the connection process. For example, you can guide your customer to a Success page, to any next steps, or any other location in your application's workflow.||none|
|color||The color theme on the widget||3AB795|
|logo||Your App or Company logo||Okra's Logo|
|options||You can pass object custom values to the widget, view Special Widget Options below||none|
|enableAutoConnect||Allow users to automatically connect their accounts. This will automatically connect all accounts your customer has at the bank they are connecting with.||false|
|debitLater||Authenticate users for debit access at a later date.||false|
|debitType||Choose whether to debit the user on a recurring basis or one-time|
|showBalance||Allow users to see their account balance||false|
|enhancedBalance||See your users enhanced balance (point in time balance) at every transaction line||false|
|selfieVerify||Allow users to verify their identity with selfies to determine if the person holding the device is the same person verifying their account.|
See more information on Selfies here
|geoLocation||See your user's transaction location||false|
|continue_cta||The message on the button when a user completes linking||Continue|
|multi_account||Allow user's the ability to quickly return to the bank search screen and link another account.||true|
|manual||Allow users log in by entering their NUBAN and a unique identifier of your choice e.g. BVN||false|
|manualType||Unique identifier to check NUBAN against. This is to minimize fraud around NUBAN-only identity verification|
|manualUpload||Allow users to upload a bank statement that will be analyzed via OCR and available on your Okra dashboard.||false|
|ussd||Allow users log in with USSD|
You must be using a compatible Android SDK that supports USSD.
|success_title||Landing Page Success Title||You've successfully linked to Okra!|
|success_message||Landing page success page||With your bank account linked, you would be able to access the best financial services & products.|
|widget_success||Customize the messages your users see when they successfully link their bank accounts to your app.||'You successfully linked your account to clientName'|
|widget_failed||Customize what your users see if the widget fails.||'Uh oh, an error occurred'|
|identity_type||Unique Customer Identifier||BVN|
|limit||Statement length (3-24)||24|
|corporate||Should only display corporate banks as well|
null - Show both Ind & Corp
true - Show only Corp
false - Show only Ind
|institutions||The banks you would like to display to your users, the remaining will be searchable|
min of 4
|geoLocation||Access your customer's transaction locations||false|
|filter||Filter the banks you would like to show users. If nothing is sent all will be available.|
|isWebview||Set true if launching OkraJS within a WebView.||false|
|connectMessage||Customize the messages your users see when they are about to connect their accounts.|
e.g. Select your Salary Account
|'Select your account to connect'|
|meta||Send any data to the widget using the meta Object.||E.g|
|displayQR||Display QR code option on payment widget.|
Set false to hide QR option
Direct to bank flow
This feature makes it possible for you to pre-select a bank, skipping the bank selection screens on the widget.
When creating links for data or payments, pass the
preselect_bank option with the parameters shown below in your application's configuration on the client-side, to bypass the bank selection widget screens.
You can copy-paste this initialization example into an Html file, then replace it with your own API-KEY and Client-Token to run the widget. Find your API-KEY and Client-Token in the API keys section of the Okra dashboard.
|bank||bank slug - ||The bank name you want to pre-select.|
Check here for a list of bank slugs
|type||personal - ||It refers to the type of account. E.g |
|platform||bank - ||It refers to the login methods, which are internet banking(bank) or mobile banking(mobile).|
|login||pin_and_token - ||This optional keyword refers to only banks that have multi-login options like Zenith bank, which have |
|app||gtworld - ||For banks with multiple mobile banking apps like GTbank, you can specify a particular app.|
Updated 11 days ago