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.

The benefactors API allows you to create a graph of transactions, linking each person’s transactions to another benefactor's transactions - to either trace money or detect fraud.

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

curl -X POST https://api.okra.ng/v2/products/benefactors/process
-H 'Content-Type: application/json' 
-H 'Authorization: Bearer <AccessToken>'
-d '{
  		account: "xxxxxxxxxxxxxxxx",
	 		customer: "xxxxxxxxxxxxxxxx",
      bank: "5fe0a6f8ee69d878a679ef39"
	}'

const okra_client = require("okra-node")
okra_client.processBenefactorsViaApi(accessToken {account: "xxxxxxxxxxxxxxxx",customer: "xxxxxxxxxxxxxxxx",bank: "5fe0a6f8ee69d878a679ef39" }, (err, results) => {
    // Handle err
    const benefactor = results.Benefactors;
    });

{
  "status":"success",
   "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."
    },
..............]
}

Make a benefactor request in real-time directly from our API reference.