Okra

What will you build with Okra?

Find out what you can build with Okra’s API through our documentation, SDKs and sample use cases.

Quickstart Guides

Learn more about Okra and integrate with your web or mobile app through our libraries & SDKs.

Get Started
UI frame

API Documentation

The Okra documentation is your guide for all things development.

Read the documentation
UI frame

Okra Apps

A no-code option to integrate and customise Okra with your apps.

Link with Okra Widget
UI frame

Guarantors

Combine guarantors with identity to give you extra security and shared liability

Overview

Combine guarantors and identity to give you extra security and shared liability before approving a disbursement. This can be critical when your customer does not have a strong credit profile, is involved in a high-risk job or does not meet the minimum monthly income criteria.

Using the Okra widget, you can allow your customer to add up to 3 guarantors. After linking their account, an SMS and/or email will be sent to each designated guarantor, who will then complete the widget authentication process. This grants you access to the guarantors’ Identity KYC profiles, Balances at the time of connecting, and the ability to collect Payments on their accounts in the event that the main applicant defaults.

Requesting Guarantors via Libraries & SDKs

Add options to enable any of our SDKs. Click here to view SDK integration docs.

Verifying biometric identity via your widget is pretty simple. Just add selfie and any of the optional nodes to your widget options as below:

const options = {
        ... {other widget options} ... 
        guarantors: {
        status: true,
        number: 3
        }
}

When completed, the widget will display the flow below:

Requesting Guarantors via Our API

When customers have linked, they will become full customers on your dashboard, and you will be able to view their connected data via the dash.

curl -X POST https://api.okra.ng/v2/products/guarantors/request
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <secretKey>'
-d '{
    customer: "123456789" // bvn or nuban or Okra customer ID
    guarantors: [{
        name: "GAVIN BELSON",
      email: "[email protected]"
    }, ...]
}'
const okra_client = require("okra-node")
okra_client.Gurantor(accessToken {customer: "insert customer ID", guarantors: [{
        name: "GAVIN BELSON",
      email: "[email protected]" }, (err, results) => {
    // Handle err
    const guarantor = results.guarantor;
    });

Updated about a month ago


What's Next

Want to learn about products records? check the next section

Product Records

Guarantors


Combine guarantors with identity to give you extra security and shared liability

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.