Fetching Crosscheck Results

API for Crosscheck Results

To fetch results from a crosscheck that was configured in the dashboard, the following API can be used:

/omni/cross-doc-data-check/results

API Response Format

The API responds with the following format:

{
  "additionalProp1": [
    {
      "interviewId": "string",
      "comparisonName": "string",
      "comparisonId": "string",
      "result": "OK",
      "leftValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "rightValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "severity": "ultra_low"
    }
  ],
  "additionalProp2": [
    {
      "interviewId": "string",
      "comparisonName": "string",
      "comparisonId": "string",
      "result": "OK",
      "leftValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "rightValueDetails": {
        "documentType": "string",
        "fieldName": "string",
        "value": {},
        "sourceNotFound": true
      },
      "severity": "ultra_low"
    }
  ]
}

Important Notes

• When reading the result, it is important to iterate through the dictionary and do a "contains" comparison with the name of the crosscheck due to a technical implementation within Incode’s system that automatically appends required metadata to the end of the name.
• Naming conventions should avoid overlap to prevent bugs when reading the results.