Remember, we’re here to help. If you get stuck or have any questions, reach out to our support team. Happy coding!
# Webhooks ## Overview Webhooks provide a way for your application to receive real time notifications about events from our API endpoints. With webhooks, you don’t have to constantly check for updates manually and your application is able to perform certain actions based on the response from our endpoints. ## Setting up webhooks To set up webhooks with our API, you would need to create a URL on your server to handle the incoming webhook data. Once this is created, it can be configured with our APIs. ### Here’s how you do it. * When [creating an app](/introduction/getting-started#step-3-get-your-api-keys), there is an option for webhook URL * Ensure to put in the desired webhook URL * Save and you’re good to go Once this is set up, you are able to configure this in your application thus notifying you and/or performing certain actions based on the output.
# Authentication Type Here, you will find everything you need for verification before accessing Adjútor ## Overview The Adjútor API service requires authentication to be able to consume the services. Authentication is performed via Bearer Authentication. {% hint style="info" %} #### Notes * The access token being referred to is the API key * Every endpoint requires authentication, so you will need to add the following header to authenticate each request:\ `Authorization: Bearer` {{access\_token}} * Authentication to the API is performed via [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication). * All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). Note that calls made over plain HTTP will fail. * API requests without authentication will also fail. {% endhint %} # Generating your API key Here, you will find everything you need for verification before accessing Adjútor The steps are the same as defined in the [Getting Started](/introduction/getting-started) section. But for the sake of a refresher, find the steps below: 1. Log in to your dashboard at
# Corporate Cash and Treasury Management Ensure efficient Cash and Treasury management in your business thus optimizing your cash flow and financial assets in order to ensure liquidity, reduce risks and maximize returns. ## **How this works:** 1. **Cash Management:** * **Checking Balances:** Our Direct Debit and Kolo APIs provide real time insights into all your bank accounts, giving you the opportunity to monitor your balances on a daily basis and ensure sufficient funds for your day-to-day operations. * **Transferring Funds:** With our Direct Debit APIs, you can automatically move excess funds from one account to another thus maintaining optimal cash levels across all your accounts. 2. **Treasury Management:** * **Saving Extra Money:** With your Direct Debit APIs, transfer surplus funds to high-yield savings or investment accounts, ensuring your money works for you. * **Monitoring and Compliance:** Maintain oversight of your funds to comply with financial regulations and corporate policies. Our Direct Debit and Kolo APIs help you streamline your financial operations, ensuring your funds are managed efficiently, and enabling better financial health for your company. # Buy Now Pay Later (BNPL) Enhance your customers' experience with our Buy Now Pay Later (BNPL) service. BNPL allows your customers to make purchases immediately (Buy Now) and pay for them in installments (Pay Later). This flexible payment option not only boosts sales but also increases customer satisfaction and loyalty. ## **How It Works:** 1. **Seamless Integration:** Integrate our verification, scoring and payment APIs into your e-commerce platforms effortlessly. With these integrated, you can offer BNPL as a payment option at checkout. 2. **Instant Approval:** Our scoring APIs processes customer information in real-time, providing instant approval or denial for BNPL requests. However, it is up to you to configure this to be an instant approval or a manual process. Either way, this quick process enhances your customer's experience. 3. **Flexible Payment Plans:** Customize payment plans to fit your business model. Whether it's daily, weekly, or monthly installments, our API supports a variety of schedules to meet the diverse needs of your customers. With our APIs you are able to efficiently manage your BNPL business leading to an increase in sales, reduction of Non-Performing Loans (NPL) and improvement in customer satisfaction. You can read this article for more insight into how our APIs can enable BNPL on your platform:
# Loan scoring/ Credit scoring One of the biggest fears of any lender is giving loans to a borrower who won’t pay back. This is why evaluating the creditworthiness of borrowers is highly essential for making informed lending decisions. With our decisioning and credit scoring APIs, lenders are provided with a reliable and efficient way to access borrowers credit data, thus minimizing risk and making much better lending decisions. ## How this works * Your customers provide you with data which are valuable for scoring. This includes BVN and phone number. * Using this data, you can check our database of bad actors (Karma) to confirm if such customer has been previously reported by a lender in the ecosystem. * With our vast ecosystem of customer data, you can confirm the customer activity with other borrowers and configure the kind of customers you’d like to provide loans to. * Adjutor provides connections with the FirstCentral and CRC Credit Bureaus. Check for customer’s records and retrieve comprehensive credit reports to aid your decisioning.
With these layers of scoring embedded in your platform, you are sure to enhance your lending processes thus making better-informed decisions, and minimizing financial risks.
# Customer Validation Verify your customer's identity with our APIs and protect your business from fraudulent customers. Our API simplifies the verification process, making it quick and efficient while maintaining a high level of security. ## How this works * Your borrowers provide you with their information during sign up. * To confirm customer identity, verify BVN with customer's date of birth and phone number. * Perform liveliness check by comparing customer's live image with image linked to the customer's BVN. * Once a possible fraud is detected, prevent the customer from going ahead with sign up or loan application. * Confirm identification documents uploaded using Real-Time ID Verification By integrating our customer validation APIs, you can be rest assured that the security and efficiency of your business is ensured.
# Implementing GSI with Direct Debit GSI (Global Standing Instruction) was created by the Central Bank of Nigeria (CBN) as a last resort for banks and financial institutions to recover outstanding loans from chronic debtors. It allows the creditor bank (the bank that gave the loan) to recover their debt from any or all other accounts held by the borrower with other financial institutions in the case of default. ## Objectives of GSI: * Facilitate an improved credit repayment culture. * Reduce Non-Performing Loans (NPLs) in the banking industry. * Watch-list consistent loan defaulters. ## How this works: **Borrower Authorization**: The borrower authorizes the lender to recover outstanding debts automatically from their bank accounts across different financial institutions. **Linking Accounts**: The borrower must link all qualifying bank accounts to their Bank Verification Number (BVN). **Triggering GSI**: In case of default, the creditor bank triggers the GSI, which initiates a balance enquiry and issues debit instructions to other financial institutions holding the borrower's accounts. **Executing Debit**: The Nigeria Inter-Bank Settlement System (NIBSS) facilitates the transfer of funds from the borrower's accounts in other banks to the creditor bank.
This use of GSI helps lenders recover outstanding debts from your customers who have funds in other bank accounts, ensuring efficient debt recovery and reducing defaults. # Oraculi Mobile SDK (Beta) ## Introduction Oraculi is the Lendsqr underwriting scoring engine. Oraculi means The Oracle in Latin. Lendsqr Oraculi provides a RESTful API for accessing user data gathered from your customer’s phones with the SDK you have embedded. The Oraculi SDK provides an effective insight into Android customers of lenders. {% hint style="info" %} The SDK is only available for Android phones. {% endhint %} This documentation, and the approach described here, are in Beta. They are subject to change as we take feedback from pilot lenders. {% hint style="warning" %} Note If you wish to use this service, kindly reach out to
The Oraculi SDK data journey
| Bank Account Verification | This endpoint is used for verification of a bank account. | |
| Karma Lookup | This endpoint is used to search for the identity of a bad actor using identifying information such as phone number, email, domain name, BVN, card signature, and images. | |
| Ecosystem Lookup | Confirm users' credit history and behaviour across the Lendsqr ecosystem |
| Name | Description |
|---|---|
| Initialize BVN Consent | This endpoint is used to initiate the process for getting the customer's consent |
| Complete consent and get BVN details | This endpoint is used to get the BVN data after the customer's consent has been approved. |
| Match Customer BVN Image | This endpoint allows for real-time verification of an individual's Bank Verification Number (BVN) through the comparison of their photograph and facial features with their BVN record |
| Verify customer account | This endpoint is used for verification of a customer's bank account. |
You can read more about our Decision Model at the [Lendsqr Help Center](https://lendsqr.freshdesk.com/support/solutions/44000816023). Learn more about these endpoints [here](https://api.adjutor.io/#3c00f132-8d60-4a29-b8bc-4c2ac5a753dc) # Decision Model Lookup {% hint style="success" %} Summary With these services, you are able to view existing decision models created by your business. {% endhint %} ## Introduction Decisioning is a very important part of the lending cycle, which is why Adjutor provides endpoints that allow you fetch all the decision models that you have configured on the Lendsqr platform. Below are the API services available for usage:
| API Endpoint | Description |
|---|---|
| Get all decision models | This endpoint fetches all the decision models that you have configured on the Lendsqr platform. |
| Get details of a single decision model | This endpoint fetches an individual decision model and its settings that have been configured on your platform. |
# Direct Debit All you need to know about creating, activating and debiting a mandate.
| How Direct Debit works | Understand all you need to know about Direct Debit. | |
| The Direct Debit process | Explore the full Direct debit from creation to activation. | |
| Understanding Mandate Statuses | Explore each of the mandate statuses and what they mean. |
The system automatically assigns a unique mandate code to each initiated mandate. This mandate code is used to initiate a direct debit transaction on the bank account associated with the debit mandate instruction. # The Direct Debit process Direct debit mandates follow a streamlined process that may take at least 2 hours from activation to when they are available for debits. These steps are: * Mandate creation * Mandate activation * Setup for debit * Transactions ## Mandate creation The first step is the creation of a mandate using the API defined in this collection. As soon as the mandate is created, you should inform the customer of the next steps about how to activate the mandate. From a best practices point of view, the customer should be informed on your app, by email, and SMS. ## Mandate activation Activation of the mandate is usually done by the transfer of a N50 (or N100 for banks where the minimum transfer amount is N100) to designated bank accounts operated by NIBSS. The customer has 168 hours (7 days) to send this amount if not the mandate is automatically canceled. Immediately the activation amount is received at either of the banks, the mandate is automatically activated. However, it is not available for debit at this time. ## Banks for mandate activation The following are the authorized banks which customers should use for direct debit mandate activation. | Fidelity Bank | Paystack Titan | | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | |
Account: 9020025928
Bank: Fidelity Bank Plc.
You can transfer from USSD, mobile app or internet banking
|Account: 9880218357
Bank: Paystack-Titan
You can transfer from your mobile app and internet banking
| ## Setup for debit There are usually some backend processes done by NIBSS that then processes the accounts for debit and this may take up to 2 hours before completion. If you try to debit the mandate before this time, it would return an error message such as "do not honor".# Understanding Mandate Statuses This guide will walk you through mandate statuses help you understand the various statuses and their descriptions. | Status | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Pending Mandate Activation | When a mandate is initially created, it will be marked as "Pending Mandate Activation." | | Pending |
Once your customer transfers the N50 fee to the bank account and it is received, the status changes to "Pending." The system then attempts to debit the customer’s account a fee of 100 naira to confirm sufficient funds.
The system will continue trying to debit the customer’s account until successful. You can click on each transaction to view the failure description and get guidance on how to assist the customer in activating the mandate successfully.
| ## Common Transaction Descriptions | Status | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Do Not Honor | This occurs when the customer has placed a restriction on their bank account or the bank is unable to process the transaction at that moment. In this case, wait an hour or two after receiving a notification email from dd.lendsqr.com before reaching out to the customer. | | Insufficient Funds | If the account lacks sufficient funds, this will be indicated under the transaction description. You should contact the customer and advise them to fund their account to enable successful mandate activation. |*** # Embedded Loans and Payments ## About Embedded loans and payments offers third-party distributors with Lendsqr the option to offer loans and payment options to customers on their platform outside Lendsqr. It is a way to ensure a seamless experience for your customers via Lendsqr's services and lenders. ## Embedded Loans With embedded loans, you can fuel Buy-Now-Pay-Later projects or generic loan services on your platform. Lendsqr's lenders are equipped to perform adequate KYC and power the loans that you give to your customers to service their needs on your platform. In the case of BNPL projects, increase your checkout rate as customers are now assured of loans to finance their purchases. ## Embedded Payments With embedded payments, customers don't need to get loans with a Lendsqr lender. Provided that you have established a relationship with one of our lenders, your customers can now easily pay for purchases using the funds in their account with your partnered lender. This will make payments and checkout on your platform super seamless and easy. Embedded loans allows you as a third-party to offer loan services to your customers on your platform without having to be a lender yourself. These loans are typically powered by the lenders on the Lendsqr platform. Note: Embedded payments only serve for checkout services. ## Getting started * Sign up on pecunia.lendsqr.com and contact
| Data for Lenders | Explore data available to lenders via our APIs | |
| Operational Services | Understand how to monitor the API performance. |
| API Endpoint | Description |
|---|---|
| Get Options | This endpoint is used to get the data options or sources available for a lender. With the options gotten from the response, you are able to get data relevant to you. |
| API Endpoint | Description |
|---|---|
| Get Pricing | This endpoint is used to obtain the current pricing of the API services. Kindly note that pricing may be different from lender to lender due to commercial negotiations that could have provide some lenders with a different pricing due to volume commitment. |
| Get Wallet | This request is used to obtain the wallet information on the lender's profile. |
| Get API Audit Logs | This endpoint is used to get the audit logs of the API calls made on the profile. It is currently under development |
| Get Status Check | This endpoint is used to obtain the status of systems under Adjutor. |
Kolo permissions page