Validation

Validate customers using BVNs, emails, or phone numbers. The validation APIs help you confirm the accuracy of customer information.

Bank Account Verification

POST Bank Account

POST https://adjutor.lendsqr.com/verification/bankaccount

This endpoint is used for verification of a bank account.

Headers

Name	Type	Description
Authorization*	String	Bearer <$APIKey>

Request Body

Name	Type	Description
account_number*	integer	account number to be verified (10 digits)
bank_code*	integer	the bank code for the customer's bank (3 digits) Yet this information using the #get-banks API

200: OK Bank account has been verified correctly

Response body

{
   "status":"success",
   "message":"Successful",
   "data":{
      "bvn":"",
      "tier":null,
      "logo_url":"https://lendstack-s3.s3.us-east-2.amazonaws.com/bank_logos/057.png",
      "bank_code":"057",
      "account_name":"ADO JOHN SULE",
      "account_number":"1010118812"
   },
   "meta":{
      "balance":50000
   }
}

Fields and descriptions

Response Data	Description
status	endpoint response status - success, fail.
message	endpoint response status message - successful, failed.
bvn	BVN of the customer
tier	bank tier
logo_url	image url of the bank logo
bank_code	CBN bank code
account_name	account name gotten for the customer
account_number	account number of the customer

404: Not Found Bank account number is invalid

Response data

{
    "status": "error",
    "message": "Invalid account number",
    "deprecation": {
        "message": "We're deprecating this endpoint starting from 2023-01-01, please use the new version /v2/verification/bankaccount going forward."
    },
    "meta": {
        "balance": 97848
    }
}

Karma Lookup

GET Karma

GET https://adjutor.lendsqr.com/verification/karma/0zspgifzbo.ga

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.

Path Parameters

Name	Type	Description
identity*	String	identity to be searched - can be BVN phone number, email etc.

Headers

Name	Type	Description
Authorization*	String	Bearer <$APIKey>

200: OK Found on Karma

Response body

{
   "status":"success",
   "message":"Successful",
   "data":{
      "id":8,
      "karmaIdentity":"22212345678",
      "amountInContention":"1935710.23",
      "reason":null,
      "karmaType":{
         "karma":"Fraud"
      },
      "karmaIdentityType":{
         "identityType":"BVN"
      },
      "reportingEntity":{
         "name":"Some random lender limited",
         "email":"[e-mail]"
      }
   },
   "meta":{
      "cost":10,
      "balance":50000
   }
}

Fields and descriptions

Response Data	Description
status	endpoint response status - success, fail.
message	endpoint response status message - successful, Identity not found in karma.
karma_identity	the listed identity in karma. bvn, phone number, etc.
amount_in_contention	the amount of money the defaulter owes the lending company
reason	reason the user was listed in Karma
karma_type	type of karma the defaulter's details fall under. fraud, loan, others.
karma_identity_type	the form of identity used. bvn, phone number, etc.
reporting_entity_name	the name of the reporting company
reporting_entity_email	the email of the reporting company

404: Not Found Not found in Karma

{
    "status": "success",
    "message": "Identity not found in karma",
    "meta": {
        "balance": 50000
    }
}

Ecosystem Lookup

GET Ecosystem

GET https://adjutor.lendsqr.com/verification/ecosystem/{{bvn}}

Confirm users' credit history and behaviour across the Lendsqr ecosystem

Path Parameters

Name	Type	Description
bvn*	Integer	11-digit BVN of the customer.

Headers

Name	Type	Description
Authorization*	String	bearer {{access_token}}

200: OK Found in ecosystem

Response body

{
    "status": "success",
    "message": "Successful",
    "data": {
        "bvn": "",
        "first_name": "Ado",
        "last_name": "John-Sule",
        "bvn_phone_number": "08012345678",
        "date_of_birth": "1990-09-08",
        "age": 30,
        "unique_phone_numbers": 1,
        "phone_number": "08012345678",
        "unique_emails": 1,
        "email": "[e-mail]",
        "lenders": 1,
        "first_account": "2020-09-22",
        "last_account": "2020-09-22",
        "failed_selfie_bvn_check": 0,
        "lending_lenders": 0,
        "loans": 0,
        "loan_amount": 0,
        "settled_loans": 0,
        "settled_loan_amount": 0,
        "settled_loan_amount_paid": 0,
        "running_loans": 0,
        "running_loan_amount": 0,
        "past_due_loans": 0,
        "past_due_loan_amount": 0,
        "past_due_loan_amount_due": 0,
        "penalty": 0,
        "penalty_paid": 0,
        "delayed_paid_loans": 0,
        "delayed_paid_loan_amount": 0,
        "delayed_paid_loans_trials": 0,
        "delayed_paid_loans_avg": 0,
        "delayed_paid_loans_trials_max": 0,
        "delayed_paid_loans_trials_min": 0,
        "first_loan_date": null,
        "last_loan_date": null,
        "loan_requests": 5,
        "failed_loan_requests": 5,
        "logins": 0,
        "first_login": null,
        "last_login": null,
        "unique_login_ips": 0,
        "unique_device_ids": 0,
        "distinct_mobile_os": 0,
        "processed_on": "2021-07-29T01:00:01.000Z"
    },
    "meta": {
        "cost": 15,
        "balance": 50000
    }
}

Fields and description

Response Data	Description
status	endpoint response status - success, fail.
message	endpoint response status message - successful, failed.
bvn	bvn no of the person to be checked.
first_name	first name the person being checked
last_name	last name of the person being checked
bvn_phone_number	phone number atached to the bvn
date_of_birth	date of birth of the person being checked
age	age of the person being checked
unique_phone_numbers	the number of phone numbers the person has registered with any lending company
phone_number	the phone number of the person being checked
unique_emails	the number of emails the person has registered with any lending company
email	the email address of the person being checked
lenders	how many lending companies the person has created an account with
first_account	the date when the person first created an account with a lending company
last_account	the date when the person last created an account with a lending company
failed_selfie_bvn_check	the number of failed BVN checks
lending_lenders	the number of lenders the user has taken a loan from
loans	the number of loans the person has been granted from other lenders
loan_amount	the total loan amount the person has been granted from other lenders
settled_loans	the number of loans the person has repaid
settled_loan_amount	the total loan amount the person has repaid
running_loans	the number of ongoing loans the person has
running_loan_amount	the total amount of ongoing loans the person has
past_due_loans	the number of past due loans the person has
past_due_loan_amount	the total amount of money the person has in past due loans
penalty	the number of penalties the person has for defaulting on loan repayment
penalty_paid	the number of penalties the person has paid
delayed_paid_loans	the number of loans the person delayed in repaying.
delayed_paid_loan_amount	the loan amount the person delayed in repaying
delayed_paid_loans_trials	the number of times/trials given to the person who delayed loan repayment
delayed_paid_loans_avg	the average loan amount the person has delayed repaying
delayed_paid_loans_trials_max	the maximum number of times/trials given to the person who delayed loan repayment
delayed_paid_loans_trials_min	the minimum number of times/trials given to the person who delayed loan repayment
first_loan_date	the date the person took their first loan
last_loan_date	the date the person took their last loan
loan_requests	the number of loan requests the person has made
failed_loan_requests	the number of failed loan requests the person has made
logins	the number of times the user has logged in
first_login	the date the user first logged in on an app on Lendsqr's ecosystem
last_login	the date the user last logged in on an app on Lendsqr's ecosystem

404: Not Found Not found in ecosystem

{
    "status": "error",
    "message": ":bvn not found in ecosystem",
    "meta": {
        "balance": 50000
    }
}