Get Scorecard Definitions

This endpoint returns all the custom scorecard definitions configured for you and their corresponding parameters

Method	Endpoint	Headers	Parameters
GET	/creditscore/scorecard-definitions	Authorization value: Bearer string_encrypted_access_token	None

Request

cURL

curl --location --request GET 'https://api.insights-periculum.io/creditscore/scorecard-definitions'
--header 'Authorization: Bearer string_encrypted_access_token'
--header 'Content-Type: application/json'
--data- none

Response

JSON

[
    {
        "scorecardDefinitionName": "Default",
        "scorecardDefinitionKey": 1,
        "scorecardDefinitionType": "POINTS",
        "customParameters": [
            {
                "name": "Age",
                "displayType": "NUMBER"
            },
            {
                "name": "Employment",
                "displayType": "NUMBER"
            }
        ]
    }, 
    {
        "scorecardDefinitionName": "DefaultRules",
        "scorecardDefinitionKey": 2,
        "scorecardDefinitionType": "RULES",
        "customParameters": [
            {
                "name": "YearsOfEmployment",
                "displayType": "NUMBER"
            }
        ]
    }
]