Decisioning

Our decisioning APIs will guide you to make quick, easy and cost-effective decisions during your loan decision processes.

Decision Model Lookup

GET List Models

GET https://adjutor.lendsqr.com/decisioning/models

This endpoint fetches all the decision models that you have configured on the Lendsqr platform. This endpoint returns all the decision model data you have on your platform irrespective of whether they have been activated or not.

Headers

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

200: OK Successfully retrieved all decision models

Response data

{
    "status": "success",
    "message": "Successful",
    "data": [
        {
            "id": 20,
            "product_id": null,
            "version_id": 33,
            "org_id": 1,
            "name": "Test Decision Model",
            "description": "testing",
            "decision_setting": {
                "karma": {
                    "required": true,
                    "sequence": 1,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "ecosystem": {
                    "required": true,
                    "sequence": 2,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "scoring": {
                    "minimum": 50,
                    "required": true,
                    "sequence": 3,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "credit_bureau": {
                    "provider": "CRC",
                    "required": true,
                    "sequence": 4,
                    "continue_on_failure": false
                }
            },
            "offer_setting": [
                {
                    "rule": {
                        "*": [
                            1,
                            {
                                "var": [
                                    "requested_amount"
                                ]
                            }
                        ]
                    },
                    "maximum": 10000000,
                    "minimum": 1000
                }
            ],
            "status": "active",
            "created_on": "2021-07-31T08:06:27.000Z"
        }
    ]
}

Fields and descriptions

Response data	Description
id
product_id
version_id
org_id
name
description
decision_settings
karma
ecosystem
scoring
credit bureau
offer_settings
required
sequence
continue_onfailure
pre_offer
status
created_on

Decision Model Details

GET Model

GET https://adjutor.lendsqr.com/decisioning/models/:id/settings

This endpoint fetches an individual decision model and its settings that have been configured on your platform using the decision model id.

Path Parameters

Name	Type	Description
*	String	The decision model ID you wish to use. The Get Models API returns this value

Headers

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

200: OK Data from Passed Parameters have been successfully retrieved

Response body

{
    "status": "success",
    "message": "Successful",
    "data": [
        {
            "id": 20,
            "product_id": null,
            "version_id": 33,
            "org_id": 1,
            "name": "Test Decision Model",
            "description": "testing",
            "decision_setting": {
                "karma": {
                    "required": true,
                    "sequence": 1,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "ecosystem": {
                    "required": true,
                    "sequence": 2,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "scoring": {
                    "minimum": 50,
                    "required": true,
                    "sequence": 3,
                    "continue_on_failure": false,
                    "pre_offer": true
                },
                "credit_bureau": {
                    "provider": "CRC",
                    "required": true,
                    "sequence": 4,
                    "continue_on_failure": false
                }
            },
            "offer_setting": [
                {
                    "rule": {
                        "*": [
                            1,
                            {
                                "var": [
                                    "requested_amount"
                                ]
                            }
                        ]
                    },
                    "maximum": 10000000,
                    "minimum": 1000
                }
            ],
            "status": "active",
            "created_on": "2021-07-31T08:06:27.000Z"
        }
    ]
}

Fields and descriptions

Oraculi Scoring

POST Scoring

POST https://adjutor.lendsqr.com/decisioning/models/:id

This endpoint is used for scoring based on the passed parameters/data points. By default, Lendsqr provides you with a proprietary scoring model and its sample request payload which you can tweak to your specification

However, you can pass any data point you wish to; provided that you have configured the scoring model to accept this.

Query Parameters

Name	Type	Description
id	Integer	The decision model ID you wish to use. The Get Models API returns this value

Headers

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

Request Body

Name	Type	Description
gender	String	male, female
marital_status	String	married, single, divorced, separated, widowed
age	Integer	25, 37
location	String	Lagos, Ibadan
no_of_dependent	Integer	0, 5
type_of_residence	String	own house, rented apartment, parents apartment
education_attainment	String	MSc and above, BSc, HND and Other Equivalent, Diploma/School Cert, Others
employment_status	String	employed, self employed, unemployed, retired
sector_of_employment	String	agriculture, banking, education, law
tier	String	tier 1. tier 2
monthly_net_income	String	700,000 -999,999, above 1,000,000,
employment_category	String	artisan, enterprise, private company, federal: public
phone_number	String	The customer
working_period	Integer	1
official_email	String	[e-mail]
personal_email	String	[e-mail]
amount	Integer	5000
phone	String	08106666666
previous_lendsqr_loans	Integer	1
time_with_current_employer	Integer	1

200: OK Data successfully scored

Response body

{
   "status":"success",
   "message":"Successful",
   "data":{
      "credit_score_items":[
         {
            "score_name":"age",
            "score_value":"21 - 30",
            "weight":"7",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         },
         {
            "score_name":"gender",
            "score_value":"Female",
            "weight":"10",
            "maximum_score":10,
            "borrower_score":10,
            "weighted_score":0.0909
         },
         {
            "score_name":"location",
            "score_value":"lagos",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":9,
            "weighted_score":0.0409
         },
         {
            "score_name":"customer_tier",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         },
         {
            "score_name":"marital_status",
            "score_value":"Single",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":6,
            "weighted_score":0.0273
         },
         {
            "score_name":"employer_category",
            "weight":"0",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         },
         {
            "score_name":"employment_status",
            "score_value":"Employed",
            "weight":"10",
            "maximum_score":10,
            "borrower_score":10,
            "weighted_score":0.0909
         },
         {
            "score_name":"type_of_residence",
            "score_value":"Rented Apartment",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":10,
            "weighted_score":0.0455
         },
         {
            "score_name":"monthly_net_income",
            "score_value":"100,000 - 199,999",
            "weight":"10",
            "maximum_score":10,
            "borrower_score":6,
            "weighted_score":0.0545
         },
         {
            "score_name":"no_of_dependent",
            "score_value":"0",
            "weight":"8",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         },
         {
            "score_name":"sector_of_employment",
            "score_value":"Other Financial",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":6,
            "weighted_score":0.0273
         },
         {
            "score_name":"educational_attainment",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         },
         {
            "score_name":"total_years_of_experience",
            "weight":"5",
            "maximum_score":10,
            "borrower_score":4,
            "weighted_score":0.0182
         },
         {
            "score_name":"time_with_current_employer",
            "score_value":1,
            "weight":"5",
            "maximum_score":10,
            "borrower_score":2,
            "weighted_score":0.0091
         },
         {
            "score_name":"previous_paid_loans_on_pecunia",
            "weight":"25",
            "maximum_score":10,
            "borrower_score":0,
            "weighted_score":0
         }
      ],
      "total_weight":110,
      "score":40.46
   },
   "meta":{
      "balance":50000
   }
}

Fields and descriptions

Response Data	Description
score_name	specific basic personal information of the borrower used for assessment. age, gender, location, etc.
score_value	specific details that give more insight into the borrower's information. 32,female,lagos,
weight	weight of the specific credit score item
maximum_score	maximum score a user can get per credit score item
borrower_score	score of the borrower per credit score item
weighted_score	score of the borrower comparing to the weight of the credit score item
total_weight	sum total of the weights of the credit score items
score	final credit score of the user