> For the complete documentation index, see [llms.txt](https://api2-ekycportal.innov8tif.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api2-ekycportal.innov8tif.com/emas-ekyc-portal/scorecard/get-scorecard-config.md).

# 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.&#x20;

#### 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](broken://pages/JU0qR8cNSEnJAGaGpC91).
3. Upon successfully calling, the user will get a configuration file that contains the metrics of the scorecard.&#x20;

## 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api2-ekycportal.innov8tif.com/emas-ekyc-portal/scorecard/get-scorecard-config.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
