# Get Scorecard Config

## Overview

Get Scorecard Config is to get the Configuration files that are set for the Scorecard Results in order to have a clear understanding of how the scorecard works or how the metrics/logic is implemented into the Scorecard. 

#### Steps:

1. Place the JourneyId and the content mentioned in the [API Method](#api-method) below.
2. After expanding API method, the user can place the details accordingly following this [Example](https://api2-ekycportal.innov8tif.com/emas-ekyc-portal/scorecard/broken-reference).
3. Upon successfully calling, the user will get a configuration file that contains the metrics of the scorecard. 

## API Method

<mark style="color:blue;">`GET`</mark> `https://ekycportaldemo.innov8tif.com/api/ekyc/scorecardConfig`

#### Request Body

| Name                                       | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| docType<mark style="color:red;">\*</mark>  | string | <p>For passport:<br>-passport<br><br>For Malaysia documents(old/new IC):<br>-mykad\_new<br>-mykad\_old<br><br>For the rest, please check below:<br><a href="https://api2-ekycapis.innov8tif.com/okaydoc/okaydoc-all/supported-documents/non-passport/supported-document"><https://api2-ekycapis.innov8tif.com/okaydoc/okaydoc-all/supported-documents/non-passport/supported-document></a></p> |
| password<mark style="color:red;">\*</mark> | string | To be assigned by Innov8tif                                                                                                                                                                                                                                                                                                                                                                    |
| username<mark style="color:red;">\*</mark> | string | To be assigned by Innov8tif                                                                                                                                                                                                                                                                                                                                                                    |

{% tabs %}
{% tab title="200 Example of passport's config" %}
{% code title="Response Code Block" %}

```
{
    "status": "success",
    "messageCode": null,
    "message": null,
    "lastModifiedDate": "01-May-2020 00:00",
    "configList": [
        "liveFaceCheck@P:>=0.5;F:otherwise",
        "facialVerification@P:>=75;F:otherwise",
        "mrzVizConsistencyCheck@P:=3,=6;F:otherwise",
        "checkDigitValidation@P:=1,=4;F:otherwise"
    ],
    "scorecardList": [
        "F=suspicious",
        "PF=suspicious",
        "PPF=suspicious",
        "PPPF=cautious",
        "PPPP=clear",
        "otherwise=cautious"
    ]
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Input Example

```
{
    "username": "",
    "password": "",
    "docType": "passport" 
}
```

#### Postman Collection

{% hint style="info" %}
Get the Postman Collection\
<https://innov8tif-solutions.gitbook.io/innov8tif-emas-ekyc-portal/emas-ekyc-portal/postman-collection>
{% endhint %}