Account authentication

Make informed risk decisions and increase customer retention.


Verifying user's account ownership is vital in this digital era, because it builds trust, churns identity theft, and helps businesses building Fintech solutions make smarter decisions.

How to use the account endpoint

Okra's Account product lets you confirm the owner of a bank account by fetching real-time data using user account numbers, Nuban. The /products/accounts endpoint returns the real-time bank account information for each of your customers connected via Okra.

curl -X POST
-H 'Content-Type: application/json'
-H 'Authorisation: Bearer <secretKey>'

Request payload

Definition of All Payload Items from the Routes Below. This table contains all of the different keys you can pass on to the account endpoint.

page NumberPage of list you would like to fetch1
limit NumberNumber of Records you would like to fetch20
pdf BooleanSend back as PDFfalse
from DateYYYY-MM-DD
customer ObjectIdCustomer's Okra Unique ID
id ObjectIdUnique Okra Identity ID

Retrieve balance by value

By using the endpoint /accounts and append with any of the available routes, from the table in the next section

curl -X POST${route}
-H 'Content-Type: application/json'
-H 'Authorisation: Bearer <secretKey>'

List of Routes to use for value

RoutePayloadNode Function
/getByIdid to from pdfgetAccountById
/getByCustomercustomer to from pdfgetAccountByCustomer
/getByBankbank pdfgetAccountByBank
/getByDateto from pdfgetAccountByDate
/getByCustomerDatecustomer to from pdfgetAccountByCustomerDate

Checkout the account reference to test how it works.

Was this page helpful?