Fetch Score Data

What is score data?

Score data includes all results associated with the checks and validations included in a given flow configuration.

How can I see score data?

You can see this data by either:

• Going to Dashboard > Sessions, locating the session you want to review, and selecting it.
• Using the fetch scores API endpoint to obtain the data as a JSON response. You can also test this endpoint yourself at the preceding link. This is the same API endpoint used by the Incode Dashboard.

To fetch score data for a given onboarding session, you must pass the session's unique interview ID, also called the Session ID, to the fetch scores API endpoint. If you do not pass the interview ID, Incode attempts to extract it from the session token.

When is score data available?

Scores are calculated once an onboarding is finished and after rules have been applied. The associated score data can be viewed or fetched once the onboarding session has been marked as complete via the finish-status endpoint

How should I interpret score data?

In the Incode Dashboard, the Overall Status score is presented using the model of a traffic signal:

• Green: OK; a passing score; that is, a go
• Yellow: WARN; there are concerns in the data score; that is, a caution
• Red: FAIL; that is, a stop

Even when you choose to directly fetch the data, keep this model in mind. While there may be dozens of scores and tests in every session, the most important score is always Overall Status. This is a composite score which factors in all the tests included in the settings of your configured flow.

Due to the complex nature of flow's and score calculations, we do not recommend you consider the numeric values of individual validations. Although this might be tempting, the Overall Status should be your guide to the outcome of the completed session.

Sample JSON File

Following is a sample JSON file as retrieved using the fetch scores API endpoint. This sample reflects the settings and results of a given flow. Your files will be based on your flows and may not look exactly like this one. However, the sample gives an idea of how you can use it to check the onboarding session's overall status, as well as the overall status per module validation. It also provides an explanation of the different JSON response parameters.

{
  ..., // subscores fields
  "idValidation": {
    "photoSecurityAndQuality": [
      ...
    ],
    "idSpecific": [
 			...
    ],
    "overall": {
      "value": "100.0", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
	"liveness": {
    ...,
    "overall": {
      "value": "100.0", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
  "faceRecognition": {
    "existingUser": true, // If true. this tells you if the user had a previous approved onboarding session
    "existingInterviewId": "", // this is the original approved session from this user
    ...,
    "overall": {
      "value": "83.2", // avoid validating against this value
      "status": "OK" // this is the value you care about
    }
  },
  "appliedRule": { // When a rule is applied it appears here
    "name": "Undeage Rule", // Name of the rule that got applied
    "expression": "underageCheck_STATUS == 'FAIL'", // The expression that got applied
    "ruleType": "total", // Type of the rule
    "status": "FAIL", // The new score that got applied
    "incodeScoreOverall": { // The score before it got triggered
      "value": "94.4",
      "status": "OK"
    }
  },
  "overall": {
    "value": "94.4", // avoid validating against this value
    "status": "OK" // this is the value you care about
  },
  "reasonMsg": "" // reason for the obtained overall score
}

📘

Scores and OCR Data

Optical Character Recognition (OCR) data shows in the Incode Dashboard along with some scoring. This scoring relates solely to the level of confidence on the data extracted from the captured image of the ID. Level of confidence for OCR data does not directly affect or alter the score of a session.