Widget properties
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.
Name | Description | Default Value |
---|---|---|
token | The Client Token associated with your account; available from the Dashboard. | none |
key | The key associated with your account; available from 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. Will show 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 Options Include: | primary |
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 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 |
color | Color theme on the widget | #3AB795 |
logo | Your App or Company logo | Okra's Logo |
options | You can pass a 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 user on a recurring basis or one-time Options Include: | 'one-time' |
showBalance | Allow users to see their account balance | false |
enhancedBalance | See your your users enhanced balance (point in time balance) at every transaction line | false |
selfieVerify | Allow users verify their identity with selfies to determine if the person holding device is the same person verifying their account. See more information on Selfie's here | false |
geoLocation | See your users 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 login 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 Options Include: | bvn |
manualUpload | Allow users to upload a bank statement that will be analyzed via OCR and available on your Okra dashboard.
| false |
ussd | Allow users login with USSD You must be using a compatible Android SDK that supports USSD. | false |
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' |
currency | Okra Wallet to Charge from | NGN |
identity_type | Unique Customer Identifier | BVN |
limit | Statement length (3-24) | 24 |
corporate | Should only display corporate bank's as well Options Include: | null |
institutions | The banks you would like to display to your user's, 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. E.g.
| none |
noPeriodic | When | |
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. | E.g |
displayQR | Display QR code option on payment widget Set false to hide QR option | true |
Updated 1 day ago