> 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/experimental-space/emas-ekyc-portal/scorecard/get-scorecard-result.md).

# Get Scorecard Result

## Overview

This Get Scorecard Result API is to calculate all the results that have been tested in the previous API by the user under one JourneyId and output the results based on the metrics. The metrics can be customized by the user based on their preferences to allow flexibility on the security checks.

#### Steps:

1. After successfully calling the API components in the EMAS eKYC Portal, the user can proceed to the final API which is the Get Scorecard Result API.
2. Place the JourneyId and the content mentioned in the [API Method](#api-method) below.
3. After expanding API method, the user can place the details accordingly following this [Example](broken://pages/myl8hWuO7g6e9ZYD1Waz).
4. Upon successfully calling, the user will get a result either "<mark style="color:green;">Clear</mark>", "<mark style="color:orange;">Cautious</mark>", or "<mark style="color:red;">Suspicious</mark>" based on the default Scorecard result.
5. Users can choose to refer or not refer to the Scorecard Result when they are integrating with their own application. However, it is recommended to use the Scorecard is designed for EMAS eKYC purposes.&#x20;

{% hint style="warning" %}
This requires all of the centralized APIs has been called at least once under the same JourneyId to get the status from the Get Scorecard API. (This only applies to default Scorecard Config)
{% endhint %}

## API Method

<mark style="color:blue;">`GET`</mark> `https://ekycportaldemo.innov8tif.com/api/ekyc/scorecard?journeyId={{journeyid}}`

#### Request Body

| Name                                        | Type   | Description                          |
| ------------------------------------------- | ------ | ------------------------------------ |
| journeyId<mark style="color:red;">\*</mark> | string | Retrieve from 'Create JourneyID' API |

{% tabs %}
{% tab title="200 Response of MyKad's scorecard " %}
{% code title="Response Code Block" %}

```
{
    "status": "success",
    "messageCode": null,
    "message": null,
    "scorecardResultList": [
        {
            "scorecardStatus": "clear",
            "docType": "mykad_back",
            "checkResultList": [
                {
                    "checkType": "liveFaceCheck",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "facialVerification",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "landmark",
                    "checkStatus": "P" 
                }
            ]
        },
        {
            "scorecardStatus": "cautious",
            "docType": "mykad_new",
            "checkResultList": [
                {
                    "checkType": "liveFaceCheck",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "facialVerification",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "landmark",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "colorDetection",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "holographicPhotoQualityCheck",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "screenDetection",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "idNoFontCheck",
                    "checkStatus": "P" 
                },
                {
                    "checkType": "microprint",
                    "checkStatus": "C" 
                },
                {
                    "checkType": "hologram",
                    "checkStatus": "F" 
                },
                {
                    "checkType": "holographicPhotoComparision",
                    "checkStatus": "P" 
                }
            ]
        }
    ]
}
```

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

{% hint style="info" %}
The result will be returned only if that particular document is configured with a scorecard.&#x20;
{% endhint %}

### Input Example

![User input journeyId](/files/579lbFrnTnRR7zpbSit9)

{% hint style="warning" %}
The full eKYC process flow will need to be completed in order to get the scorecard results
{% endhint %}

#### Postman Collection

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