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

Benefactors

Overview

Benefactors are either people to whom you send money or people who send you money. Okra’s machine-learning models are constantly evolving to learn who the benefactors are from a user's transactions.

📘

Not a Developer?

You can turn on Benefactors by simply toggling a switch within the Add-on tab or the inner Transactions page of any of your customers.

We provide these benefactors to you to create a graph of transactions, linking each person’s transactions to another benefactor's transactions - to either trace money and detect fraud. Pretty neat, right?

curl -X POST https://api.okra.ng/v2/products/benefactors/process
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <AccessToken>'
-d '{
        account: "5fe0a6f8ee69d878a679ef39",
            customer: "5fe0a6f8ee69d878a679ef39",
      bank: "5fe0a6f8ee69d878a679ef39"
    }'
const okra_client = require("okra-node")
okra_client.processBenefactorsViaApi(accessToken {account: "5fe0a6f8ee69d878a679ef39",customer: "5fe0a6f8ee69d878a679ef39",bank: "5fe0a6f8ee69d878a679ef39" }, (err, results) => {
    // Handle err
    const benefactor = results.Benefactors;
    });
{
  "status":"error",
   "message":"Benefeciaries Successfully Fetched",
   "data":[{
      "_id":"5fe0a6f8ee69d878a679ef39",
      "bank":{
        "_id":"5d6fe57a4099cc4b210bbeb3",
        "icon":"https:\/\/okra-images.s3.eu-west-3.amazonaws.com\/Guaranty+Trust+Bank+Logo+Color.svg",
        "logo":"https:\/\/okra-images.s3.eu-west-3.amazonaws.com\/GT+Bank.svg",
        "name":"Guaranty Trust Bank"
      },
      "nuban":"0037218116",
      "name":"GAVIN BELSON"
    },
    {
      "_id":"5fe0a6f8ee69d878a679ef39",
      "bank":{
        "_id":"5d6fe57a4099cc4b210bbeb3",
        "icon":"https:\/\/okra-images.s3.eu-west-3.amazonaws.com\/Guaranty+Trust+Bank+Logo+Color.svg",
        "logo":"https:\/\/okra-images.s3.eu-west-3.amazonaws.com\/GT+Bank.svg",
        "name":"Guaranty Trust Bank"
      },
      "nuban":"0321424597",
      "name":"PIED PIPER CO."
    },
..............]
}

Run in PostmanRun in Postman

Updated about a month ago


What's Next

Next

Transaction Networks

Benefactors


Suggested Edits are limited on API Reference Pages

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