perform-document-assessment

---

title: PerformDocumentAssessment

PerformDocumentAssessment

Business goal

This action triggers the document assessment provider for documents on a dossier and its associated parties. It is useful in automated workflows where documents need to be screened or classified after upload (e.g. on DOCUMENT_CREATED or DOSSIER_SUBMITTED events).

Behaviour

• System-generated documents are always skipped. Only manually uploaded or externally provided documents are assessed.
• Re-assessment updates the system assessment only. If a document already has a manual assessment (a human override), that manual assessment is preserved. The action only writes to the system assessment fields.

PerformDocumentAssessmentV2

PerformDocumentAssessmentV2

The V2 action extends V1 with configurable re-assessment behaviour via the skipAlreadyAssessedDocuments setting.

By default (when skipAlreadyAssessedDocuments is not set or is true), V2 behaves the same as V1 — documents that already have an assessment are skipped.

Set skipAlreadyAssessedDocuments to false to enable re-assessment of all non-system-generated documents, including those that already have an assessment. This is useful when the assessment provider has been updated or reconfigured and existing assessments need to be refreshed. Re-assessment only updates the system assessment; any existing manual assessment is preserved.

Configuration

1. Add the action PerformDocumentAssessmentV2.
2. Link this action to the event(s) on which documents should be assessed (e.g. DOCUMENT_CREATED, DOSSIER_SUBMITTED).
3. Configure settings as needed (see below).

Extending assessment to associated parties

By default the action only assesses documents on the dossier itself. Use associatedPartyTypes to also assess documents belonging to associated parties (e.g. the client party and their identity documents).

Supported values: CLIENT, PARTY_RELATION, OWNER, CLIENT_SIGNATORY, INSURED_PERSON, BENEFICIARY etc.

Settings

Settings Configuration

Examples

PerformDocumentAssessment

PerformDocumentAssessment (V1)

The V1 action always skips documents that already have an assessment. It does not support any JSON settings beyond the inherited associatedPartyTypes.

Configuration

1. Add the action PerformDocumentAssessment.
2. Link this action to the event(s) on which documents should be assessed (e.g. DOCUMENT_CREATED, DOSSIER_SUBMITTED).
3. Optionally configure associatedPartyTypes to include associated party documents in the assessment.

Limitations

• Documents that already have an assessment (system or manual) are always skipped — there is no way to trigger re-assessment with V1.