To add a custom scoring module to your decision model on the Lendsqr admin console, you will need to add a JSON model to the existing structure of the default Lendsqr decision model.
Here is a step by step of how you can configure this on the admin console
- Login to the admin console
- Navigate to "Decision Models" under "Product Management".
- Once logged in, locate the side navigation and click on "Product Management."
- In the dropdown menu, select "Decision Models."
3. Create or Update a Decision Model
- To create a new decision model, click on the "New Decision Model" button.
- To update an existing decision model, find the decision model in the list and click on the "Edit" button next to it.
4. Access the decision model settings section
- Scroll down to the "Decision Model Settings" section of the Edit decision model page.
5. Add the Custom Scoring Module
- Add or modify the existing JSON logic with the custom module payload.
- Insert the following JSON payload under the appropriate sequence in your decision model settings:
"custom": {
"required": true,
"sequence": 4,
"continue_on_failure": false,
"pre_offer": true,
"identifier": "scoring-check1",
"host": "https://example.com/1",
"method": "get",
"minimum": 80
}6. Configure each JSON field
- Ensure that each field is correctly configured according to your custom module's requirements.
| S/N | Variable | Description |
| 1 | required | Type: boolean (true or false)Description: Indicates whether this module is mandatory ( true) for the decision process. If set to true, the decision model will require this module to run successfully. If set to false, the module can be skipped without affecting the overall decision flow. |
| 2 | sequence | Type: integer Description: Defines the execution order of the module within the decision model. A lower number means the module will run earlier in the sequence. This is important for determining the order in which different modules or rules are applied. |
| 3 | continue_on_failure | Type: boolean (true or false)Description: Determines whether the decision process should continue if this module fails. If set to true, the model will proceed with subsequent steps even if the module fails. If set to false, a failure in this module will halt the decision process. |
| 4 | pre_offer | Type: boolean (true or false)Description: Specifies if the module should be executed before the loan offer is generated. If true, the module runs during the pre-offer phase, affecting the conditions under which a loan offer is made. If false, it is executed at a later stage. |
| 5 | identifier | Type: string Description: A unique identifier for the custom scoring module. This identifier is used to reference the module within the system and in logs, and must be unique across all modules to avoid conflicts. It helps in tracking and managing different modules effectively. |
| 6 | host | Type: string (URL) Description: The endpoint URL where the scoring logic or API is hosted. This URL is used to make requests to the external service that performs the scoring. It must be a valid URL and accessible from the Lendsqr platform. Make sure the endpoint is reliable and secure. |
| 7 | method | Type: string (HTTP method, e.g., "get", "post")Description: Specifies the HTTP method to be used when calling the host URL. Common methods include GET for retrieving data and POST for sending data to the server. The method should align with the API's requirements at the host URL.For now we only support GET |
| 8 | minimum | Type: integer Description: This is the minimum score a customer must get before they can pass the requirements for this module. |
7. Save the Configuration
- After adding the JSON payload, click on the "Save Changes" button to apply the changes to the decision model.
