Account authentication
Retrieve account information from authenticated users.
Overview
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 https://api.okra.ng/v2/products/accounts
-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.
Key | Description | Default |
---|---|---|
pageNumber | Page of list you would like to fetch | 1 |
limitNumber | Number of Records you would like to fetch | 20 |
pdfBoolean | Send back as PDF | false |
toDate | YYYY-MM-DD | |
fromDate | YYYY-MM-DD | |
customerObjectId | Customer's Okra Unique ID | |
idObjectId | Unique 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 https://api.okra.ng/v2/accounts/${route}
-H 'Content-Type: application/json'
-H 'Authorisation: Bearer <secretKey>'
List of Routes to use for value
Route | Payload | Node Function |
---|---|---|
/getById | id to from pdf | getAccountById |
/getByCustomer | customer to from pdf | getAccountByCustomer |
/getByBank | bank pdf | getAccountByBank |
/getByDate | to from pdf | getAccountByDate |
/getByCustomerDate | customer to from pdf | getAccountByCustomerDate |
Checkout the account reference to test how it works.
Updated over 1 year ago