Skip to main content
Version: 19

Document assessment

What does a document assessment do?​

A document assessment allows storing an analysis on documents, albeit from providers (system) or natural persons (manual).

Instructions​

Manual document assessment​

A manual assessment can be configured following the module settings.

System document assessment​

Documentation on how to configure document assessment providers, you can find here.

Next, to display the assessment coming from the provider in the flow, additional configuration in the flow definition is required.

Settings​

  • defaultValue (required) : the fallback value
  • enabled (required) : true/false
  • positiveAssessments (required) : the system assessment in case Everial returns an approval.
  • providerIdentifier (required) : the document assessment provider identifier.
  • statusMap (required) : the status displayed in the top right corner of the document card in the document overview in case of a respective document assessment.
    • WARNING
    • ISSUE
    • DONE
  • types (required): the included document types.

Example

{
  "flowStep": "IDENTITY",
  "module": "IDENTITY",
  "settings": {
    "assessment": {
      "defaultValue": "TO_REVIEW",
      "enabled": true,
      "positiveAssessments": [
        "APPROVED"
      ],
      "providerIdentifier": "<key>",
      "statusMap": {
        "APPROVED": "DONE",
        "FAILED": "WARNING",
        "REJECTED": "WARNING"
      },
      "types": {
        "BACK_SCAN": {
          "roles": []
        },
        "FRONT_BACK_SCAN": {
          "roles": []
        },
        "FRONT_SCAN": {
          "roles": []
        },
        "PASSPORT": {
          "roles": []
        }
      }
    },
    "showAllDocTypesCard": true
  }
}