Adjutor is an API-as-a-Service platform by Lendsqr, designed for lenders and fintechs looking to power their technology stack and enable critical lending capabilities.
\nThe Adjutor API is structured around REST, featuring predictable, resource-oriented URLs. Our APIs accept JSON-encoded request bodies, return standard HTTP response codes with JSON-formatted responses, and use API key-based authentication for secure access.
\nWith Adjutor, you can verify borrowers, score credit, automate collections, and manage both customers and loans through a unified API interface.
\nA test mode is also available, allowing you to simulate requests without impacting live systems or production data.
\nAccess to our APIs is easy.
\nSign up on the Adjutor Web App.
\nNavigate to the App section.
\nSelect the services you want to access.
\nCreate your API Key.
\nTo use Lendsqr Adjutor APIs, you must agree to our terms of use. These terms outline the conditions under which you may access and use our API. Please review these terms carefully before using our API. If you have any questions or concerns about these terms, please contact us at support@lendsqr.com.
\nYou read about our terms here.
\nIf you require assistance at any time when using this documentation or the services, please email support@lendsqr.com and someone would be in touch with you as soon as possible. If you are currently using Lendsqr to lend, you can also contact your account manager at growth@lendsqr.com.
\nAuthentication to the Adjutor API service is performed using an API key. Every endpoint requires authentication, so each request must include the following HTTP header:
\nAuthorization: Bearer
base_url: https://adjutor.lendsqr.com/v2/
The resources an API key can access are determined by the API scope selected during the key’s creation. You can manage your API keys and their scopes, as well as toggle between live mode and test mode, directly within the Adjutor web app. This allows you to control which resources and environments your API key accesses.
\nAll of the API responses returned are in JSON format, with these data types defined below:
\nstring
A UTF-8 encoded string
number
An integer
datetime
An ISO8601 encoded DateTime. All datetimes are returned in UTC with offset +00:00
decimal
Monetary values are returned with up to two decimal places and may be positive or negative (e.g., 20.78, -32.50)
status ˢᵗʳⁱⁿᵍ
Indicates the result of the API call. Common values are \"success\" or \"error\"
message ˢᵗʳⁱⁿᵍ
A descriptive message about the response.
data ᵃʳʳᵃʸ
An array containing various resource objects relevant to the request.
meta ᵒᵇʲᵉᶜᵗ
Includes additional context or details, such as pagination info, cost of API call and remaining balance.
Errors in Adjutor are communicated using standard HTTP status codes along with a JSON response body that provides additional details where available. You can generally rely on the HTTP status code alone to understand the outcome of a request.
\nLike many modern APIs, Adjutor follows conventional HTTP response code practices: codes in the 2xx range indicate success, codes in the 4xx range represent client errors such as missing parameters or invalid requests, and codes in the 5xx range indicate rare server-side errors.
\nerror_code ⁱⁿᵗᵉᵍᵉʳ
A specific numeric code identifying the error type.
message ˢᵗʳⁱⁿᵍ
A human-readable message as to the specifics of the problem.
200 OK — The request was successful, and everything worked as expected.
400 Bad Request — The request was invalid or missing a required parameter.
401 Unauthorized — No valid API key provided or authentication failed.
403 Forbidden — Your API key does not have permission to perform the requested action.
404 Not Found — The requested resource does not exist.
409 Conflict — The request conflicts with another request, e.g, creating a user that already exists.
500, 502, 503, 504 Server Errors — Something went wrong on Adjutor's end.
We experiment a lot at Lendsqr and some of our APIs are still under development. However, to aid, these APIs are marked with [BETA] to denote their status. Please, do not use any of our beta APIs for production grade work as they may fail or have unexpected behaviors.
\nCreate a new customer with the provided details, including phone number, BVN, email, address, and associated documents.
\nphone_number * ˢᵗʳⁱⁿᵍ
Customer's phone number in the format 2348012345678
bvn * ˢᵗʳⁱⁿᵍ
This is the Bank Verification Number (BVN) of the customer.
bvn_phone_number * ˢᵗʳⁱⁿᵍ
This is the phone number attached to their BVN.
dob * ˢᵗʳⁱⁿᵍ
Date of birth in YYYY-MM-DD format. Must match BVN record.
email * ˢᵗʳⁱⁿᵍ
Email address of the customer
account_number * ˢᵗʳⁱⁿᵍ
Account number of the customer
bank_code * ˢᵗʳⁱⁿᵍ
Bank code for the account to identify the customer’s bank. Run Get List of Banks to see supported codes
state_id ˢᵗʳⁱⁿᵍ
ID of the state the customer resides. Run Get List of States to get list of states and their ID's
lga_id ˢᵗʳⁱⁿᵍ
ID of the local government area the customer resides. Run Get List of LGAs to get the list of lga's for specific states.
city * ˢᵗʳⁱⁿᵍ
Name of the city the customer resides
address * ˢᵗʳⁱⁿᵍ
Address of the customer.
photo_url * ˢᵗʳⁱⁿᵍ
URL to the customer's photo.
documents * ᵃʳʳᵃʸ
An array of customer documents, each with a url, type_id, and sub_type_id. The document types supported are under the Documents definition.
The endpoint returns the details of the newly created customer with the following properties:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Activate a customer with their unique ID after creation to enable access to loan functionalities and other associated actions.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This should be called immediately after the customer is created.
\n
Retrieve a list of all customers. This endpoint returns comprehensive customer data, which can be filtered or paginated as required.
\nThe users array contains user details. Each object represents a user with the following properties:
Retrieve detailed information for a single customer by their unique ID.
\nUpdate the information of an existing customer using their unique ID. Only the fields provided in the request body will be updated.
\nThe request body must contain one or more of the following editable fields:
\nfirst_name * ˢᵗʳⁱⁿᵍ
Customer's first name
last_name * ˢᵗʳⁱⁿᵍ
Customer's last name
email * ˢᵗʳⁱⁿᵍ
Email address of the customer
phone_number * ˢᵗʳⁱⁿᵍ
Customer's phone number in the format 2348012345678
manager_id * ⁱⁿᵗᵉᵍᵉʳ
ID of the assigned manager
office_id * ⁱⁿᵗᵉᵍᵉʳ
ID of the assigned office
address * ˢᵗʳⁱⁿᵍ
Address of the customer.
photo_url * ˢᵗʳⁱⁿᵍ
URL to the customer's photo.
documents * ᵃʳʳᵃʸ
An array of customer documents, each with a url, type_id, and sub_type_id. The document types supported are under the Documents definition.
The endpoint returns the details of a newly updated customer with the following properties:
\nRetrieve logs related to a specific customer's activities by their unique ID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This section includes APIs related to customer management. It allows for creating, retrieving, updating, and deleting customer information, as well as managing customer profiles and documents. These APIs provide essential tools for handling customer data efficiently.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\r",""],"id":"ff1a3c0d-8996-4a27-94ee-0e190fd403c4"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ca990d34-ddff-4b03-a85c-db5a8b3f8c63"}}],"_postman_id":"675ec8dd-90e7-4c0d-8560-1bd4b91fe845","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of bank accounts associated with a specific customer by their unique ID. This endpoint is useful for displaying current bank account details on user profiles or for auditing purposes.
\nResponse: Returns an array of bank accounts, including details such as account number, bank code, and account name.
\ndetails)Add a new bank account for a specific customer by their unique ID.
\nRequest: Requires bank account details including account number, bank code, account name, and account type.
\nResponse: Confirms the addition of the bank account or returns an error if the operation fails.
\naccount_number * ˢᵗʳⁱⁿᵍ
The user's bank account number (10 digits).
bank_code * ˢᵗʳⁱⁿᵍ
The code representing the bank. You can get the bank code definitions from Get list of banks.
account_name * ˢᵗʳⁱⁿᵍ
The name on the bank account.
account_type * ˢᵗʳⁱⁿᵍ
The type of account (e.g., \"bank\").
details)Delete a specific bank account associated with a customer by their unique ID and the bank account ID.
\nResponse: Confirms the deletion of the bank account or provides an error message if the deletion could not be processed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"APIs in this section manage customer bank accounts. They include endpoints for retrieving, adding, and deleting bank accounts associated with a customer. These APIs enable efficient management of customer bank account details, ensuring accurate and up-to-date information is maintained.
\n","_postman_id":"f39ec966-b8aa-4530-86e8-e5303160ffaf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of available loan products.
\nGet the eligibility of a customer for a loan by scoring them against the loan product's decision model.
\n\n\nA decision model is a set of rules that encapsulate the risk acceptance criteria for a lender to make a loan decision. In Lendsqr, these rules or decision models are processed by our service called Oraculi. Learn more.
\n
product_id * ⁱⁿᵗᵉᵍᵉʳ
The ID of the loan product.
bvn * ˢᵗʳⁱⁿᵍ
The Bank Verification Number of the applicant.
requested_amount * ⁱⁿᵗᵉᵍᵉʳ
The amount the user is requesting for.
location * ˢᵗʳⁱⁿᵍ
The applicant's location.
data Objectdecision_data Objectoffers Objectoffers.data Array Itemsoraculi Array Itemsoraculi.meta Objectoraculi.data Array Itemsloan_profile ObjectRetrieves details of a loan taken by a customer. It requires both the loan's unique ID.
\nstatus Object:approver Object:schedules Array:loan_transactions Array:Retrieves the list of all loans taken by a specific customer based on their unique ID.
\nBook a loan using the details of the customer.
\nbvn * ˢᵗʳⁱⁿᵍ
11-digit Bank Verification Number.
requested_amount * ⁱⁿᵗᵉᵍᵉʳ
Loan amount requested.
proposed_tenor * ⁱⁿᵗᵉᵍᵉʳ
Duration of the loan.
proposed_tenor_period ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Period unit for the tenor (days, weeks, months).
purpose ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Reason for requesting the loan (e.g., \"Home renovation\").
marital_status ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Marital status
Values supported: Single, Married, Divorced, Widowed, Separated
no_of_dependent ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Number of dependents (e.g., 0, 1, 2, etc).
type_of_residence ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Type of residence
Values supported: Own House, Parents Apartment, Rented Apartment
educational_attainment ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Highest level of education
Values supported: BSc, HND and Other Equivalents, Undergraduate, Others, Diploma/School Cert, MSc and Above
sector_of_employment ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Industry of employment
Values supported: _Agriculture, Banking, Education, Healthcare, Hospitality and Events, Information Technology, Law, Manufacturing and Construction, Media & Entertainment, NGO, Oil and Gas, Other Financial, Others: Public services and administration, Telecoms, Tourism & Hospitality,_Transportation & Logistics, Wholesale and Retail Trade
monthly_net_income ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Monthly take-home salary.
proposed_payday ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Proposed loan repayment start date (YYYY-MM-DD).
employment_status ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Current employment status
Values supported: Employed, Self Employed, Unemployed
work_start_date ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Date employment started (YYYY-MM-DD).
work_email ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Work email address. Can be an empty string.
current_employer ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Name of the current employer.
employment_category ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Type of employment (Artisan, Private Company, Public, etc.).
product_id * ⁱⁿᵗᵉᵍᵉʳ
ID of the loan product being applied for.
disburse_to ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Where the loan should be disbursed (bank, wallet, third-party, restrictedd-wallet).
Defaults to bank.
Learn more
location ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Borrower’s location (e.g., \"Lagos\"). Can be an empty string.
Book a loan for a customer with customized multi-tenor repayment schedules.
\nbvn * ˢᵗʳⁱⁿᵍ
11-digit Bank Verification Number.
requested_amount * ⁱⁿᵗᵉᵍᵉʳ
Loan amount requested.
proposed_tenor * ⁱⁿᵗᵉᵍᵉʳ
Duration of the loan.
proposed_tenor_period ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Period unit for the tenor (days, weeks, months).
purpose ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Reason for requesting the loan (e.g., \"Home renovation\").
marital_status ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Marital status
Values supported: Single, Married, Divorced, Widowed, Separated
no_of_dependent ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Number of dependents (e.g., 0, 1, 2, etc).
type_of_residence ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Type of residence
Values supported: Own House, Parents Apartment, Rented Apartment
educational_attainment ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Highest level of education
Values supported: BSc, HND and Other Equivalents, Undergraduate, Others, Diploma/School Cert, MSc and Above
schedules * ᵃʳʳᵃʸ
List of repayment schedules.
principal * ⁱⁿᵗᵉᵍᵉʳ
Principal to be repaid for each schedule.
interest * ⁱⁿᵗᵉᵍᵉʳ
Interest to be repaid for each schedule.
fees ⁿᵘˡˡᵃᵇˡᵉ ⁱⁿᵗᵉᵍᵉʳ
Fees to be repaid for each schedule.
status * ˢᵗʳⁱⁿᵍ
Status of each repayment schedule
Values supported: pending
due_date ˢᵗʳⁱⁿᵍ
A valid ISO 8601 date.
Approve a loan booked for a customer using the loan's unique ID.
\nbeneficiary_id ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Unique ID of the beneficiary.
account_number ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Recipient's bank account number. Defaults to \"\".
bank_code ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Code identifying the recipient's bank. Defaults to \"\".
disbursement_provider ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Provider handling the disbursement. Defaults to \"\".
account_name ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Name associated with the bank account. Defaults to \"\".
beneficiary_email ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Email of the beneficiary. Defaults to \"\".
beneficiary_phone_number ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Phone number of the beneficiary. Defaults to \"\".
bank_name ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Name of the beneficiary’s bank. Defaults to \"\".
attributes ᵒᵇʲᵉᶜᵗ
Additional loan attributes in key-value pairs.
attributes.key1 ˢᵗʳⁱⁿᵍ
Custom attribute key-value pair.
attributes.key2 ˢᵗʳⁱⁿᵍ
Custom attribute key-value pair.
Repay a specific loan for a customer by the loan ID.
\namount * ᶠˡᵒᵃᵗ
The repayment amount.
comment ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
A note or reference for the payment (e.g., \"Payment for invoice #12345\").
reference ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Unique transaction reference.
channel * ˢᵗʳⁱⁿᵍ
Payment method used (bank_transfer, card, wallet, direct_debit, etc.)
\n\nbank_transfer: repayment done externally, no debit made
\n
wallet: debits from user's wallet or virtual account
card / direct_debit: debits from the linked card or direct debit source
This section contains APIs related to loan management. It includes endpoints for retrieving loan products, scoring loan applications, getting loan schedules, booking loans, retrieving customer loans, and repaying loans.
\n","_postman_id":"96195370-bc7c-4cba-a920-ed8eb9aa6018","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of wallets created for a customer by their unique ID.
\nRetrieve a list of transactions for a specific wallet by the customer's unique ID and the wallet ID.
\nThis section provides APIs for managing customer wallets. It includes endpoints for retrieving wallets, retrieving wallet transactions, and transferring funds to customer wallets. These APIs enable comprehensive management of virtual wallets and transactions.
\n","_postman_id":"a74e49ed-596f-4490-b14a-ef771c517ae3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of cards associated with a specific customer by their unique ID.
\nDeactivate a specific card associated with a customer by their unique ID and the card ID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Delete a specific card associated with a customer by their unique ID and the card ID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"APIs in this section manage customer cards. It includes endpoints for retrieving, deactivating, and deleting cards associated with a customer.
\n","_postman_id":"05f3ac01-0250-4943-8305-d3b805841e0c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of direct debit mandates associated with a specific customer by their unique ID.
\nCreate a new direct debit mandate for a specific customer. To learn more about how NIBSS direct debit mandate work, visit here.
\nRequest: Requires customer details, bank account information, and mandate specifics such as amount and frequency.
\nResponse: Returns the details of the newly created mandate, including its unique identifier and status.
\naccount_number * ˢᵗʳⁱⁿᵍ
Customer NUBAN account number to create the mandate against.
bank_code * ˢᵗʳⁱⁿᵍ
Bank code of the account number.
List of supported banks
amount * ᶠˡᵒᵃᵗ
Maximum amount that can be debited on the mandate at a single time.
start_date * ˢᵗʳⁱⁿᵍ
Start date of the mandate in ISO format (YYYY-MM-DD).
Mandates cannot be triggered for transactions before this date.
user_id * ˢᵗʳⁱⁿᵍ
Unique ID of the customer the mandate is created for.
Activate a specific direct debit mandate for a customer by the mandate ID.
\n\n\nYou can only activate an already deactivated mandate.
\n
Deactivate a specific direct debit mandate for a customer by the mandate ID.
\n\n\nYou can only deactivate an active mandate. Deactivating a mandate means temporarily stopping the mandate from being debited.
\n
Cancel a specific direct debit mandate for a customer by their unique ID and the mandate ID.
\n\n\nCanceling a direct debit mandate has significant implications. It halts all future automatic debits from the payer's account, which may impact loan repayments, subscriptions, or other scheduled payments. Lenders and service providers must be aware that a canceled mandate requires alternative payment arrangements to prevent default or service disruptions. Below is the structured response detailing the properties of a canceled mandate.
\n
This section provides APIs for managing direct debit mandates. It includes endpoints to create, activate, deactivate, and cancel direct debit mandates for customers.
\n","_postman_id":"da69c2bf-d60d-4389-85bf-ad0a1f7c92fe","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to retrieve all the loan products a distributor is subscribed to. As mentioned, this could be one or multiple loan product(s) from a single lender or multiple loan products from multiple lenders.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Using the product ID that has been retrieved from the GET loan products endpoint, make a call to this endpoint to generate the web page URL that can be embedded within your web or mobile platform.
\nThe request body also allows for meta fields that would prepoulate and disable these form fields within the the web page
\n\n\nNOTE: All fields on the web page would be disabled except email and phone number as these details may be different on the lender's plaform.
\n
requested_amount * ᶠˡᵒᵃᵗ
Amount the customer wants to check out with (BNPL) or has requested. Currency is in Naira.
proposed_tenor * ⁱⁿᵗᵉᵍᵉʳ
Duration of the loan before repayment kicks in. Must fall within the product-defined range.
proposed_tenor_period * ˢᵗʳⁱⁿᵍ
Time unit for proposed_tenor
Values supported: days, weeks, months
gender * ˢᵗʳⁱⁿᵍ
Values supported: male, female
marital_status * ˢᵗʳⁱⁿᵍ
Values supported: married, single, divorced, separated, widowed
location * ˢᵗʳⁱⁿᵍ
Residential state of the user. Example: Lagos, Oyo, etc.
no_of_dependent * ⁱⁿᵗᵉᵍᵉʳ
Number of dependents.
type_of_residence * ˢᵗʳⁱⁿᵍ
Values supported: own house, rented apartment, parents apartment
education_attainment * ˢᵗʳⁱⁿᵍ
Values supported: MSc and above, BSc, HND and Other Equivalent, Diploma/School Cert,
Others
employment_status * ˢᵗʳⁱⁿᵍ
Values supported: employed, self employed, unemployed, retired
bvn * ˢᵗʳⁱⁿᵍ
User’s 11-digit Bank Verification Number
phone_number * ˢᵗʳⁱⁿᵍ
User's phone number
working_period ⁱⁿᵗᵉᵍᵉʳ
Total working experience in years.
time_with_current_employer ⁱⁿᵗᵉᵍᵉʳ
Years spent with current employer.
bvn_phone ˢᵗʳⁱⁿᵍ
Phone number linked to BVN
official_email ˢᵗʳⁱⁿᵍ
Official email address
personal_email ˢᵗʳⁱⁿᵍ
Personal email address
amount ˢᵗʳⁱⁿᵍ
Amount value
This endpoint is used to retrieve the details of a loan or loan request made via your platform as a distributor.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"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.
\n","event":[{"listen":"prerequest","script":{"id":"d4b3cedc-b105-4c47-a586-d597f5440e74","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6057767-0ff3-4a0a-b77c-7a12e2f58775","type":"text/javascript","exec":[""]}}],"_postman_id":"18f1572f-bf7f-46b3-8191-5787a048b550","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint generates the payment link that would open a web page that would allow customers to log into the lender's account and initiate the relevant payment.
\nYou would provide us with a callback URL that would serve as a redirect for customers once payment has been made.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to query the details of the payment made.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Our Pay with Wallet solution allows your customers to make payment for their purchases via various account holding platforms. This solution is viable to customers who have accounts with a lender, on the Lendsqr platform that is activated for this program.
\n","_postman_id":"34056f44-01be-4b8b-a5b7-30bdfa798233","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"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.
\n","_postman_id":"e362f9c8-6bdd-4569-89fb-1ffd6a3822d9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to get the data options or sources available for a lender.
\nBorrowers and other customers generate a lot of data that are important for lenders outside of the Lendsqr ecosystem. Lendsqr allows lenders to use Adjutor APIs to get these data.
\nThere are almost infinite limits to the data a lender can get for their customers, transactions, audit activities, etc.
\n","_postman_id":"ed72d4c5-bba8-44b0-8905-67aeb1476d32","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"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.
\nIf you want a cheaper price, which usually comes with a minimum monthly spend, please contact your account manager at growth@lendsqr.com.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This request is used to obtain the wallet information on the lender's profile.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to get the audit logs of the API calls made on the profile.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to obtain the status of systems under Adjutor.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"These endpoints are a collection of APIs to be used by a lender or an integrator to get information about their accounts, profiles, and wallet balances.
\n","_postman_id":"8a7d28e5-e4b6-4c15-ad9f-1b6adfdfb884","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used for getting banks and their codes.
\nThis endpoint is used to retrieve states and their corresponding IDs.
\nThis endpoint is used for getting the Local Government Areas (LGAs) for each state
\nEndpoints to fetch lists of banks, Nigerian states, and local government areas for standard data validation.
\n","_postman_id":"0d495f31-5485-43d6-8b45-bbdfd47d9e6f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The Utilities module provides essential support services for lenders and integrators outside the Lendsqr ecosystem.
\n\n\n","_postman_id":"a536e839-a3f9-4add-9039-34d94819e39b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Data for Lenders: Access borrower and customer data via Adjutor APIs, designed for lenders outside the Lendsqr ecosystem.
\n
Operational Service: Retrieve key information like account details, profile info, and wallet balances for seamless operational integration.
Bank, State, and LGA Directory: Endpoints to fetch lists of banks, Nigerian states, and local government areas for standard data validation.
This endpoint is used to initiate the process for getting the customer's consent. The integrator is required to pass the customer's BVN and the phone number. If the phone number passed does not match the customer phone on record, an error is returned but with a masked collection of the correct phone and email on the customer account.
\ncontact * ˢᵗʳⁱⁿᵍ
The phone number or email of the customer.
At minimum, the phone number must match the one linked to the BVN (e.g., 08012345678, ado@example.com).
This endpoint is used to get the BVN data after the customer's consent has been approved.
\notp * ˢᵗʳⁱⁿᵍ
A 6 digit password sent to the contact entered during consent intialization.
Bank Verification Number (BVN) is the national ID system created by Nigerian banks to uniquely identified bank customers in the Nigerian banking ecosystem.
\nThe banking ecosystem has also created a mechanism where all the bank accounts tied to a specific BVN could be gotten.
\n","_postman_id":"e4d9dee5-b600-4890-965b-56a439f5a252","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to initiate the process for getting customer consent. The integrator is required to pass the customer's BVN and the phone number.
\nIf the phone number passed does not match the customer phone on record, an error is returned but with a masked collection of the correct phone and email on the customer account.
\ncontact * ˢᵗʳⁱⁿᵍ
The phone number or email of the customer.
At minimum, the phone number must match the one linked to the BVN (e.g., 08012345678, ado@example.com).
This endpoint is used to get the bank accounts. It requires the OTP that has been sent to the customer. OTP to phones are usually sent from PFAlert sender id.
\notp * ˢᵗʳⁱⁿᵍ
A 6 digit password sent to the contact entered during consent intialization.
1 → Active 2 → Dormant 3 → Closed 4 → PND (Post No Debit) 5 → PNC (Post No Credit) 6 → Inactive 7 → Total Freeze 8 → OtherThis 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, thereby providing an additional layer of security and accuracy in customer information validation.
\nimage * ˢᵗʳⁱⁿᵍ
URL of the image to be used for comparison.
bvn *\nBVN of the person whose face is being verified against the image.
\nThis endpoint is used for verification of a customer's bank account.
\naccount_number * ˢᵗʳⁱⁿᵍ
Account number to be verified.
bank_code * ˢᵗʳⁱⁿᵍ
Bank code associated with the account number.
Karma is a database of blacklisted bad actors within the Lendsqr ecosystem. A bad actor is someone who has been involved with fraud or has tried to request loans with fake identity. A bad actor may also be a chronic defaulter whose loan has been written off.
\nThis endpoint is used to check if a customer is on the blacklist of bad actors.
\nidentity*
Identity of customer which could be one of the following:
The Lendsqr ecosystem provides an aggregated view of borrowers which lenders could have access to make decisions. To access this service, the lender must provide an evidence of customer explicit consent.
\nFurthermore, where it is proven that a consent was never provided, the lender would be liable for all legal cost required to ameliorate issues that may arise. Lender may also be removed from the platform.
\nThis endpoint is used to verify if a borrower exists on the Lendsqr ecosystem.
\nbvn *
BVN of the person whose face is being verified against the image.
Bank Verification Number
\n","type":"text/plain"},"type":"any","value":null,"key":"bvn"}]}},"response":[{"id":"c5cd7394-fac1-41f0-872a-3004997ce9df","name":"Check for Borrower on Ecosystem","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://adjutor.lendsqr.com/v2/verification/ecosystem/:bvn","host":["https://adjutor.lendsqr.com/v2/verification"],"path":["ecosystem",":bvn"],"variable":[{"key":"bvn","value":"22153475955"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Aug 2023 14:28:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Request-ID","value":"a7855073-2a36-4924-a21f-077ef89219c0"},{"key":"Last-Modified","value":"Tue, 08 Aug 2023 14:28:55 GMT"},{"key":"ETag","value":"W/\"591-Cd5yroepYTa3PyDTbhzMyhKotAE\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f3872d4eeb8d430-LOS"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Successful\",\n \"data\": {\n \"bvn\": \"22536011111\",\n \"first_name\": \"JANE\",\n \"last_name\": \"DOE\",\n \"bvn_phone_number\": \"07062561111\",\n \"date_of_birth\": \"1997-09-10T00:00:00.000Z\",\n \"age\": 25,\n \"unique_phone_numbers\": 0,\n \"phone_number\": \"07062561111\",\n \"unique_emails\": 0,\n \"email\": \"janedoe@gmail.com\",\n \"gender\": \"Female\",\n \"lenders\": 1,\n \"first_account\": \"2020-11-16T10:49:57.000Z\",\n \"last_account\": \"2023-06-26T07:56:37.000Z\",\n \"failed_selfie_bvn_check\": 0,\n \"lending_lenders\": 0,\n \"loans\": 0,\n \"loan_amount\": 0,\n \"loan_amount_minimum\": 0,\n \"loan_amount_maximum\": 150000,\n \"loan_amount_average\": 5892.954545,\n \"settled_loans\": 0,\n \"settled_loan_amount\": 0,\n \"settled_loan_amount_paid\": 0,\n \"running_loans\": 0,\n \"running_loan_amount\": 0,\n \"past_due_loans\": 0,\n \"past_due_loan_amount\": 0,\n \"past_due_loan_amount_due\": 2000,\n \"penalty\": 0,\n \"penalty_paid\": 0,\n \"delayed_paid_loans\": 0,\n \"delayed_paid_loan_amount\": 0,\n \"delayed_paid_loans_trials\": 0,\n \"delayed_paid_loans_avg\": 0,\n \"delayed_paid_loans_trials_max\": 0,\n \"delayed_paid_loans_trials_min\": 0,\n \"first_loan_date\": \"2020-12-24T07:54:37.000Z\",\n \"last_loan_date\": \"2023-07-20T11:38:02.000Z\",\n \"loan_requests\": 0,\n \"failed_loan_requests\": 0,\n \"logins\": 115,\n \"first_login\": \"2023-06-01T12:32:27.000Z\",\n \"last_login\": \"2023-08-08T08:23:49.000Z\",\n \"unique_login_ips\": 0,\n \"unique_device_ids\": 0,\n \"distinct_mobile_os\": 0,\n \"duplicated_devices\": 0,\n \"shared_device_users\": 0,\n \"credit_delinquency\": 0,\n \"processed_on\": \"2023-08-08T14:02:33.000Z\"\n },\n \"meta\": {\n \"cost\": 25,\n \"balance\": 1590\n }\n}"}],"_postman_id":"7530013a-3530-44b7-bc80-3f4d6e6b0f6c"},{"name":"Verify Custormer NIN","id":"a330e931-7dbb-4fd2-ab98-a3fb870c48f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://adjutor.lendsqr.com/v2/verification/nin/:nin","description":"This endpoint allows for real-time verification of an individual's National Identification Number (NIN) , thereby providing an additional layer of security and accuracy in customer information validation.
\nnin *
NIN of the person to be checked.
The Validation APIs are resources and tools for validating customer information. These validation processes make use of APIs that allow you to confirm the accuracy of customer information using their Bank Verification Numbers (BVNs), email addresses, or phone numbers.
\nThe APIs are designed to help you ensure that customer information is accurate and up-to-date, providing you with a reliable and efficient method for validating customer data.
\n","_postman_id":"c40907bb-19d3-49c3-a8b3-17ace4b2ca40","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This request is used to check the CRC database for the credit history of a customer using their BVN.
\nbvn *
BVN of the customer whoses credit history you aim to fetch
This must be a valid Bank Verification Number
\n","type":"text/plain"},"type":"any","value":"","key":"bvn"}]}},"response":[{"id":"52475fb1-f5f0-4bb8-9912-86a5da97cd39","name":"Get Credit Report from CRC Credit Bureau","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://adjutor.lendsqr.com/v2/creditbureaus/crc/:bvn","host":["https://adjutor.lendsqr.com/v2/creditbureaus"],"path":["crc",":bvn"],"variable":[{"key":"bvn","value":"22293381111"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Aug 2023 14:45:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Request-ID","value":"b0a64f17-3b9c-486a-bcd9-238c74c8dc6b"},{"key":"Last-Modified","value":"Tue, 08 Aug 2023 14:45:11 GMT"},{"key":"ETag","value":"W/\"3a9-O71eH/thvISxq/G7zT9AeNi1Bl4\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f388aa9590fc4fc-LOS"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Successful\",\n \"data\": {\n \"consdisclaimer\": {\n \"getdisclaimercontent\": {\n \"_x0031_\": \"1\"\n }\n },\n \"consumer_relation\": \"\",\n \"last_checked_date\": \"2023-06-29 12:00:40\",\n \"credit_nano_summary\": {\n \"summary\": {\n \"last_reported_date\": \"31-MAY-2023\",\n \"has_creditfacilities\": \"YES\",\n \"no_of_delinqcreditfacilities\": \"2\"\n }\n },\n \"mfcredit_nano_summary\": {\n \"summary\": {\n \"last_reported_date\": \"31-MAY-2023\",\n \"has_creditfacilities\": \"YES\",\n \"no_of_delinqcreditfacilities\": \"1\"\n }\n },\n \"mgcredit_nano_summary\": {\n \"summary\": {\n \"has_creditfacilities\": \"NO\",\n \"no_of_delinqcreditfacilities\": \"0\"\n }\n },\n \"nano_consumer_profile\": {\n \"consumer_details\": {\n \"name\": \"JOHN DOE\",\n \"ruid\": \"1112020002201111\",\n \"gender\": \"001\",\n \"last_name\": \"DOE\",\n \"first_name\": \"JOHN\",\n \"citizenship\": \"NG\",\n \"date_of_birth\": \"01-OCT-1960\",\n \"identification\": {\n \"ruid\": \"1112020002201111\",\n \"id_value\": \"22293381111\",\n \"source_id\": \"BVN\",\n \"id_display_name\": \"Business Verification Number\"\n }\n }\n }\n },\n \"meta\": {\n \"cost\": 100,\n \"balance\": 1355\n }\n}"}],"_postman_id":"8d19c5d1-450c-43ca-b136-6f9541ee5603"},{"name":"Get Credit Report from FirstCentral Credit Bureau","id":"89a04480-4a51-46c4-8342-3dc84e411077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://adjutor.lendsqr.com/v2/creditbureaus/firstcentral/:bvn","description":"This request is used to check the CRC database for the credit history of a customer using their BVN.
\nbvn *
BVN of the customer whoses credit history you aim to fetch
This must be a valid Bank Verification Number
\n","type":"text/plain"},"type":"any","value":"","key":"bvn"}]}},"response":[{"id":"ae182362-dc18-46de-9a46-ddd3a0a3be7a","name":"Get Credit Report from FirstCentral Credit Bureau","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://adjutor.lendsqr.com/v2/creditbureaus/firstcentral/:bvn","host":["https://adjutor.lendsqr.com/v2/creditbureaus"],"path":["firstcentral",":bvn"],"variable":[{"key":"bvn","value":"22293381111"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Aug 2023 13:26:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Request-ID","value":"215fcd37-0d7f-4fc8-9031-7fa20e55bad0"},{"key":"Last-Modified","value":"Mon, 14 Aug 2023 13:26:10 GMT"},{"key":"ETag","value":"W/\"5da-eIapFMBHh+VQsgkRqx4HYnwZad4\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7f698727981103d6-LIS"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Successful\",\n \"data\": [\n {\n \"SubjectList\": [\n {\n \"Reference\": \"2663443\",\n \"ConsumerID\": \"2663443\",\n \"SearchOutput\": \"DOE JANE, dantata estate kubwa abuja\"\n }\n ]\n },\n {\n \"PersonalDetailsSummary\": [\n {\n \"Gender\": \"Female\",\n \"Header\": \"PERSONAL DETAILS SUMMARY: DOE JANE\",\n \"Surname\": \"DOE\",\n \"BirthDate\": \"19/03/1997\",\n \"FirstName\": \"JANE\",\n \"OtheridNo\": \"\",\n \"CellularNo\": \"2348169591111\",\n \"ConsumerID\": \"2663443\",\n \"Dependants\": \"0\",\n \"OtherNames\": \"\",\n \"PassportNo\": null,\n \"PencomIDNo\": \"\",\n \"Nationality\": \"Nigeria\",\n \"ReferenceNo\": null,\n \"EmailAddress\": \"\",\n \"NationalIDNo\": \"\",\n \"MaritalStatus\": null,\n \"EmployerDetail\": null,\n \"PostalAddress1\": \"DANTATA ESTATE ABUJA FEDERAL CAPITAL TERRITORY\",\n \"PostalAddress2\": \"15\",\n \"PostalAddress3\": \"\",\n \"PostalAddress4\": \" Nigeria\",\n \"HomeTelephoneNo\": \"2348169591111\",\n \"WorkTelephoneNo\": \"2348169591111\",\n \"DriversLicenseNo\": null,\n \"PropertyOwnedType\": \"\",\n \"BankVerificationNo\": \"22293381111\",\n \"ResidentialAddress1\": \"10nasiru dantata estate kubwa abuja\",\n \"ResidentialAddress2\": \"\",\n \"ResidentialAddress3\": \"\",\n \"ResidentialAddress4\": \" \"\n }\n ]\n },\n {\n \"CreditSummary\": [\n {\n \"NumberofAccountsInBadStanding\": \"0\",\n \"TotalNumberOfAccountsReported\": \"6\",\n \"NumberOfAccountsInGoodStanding\": \"6\"\n }\n ]\n },\n {\n \"PerformanceClassification\": [\n {\n \"NoOfLoansLost\": \"0\",\n \"NoOfLoansDoubtful\": \"0\",\n \"NoOfLoansPerforming\": \"6\",\n \"NoOfLoansSubstandard\": \"1\"\n }\n ]\n },\n {\n \"EnquiryDetails\": [\n {\n \"ProductID\": \"63\",\n \"MatchingRate\": \"90\",\n \"SubscriberEnquiryEngineID\": \"179484634\",\n \"SubscriberEnquiryResultID\": \"22059650\"\n }\n ]\n }\n ],\n \"meta\": {\n \"cost\": 100,\n \"balance\": 1025\n }\n}"}],"_postman_id":"89a04480-4a51-46c4-8342-3dc84e411077"}],"id":"e1a99876-e6f8-4937-96ec-3a3516f52fd0","description":"The Credit Bureaus folder contains resources and tools for accessing credit information through credit bureau integrations.
\n","_postman_id":"e1a99876-e6f8-4937-96ec-3a3516f52fd0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoints returns the lis of banks able to provide direct debit authorizations on their customers' accounts.
\nRetrieve the details of a specific account.
\nbank_id* ⁱⁿᵗᵉᵍᵉʳ \nThe ID of the bank you want to get the details of.
\nThis endpoint is used to verify the validity and details of a Nigerian account number.
\naccount_number* ˢᵗʳⁱⁿᵍ
A valid NUBAN account number, which must be 10 digits.
bank_id* ⁱⁿᵗᵉᵍᵉʳ
The identifier of the bank to which the account belongs.
These endpoints are used to get the list of Nigerian banks, details of specific banks. They can also be used to bank account verification.
\nNot all banks are included as some banks have either not implemented their direct debit service, or they return DO NOT HONOR on direct debit requests.
\nIf a bank is missing, please email support@lendsqr.com for assistance or more details.
\n","_postman_id":"4cdc01ca-16cd-4d20-b8a8-7a8644bbf91a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to create a mandate on a customer's account. The default mandate type is the emandate, which customers can easily activate by themselves.
\naccount_number * ˢᵗʳⁱⁿᵍ
Customer NUBAN account number to create the mandate against.
phone_number * ˢᵗʳⁱⁿᵍ
The phone number of the customer in the format 08012345678.
The customer's bank may validate this against their records, so it's best to use the number the customer receives SMS alerts on.
debit_type * ˢᵗʳⁱⁿᵍ
The type of debit — either all or partial.
allThe system attempts to debit the full amount.
partialThe system attempts to debit any available amount. Useful for loan repayments.
frequency ˢᵗʳⁱⁿᵍ
The frequency of debiting the mandate. Options: daily, weekly, or monthly.
Required if recurring debits are being configured.
bank_id * ⁱⁿᵗᵉᵍᵉʳ
The ID of the customer's bank, obtained from the Get Bank endpoint.
email * ˢᵗʳⁱⁿᵍ
Customer's email address.
start_date * ˢᵗʳⁱⁿᵍ
The start date of the mandate. A mandate cannot be triggered for transactions before this date.
end_date * ˢᵗʳⁱⁿᵍ
The end date of the mandate. The mandate expires on this date.
narration * ˢᵗʳⁱⁿᵍ
The narration or description of the mandate.
address * ˢᵗʳⁱⁿᵍ
Customer's address.
amount * ᶠˡᵒᵃᵗ
The maximum amount that can be debited in a single attempt.
The total amount debited may be a multiple of this, depending on how often the API is called.
schedule ᵇᵒᵒˡᵉᵃⁿ
Indicates whether the transaction is scheduled (true) or not (false).
type ˢᵗʳⁱⁿᵍ
Which by default is an e-mandate (emandate).
This endpoint is used to retrieve mandates or information for all mandates tied to your API key.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieves the details of a specific mandate.
\nreference_number * ˢᵗʳⁱⁿᵍ
The reference number of the mandate for which you want the details.
This endpoint provides a summary of all mandates within the system.
\nUpdates the status of a mandate
\nreference_number ˢᵗʳⁱⁿᵍ
The reference number of the mandate to activate or deactivate.
This endpoint enables you to perform a debit on a customer's account using an authorized mandate. For this to happen, these are the prerequisites:
\nThe mandate must have been created on the profile of that the API credentials are attached to
\nThe mandate must have been authorized or validated by the customer's bank
\nThe mandate start date must be in the past and the expiry date in the future
\nFor a mandate to be debited successfully:
\nThe customer's account must be in good standing at their bank. For example, their bank account cannot be dormant
\nThe customer's account must have enough funds to carry the debit. Mandates cannot force debit an account
\nreference_number * ˢᵗʳⁱⁿᵍ
The reference number assigned to the mandate.
amount * ᶠˡᵒᵃᵗ
The amount to be debited on the mandate.
Retrieves the balance of the account associated with a mandate
\nreference_number * ˢᵗʳⁱⁿᵍ
The reference number assigned to the mandate.
Retrieve the transactions related to the mandates associated with the API key.
\nRetrieves the details of a specific transaction.
\nreference_number * ˢᵗʳⁱⁿᵍ
The reference number of the mandate transaction you want to get the details of
Retrieves the status of transactions associated with the API key.
\nDirect debit is a payment method that allows an account holder to grant authorization for a biller or lender to take money from their bank account for services as of when due. Direct debit is similar to debit cards in its ability to debit a customer’s account with prior authorization.
\nDirect debit helps businesses that require recurring payments on specific dates with fixed amounts, such as insurance premiums, loan repayments, service subscriptions, or variable recurring payments on different dates (e.g., postpaid lines, and electricity usage).
\nThis direct debit API facilitates the process for Service Providers (referred to as Billers) to generate debit mandate instructions on their client's/customers' bank accounts for services rendered or products sold.
\nThese debit mandate instructions are created as digital versions of physical instructions duly signed by the account owners (clients/customers). Once generated, the mandate instructions are automatically sent to the bank where the account is held for review and approval. The approval process requires the bank to contact the account owner to authorize the mandate, which typically takes 24 to 48 hours.
\nThe 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.
\nThis document provides a comprehensive overview and detailed specifications of the Direct Debit APIs, including all the necessary information for seamless integration into your respective applications.
\nDirect 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:
\nThe first step is the creation of 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.
\nFrom a best practices point of view, the customer should be informed on your app, by email, and SMS.
\nActivation 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.
\nImmediately 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.
\nThe following are the authorized banks which customers should use for direct debit mandate activation.
\nThere 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\".
\n","_postman_id":"6726e0fd-7a62-4a3a-95ee-4ef545cf44b0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint fetches all the decision models that have been configured for your profile. This would allow you to programmatically iterate and select.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to obtain the details of a Decision Model.
\nid * \nThe ID of the decision model.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used for scoring based on the passed parameters.
\nThe Lendsqr data provides the source of data that have been used to develop and optimize our proprietary scoring algorithms. The scoring system is continually updated to reflect new insights into the shifting borrowers’ behaviors, both for cohorts of customers and for the Nigerian financial system. The ID variable refers to the ID of the decision model.
\ngender ˢᵗʳⁱⁿᵍ
Options include: male, female.
marital_status ˢᵗʳⁱⁿᵍ
Options include: married, single, divorced, separated, widowed.
age ⁱⁿᵗᵉᵍᵉʳ
Age of the customer (e.g., 25, 37).
location ˢᵗʳⁱⁿᵍ
Geographical location (e.g., Lagos, Ibadan).
no_of_dependent ⁱⁿᵗᵉᵍᵉʳ
Number of dependents (e.g., 0, 5).
type_of_residence ˢᵗʳⁱⁿᵍ
Type of accommodation (e.g., own house, rented apartment, parents apartment).
education_attainment ˢᵗʳⁱⁿᵍ
Level of education (e.g., MSc and above, BSc, HND and Other Equivalent, Diploma/School Cert, Others).
employment_status ˢᵗʳⁱⁿᵍ
Employment status (e.g., employed, self employed, unemployed, retired).
sector_of_employment ˢᵗʳⁱⁿᵍ
Industry or sector of employment (e.g., agriculture, banking, education, law).
tier ˢᵗʳⁱⁿᵍ
Tier category (e.g., tier 1, tier 2).
monthly_net_income ˢᵗʳⁱⁿᵍ
Income range (e.g., 700,000 - 999,999, above 1,000,000).
employment_category ˢᵗʳⁱⁿᵍ
Employment classification (e.g., artisan, enterprise, private company, federal: public).
bvn ˢᵗʳⁱⁿᵍ
Customer’s Bank Verification Number (e.g., 22222222222).
phone_number ˢᵗʳⁱⁿᵍ
Primary phone number of the customer (e.g., 0805555555).
working_period ⁱⁿᵗᵉᵍᵉʳ
Total years of work experience (e.g., 1).
time_with_current_employer ⁱⁿᵗᵉᵍᵉʳ
Time spent with current employer in years (e.g., 1).
previous_lendsqr_loans ⁱⁿᵗᵉᵍᵉʳ
Number of past loans taken from Lendsqr (e.g., 1).
code ˢᵗʳⁱⁿᵍ
Custom or referral code (e.g., 56etruu).
phone ˢᵗʳⁱⁿᵍ
Alternate phone number (e.g., 08106666666).
bvn_phone ˢᵗʳⁱⁿᵍ
Phone number associated with BVN (e.g., 08106666666).
official_email ˢᵗʳⁱⁿᵍ
Work or company email address (e.g., male@female.com).
personal_email ˢᵗʳⁱⁿᵍ
Personal email address (e.g., male@female.com).
amount ˢᵗʳⁱⁿᵍ
Loan or transaction amount (e.g., 5000).
These APIs provide quick, easy, and cost-effective solutions for making informed decisions during your loan decision processes, allowing you to make confident and efficient choices with ease.
\nTo use the Decisioning APIs, you must have designed your decision models and configure them within the Lendsqr admin console.
\n","_postman_id":"3c00f132-8d60-4a29-b8bc-4c2ac5a753dc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Specialized APIs tailored for Nigeria’s financial ecosystem. These endpoints support key services such as Bank ccount verification, BVN validation, NIN checks, Credit Bureau access, and decisioning tools. Built to streamline lending, KYC, and customer onboarding workflows.
\n","_postman_id":"e2cfd1d4-a638-4fd6-8e0a-2770fb2e7880","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Create a new customer with the provided details, including phone number, email, name, address and associated security pin.
\nemail * ˢᵗʳⁱⁿᵍ
Customer's email address.
phone_number * ˢᵗʳⁱⁿᵍ
Customer's phone number in the format +1XXXXXXXXXX or 2348012345678.
first_name * ˢᵗʳⁱⁿᵍ
Customer's first name.
last_name * ˢᵗʳⁱⁿᵍ
Customer's last name.
dob * ᵈᵃᵗᵉ
Customer's date of birth in the format yyyy-mm-dd.
address * ˢᵗʳⁱⁿᵍ
Customer's residential address.
The endpoint returns the details of a newly updated customer with the following properties:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Update the information of an existing customer using their unique ID. Only the fields provided in the request body will be updated.
\nThe request body must contain one or more of the following editable fields:
\nfirst_name * ˢᵗʳⁱⁿᵍ
Customer's first name
last_name * ˢᵗʳⁱⁿᵍ
Customer's last name
email * ˢᵗʳⁱⁿᵍ
Email address of the customer
phone_number * ˢᵗʳⁱⁿᵍ
Customer's phone number in the format 2348012345678
address * ˢᵗʳⁱⁿᵍ
Address of the customer.
The endpoint returns the details of the newly created customer with the following properties:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This section includes APIs related to customer management. It allows for creating, retrieving, updating, and deleting customer information, as well as managing customer profiles and documents. These APIs provide essential tools for handling customer data efficiently.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["\r",""],"id":"ff1a3c0d-8996-4a27-94ee-0e190fd403c4"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ca990d34-ddff-4b03-a85c-db5a8b3f8c63"}}],"_postman_id":"3582041b-5913-44aa-bffc-63de00112c58","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint fetches all the decision models that have been configured for your profile. This would allow you to programmatically iterate and select.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used to obtain the details of a Decision Model.
\nid * \nThe ID of the decision model.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint is used for scoring based on the passed parameters.
\nAll parameters are assigned a weight on the decision model and once this endpoint is called, the customers score is calculated according to the assigned weights.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"A decision model is a set of rules that encapsulate the risk acceptance criteria for a lender to make a loan decision. In Lendsqr, these rules or decision models are processed by our service called Oraculi. Learn more.
\n
These APIs provide quick, easy, and cost-effective solutions for making informed decisions during your loan decision processes, allowing you to make confident and efficient choices with ease.
\nTo use the Decisioning APIs, you must have designed your decision models and configure them within the Lendsqr admin console.
\n","_postman_id":"a439f16b-6020-4bce-8beb-6fc2a6973e94","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Retrieve a list of available loan products.
\nRetrieves details of a loan taken by a customer. It requires both the loan's unique ID.
\n![https://documents.lendsqr.com/image_url.png](\"https://documents.lendsqr.com/image_url.png\"){kind=link}
status Object:approver Object:schedules Array:loan_transactions Array:Retrieves the list of all loans taken by a specific customer based on their unique ID.
\nThis endpoint enables you to create a new loan offer on the Lendsqr system. The offer generated will be based on the decision model configuration. This will also determine how much should be given to the user from the amount they requested.
\n\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The response payload also contains a loan_token that can be used to accept the loan offer if the user is eligible
\n
You can accept the offer presented to the customer and create a loan request on the Lendsqr admin console using the Create Loan Request endpoint. All it requires is passing the loan token obtained from the Get Offers endpoint.
\nloan_token * ˢᵗʳⁱⁿᵍ
The unique loan token received from the Get Offers endpoint representing the approved loan offer.
Repay a specific loan for a customer by the loan ID.
\namount * ᶠˡᵒᵃᵗ
The repayment amount.
comment ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
A note or reference for the payment (e.g., \"Payment for invoice #12345\").
reference ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Unique transaction reference.
channel * ˢᵗʳⁱⁿᵍ
Payment method used (bank_transfer, card, wallet, direct_debit, etc.)
\n\nbank_transfer: repayment done externally, no debit made
\n
wallet: debits from user's wallet or virtual account
card / direct_debit: debits from the linked card or direct debit source
Approve a loan booked for a customer using the loan's unique ID.
\nbeneficiary_id ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Unique ID of the beneficiary.
account_number ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Recipient's bank account number. Defaults to \"\".
bank_code ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Code identifying the recipient's bank. Defaults to \"\".
disbursement_provider ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Provider handling the disbursement. Defaults to \"\".
account_name ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Name associated with the bank account. Defaults to \"\".
beneficiary_email ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Email of the beneficiary. Defaults to \"\".
beneficiary_phone_number ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Phone number of the beneficiary. Defaults to \"\".
bank_name ⁿᵘˡˡᵃᵇˡᵉ ˢᵗʳⁱⁿᵍ
Name of the beneficiary’s bank. Defaults to \"\".
attributes ᵒᵇʲᵉᶜᵗ
Additional loan attributes in key-value pairs.
attributes.key1 ˢᵗʳⁱⁿᵍ
Custom attribute key-value pair.
attributes.key2 ˢᵗʳⁱⁿᵍ
Custom attribute key-value pair.
This section contains APIs related to loan management. It includes endpoints for retrieving loan products, scoring loan applications, getting loan schedules, booking loans, retrieving customer loans, and repaying loans.
\n","_postman_id":"cabcb073-3d6e-4b58-80cd-2fc1fa9ad32d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Specialized APIs tailored for Malawian financial ecosystem. These endpoints support key services such as loan scoring and offer generation.
\n","_postman_id":"d8c3e331-da52-4aac-b4c3-af2cd9a20f66","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This section contains country-specific API modules that expose localized functionality for financial services and identity verification. Each module includes endpoints designed to meet the regulatory, banking, and data validation requirements of the respective country, ensuring seamless integration with local systems.
\n","_postman_id":"2843d0e0-d2bb-4da9-b169-448bdbf41ab8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"