Data API Functions

Here are the API functions available to you

Base URL

http://adjutor.com/v2/

Data Options

GET Options

GET http://adjutor.lendsqr.com/v2/data/options

This endpoint provides you with all the available data options you can get via API calls to extract your data from Lendsqr. It shows the path and description for each endpoint.

Headers

NameTypeDescription

Authorization*

String

Bearer <$APIKey>

{
     "status": "success",
    "data": [
        {
            "name": "Users",
            "description": "Get details of all users that have signed
 up to the system. This may include users who have not completed their
 onboarding",
            "path": "/users"
         },
         {
            "name": "Loans",
            "description": "Get details of all loans for any users. You can filter with user_id, status, and approved_on columns",
            "path": "/loans"
         },
         {
            "name": "Options",
            "description": "List all available data options. 
            To get the data for any path, please call with base_url/<path>",
            "path": "/options"
        },
        {
         "name": "Loan analytics",
         "description": "Analytics of loans for organization grouped
  by month. You can filter with the month column",
         "path": "/analytics/loans"
       },
       {
         "name": "Loans",
         "description": "Get transactions for loans. You can filter
 data using the loan_id and created_on columns",
         "path": "/loans/transactions"
       },
       {
         "name": "Loans",
         "description": "Get schedules for specific loans. You can
 filter data using the loan_id and created_on columns",
         "path": "/loans/schedules"
       },
       {
         "name": "Transactions",
         "description": "Get details of all user transactions. You
 can filter data using the user_id column",
         "path": "/transactions"
       }
     ]
  }

Users Data

GET Users

GET http://adjutor.lendsqr.com/v2/data/users

This is a sample endpoint from the list of possible options available for a lender to use. It allows the lender to get the data of all the customers or users on their platform or app.

Kindly note that for other data as described by the /options endpoint, the path to use would be as defined in the response from /options endpoint.

Headers

NameTypeDescription

Authorization*

String

Bearer<$APIKey>

{
    "status": "success",
    "message": "successful",
    "Data":  [ 
        {
             "org_id": 1935,
             "organization": "Lendspeed Limited",
             "id": 994219,
             "first_name": "Elochukwu",
             "last_name": "Ekeanozie",
             "full_name": "Elochukwu Ekeanozie",
             "phone_number": "*********",
             "phone_number_hash": "34108538bdc4858c6ec4e43c9e285be8",
             "email": "*********@gmail.com",
             "bvn": "*********",
             "bvn_phone_number": "*********",
             "date_of_birth": "1987-07-01T00:00:00.000Z",
             "age": 35,
             "gender": "Male",
             "stage_id": 3,
             "stage": "photo",
             "photo_url": null,
             "mifos_client_id": null,
             "client_id": null,
             "savings_id": null,
             "account_number": null,
             "account_balance": 0,
            "account_name": null,
            "referral_code": "O86UMN",
            "referred_by": null,
            "referrer_name": null,
            "referrer_email": null,
            "referrer_phone": null,
            "referrer_code": null,
            "device_id": "077737A7-43B3-487D-B6F4-49F8771B5BC5",
            "notification_token":"fqwBqGiHlSI:APA91bGnIBHUQKRLVJy5BtLuQcpfSDJs7-oedzESRO1tSfgS0kZx-idM2hJ
ghUgWS1mMSsry_VlS2fFZzRhPzzYud1F4o2nhsN3fjknZKsDroaWkjz5daCJwL3vOlY6VaFN
xL5N5P4IW",
            "device_type": "Apple",
            "tier_id": null,
            "tier": null,
            "withdrawal_limit": null,
            "deposit_limit": null,
            "borrower_max_cumulative_amount": null,
            "support_email": "info@opticomfinance.com",
            "loan_count": 0,
            "savings_plans": 0,
            "savings_target": 0,
            "savings_balance": 0,
            "activated": 0,
            "activated_on": null,
            "blacklisted": 0,
            "reason": null,
            "selfie_bvn_check": null,
            "selfie_id_check": null,
            "last_login_date": "2023-02-15T18:26:52.000Z",
            "created_on": "2023-02-15T18:26:52.000Z",
            "modified_on": "2023-02-15T18:28:00.000Z",
            "deleted_on": null,
            "nok_first_name": null,
            "nok_last_name": null,
            "nok_phone_number": null,
            "nok_email": null,
            "nok_address": null,
            "nok_relationship": null,
            "marital_status": null,
            "no_of_dependent": null,
            "type_of_residence": null,
            "educational_attainment": null,
            "employment_status": null,
            "sector_of_employment": null,
            "current_employer": null,
            "employment_category": null,
            "monthly_net_income": null,
            "work_start_date": null,
            "work_email": null,
            "country": null,
            "city": null,
            "lga": null,
            "street": null,
            "nearest_landmark": null,
            "longitude": null,
            "latitude": null,
            "address": null,
            "process_time": "2023-02-16T03:20:03.000Z"
         }
       ]
     }
   {
         "page_size": 10,
    "page": 2
   }
   }

Last updated