Basylic document assessment

Basylic scans documents on being fraudulent or not. First the document needs to be uploaded to them, secondly they assess the documents. The amount of time this assessment can take is described in an SLA with Basylic for each customer.

In order to implement the basylic document assessment three actions needs to be taken:

• Update the module DOSSIER_DOCUMENTS, with:

   ...
   "assessment": {
       "enabled": true,
       "defaultValue": "DEFAULT",
       "providerIdentifier": "Basylic - Upload"
   },
   ...

• Create the basylic upload document assessment provider
• Create the basylic scheduled document assessment provider

Make sure to add a resultMapping in the upload provider, with the OK result matching to the pendingState in the scheduled provider otherwise the documents will be ignored in the scheduled provider. BasylicUploadDocumentAssessmentProvider:

{
    ...
    "resultMapping": {
        "OK": "PendingStatus",
        ...
    }
}

BasylicScheduledDocumentAssessmentProvider:

{
    ...
    "pendingState": "PendingStatus"
}

Upload

Basylic Upload Document Assessment Provider

🎯 Functional documentation

This provider is responsible for uploading documents to the Basylic external service for fraud assessment. When a document is processed by this provider, it is sent to a specific folder within Basylic. The assessment itself is not done immediately; this provider only handles the upload. The actual result is retrieved later by the BasylicScheduledDocumentAssessmentProvider.

⚙️ Configuration

Implementation class

• eu.myharmoney.app.providers.documents.assessment.basylic.BasylicUploadDocumentAssessmentProvider

Settings Configuration

Examples

Upload V2 (with metadata)

Basylic Upload V2 Document Assessment Provider

🎯 Functional documentation

This provider is the V2 version of the Basylic Upload Document Assessment Provider. It is responsible for uploading documents to the Basylic external service for fraud assessment. When a document is processed by this provider, it is sent to a specific folder within Basylic. The assessment itself is not done immediately; this provider only handles the upload. The actual result is retrieved later by the BasylicScheduledDocumentAssessmentProvider.

Difference from V1

In addition to V1's behavior, V2 sends the mandatory archive_files_metadata field in the upload request. This field provides Basylic with person/applicant information associated with the uploaded document. The metadata is sourced from the document's party data points (name, first name, date of birth, place of birth).

The metadata follows this structure:

{
  "*": {
    "applicants_information": {
      "applicant_portal": {
        "name": "last name",
        "firstnames": "first name",
        "birth_date": "YYYY-MM-DD",
        "birth_place": "place of birth"
      }
    }
  }
}

The * wildcard means the applicant information applies to every document in the request.

⚙️ Configuration

Implementation class

• eu.myharmoney.app.providers.documents.assessment.basylic.BasylicUploadV2DocumentAssessmentProvider

Settings Configuration

Examples

Scheduled document assessment

Basylic Scheduled Document Assessment Provider

🎯 Functional documentation

This provider runs on a defined schedule to check the results of documents previously uploaded to Basylic. It fetches a report from Basylic containing all documents that have fraud alerts. Documents not contained in the report are either not reviewed yet, or not fraudulent.

• Documents found in the report are updated based on the resultMapping.
• Documents that are in the pendingState and older than reviewHours, but not found in the report, are considered valid and are updated with the status mapped from the special success key.

⚙️ Configuration

Implementation class

• eu.myharmoney.app.providers.documents.assessment.basylic.BasylicScheduledDocumentAssessmentProvider

Settings Configuration

Examples