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

Debit-to-Credit Score

View how your customer spends and saves

Okra's Debit-to-Credit score compares how much your customers owe with how much they have. It typically includes monthly debt payments such as rent, mortgage, phone top-ups, auto payments, and other debt.

Calculate Debit-to-Credit Score

curl -X POST https://api.okra.ng/v2/products/dtc-score/calculate
-H 'Content-Type: application/json'
-d '{
        "customer": "5fe0a6f8ee69d878a679ef39"
    }'
const okra_client = require('okra-node');
okra_client.getCustomerDTI(accessToken, {customer_id:"5anh890978ddndk39"}, (err, results) => {
    // Handle err
    const products = results.products;
    });
{
    "status": "success",
    "message": "DTI successfully fetched",
    "data": {
        "dti": {
            "dti": 72
        }
    }
}

📘

Need a More Detailed Earning or Spending History?

Your customer's Debit-to-Credit (DTC) score can be used alongside our more robust Spending Patterns or Income & Revenue products to gain more insight into the important financial health factors that may be considered when determining if you will grant access to your goods or services.

Fetch Total Debits and Credits

Run in PostmanRun in Postman

curl -X POST https://api.okra.ng/v2/products/total-debits-credits
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <AccessToken>'
-d '{
        "account": "5fe0a6f8ee69d878a679ef39"
    }'
const okra_client = require('okra-node');
okra_client.getTotalDebitCredits(accessToken, {
    account: "51e763s23198a43"
}, (err, results) => {
        // Handle err
    const total = results.result;
    });
"status": "success",
    "message": "Record transactions credit & debit successfully retrieved",
    "data": {
        "result": {
            "credit": 19293.83,
            "debit": 28383.39
        }
    }
}

Updated about a month ago


Debit-to-Credit Score


View how your customer spends and saves

Suggested Edits are limited on API Reference Pages

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