Skip to main content
The Document Attachments module collects and categorises supporting documents from users during an onboarding journey. This module handles supplementary documents that you may require as part of your verification or compliance process. This includes proof of address, proof of income, or additional identity documents. This page contains documentation for the Document Attachments module, including its capabilities and the specific result values it returns.

​
Document Attachments

The Document Attachments variant accepts file uploads from users and stores them against the journey session. The variant accepts multiple document types in a single step, including secondary identity documents, address documents, and additional supporting documents.

​
Accepted document types

The module accepts the following document types as inputs:
InputDescription
SecondaryDocumentA secondary identity document that supplements the primary document captured earlier in the journey. For example, if the primary document is a passport, the secondary document might be a driving licence or national ID card.
AddressDocumentA document that provides proof of the subject’s residential address. Common examples include utility bills, bank statements, council tax bills, or tenancy agreements.
AdditionalDocumentsAny other supporting documents you require. This is a flexible category that can accommodate proof of income documents such as payslips or tax returns, employment verification letters, educational certificates, or any other supplementary evidence needed for the onboarding process.

​
Capabilities

The module returns three capabilities: an attachment result indicating whether documents were successfully uploaded, and two integer values reporting the number of documents and total pages received.

​
Attachment result

This capability indicates whether the required documents were successfully attached to the journey session.
ValueDescription
ATTACHEDOne or more documents were successfully uploaded and stored. The files are available for manual review in the Investigation portal or for consumption by downstream processes.
NOT_ATTACHEDNo documents were uploaded. This may occur if the user abandoned the upload step, if all uploaded files failed validation, for example, unsupported file format or file size exceeded, or if the upload step was skipped. This is the default value.
ERRORAn error occurred during document processing.

​
Document count

This capability returns the number of documents successfully attached to the journey session. Each distinct file uploaded counts as one document, regardless of how many pages it contains.
DetailDescription
TypeInteger
Range0–100
Default0
A value of 0 indicates that no documents were successfully attached. Evaluation rules that depend on a minimum number of documents should check both the attachment result and the document count to distinguish between no documents uploaded and documents uploaded but fewer than required.

​
Page count

This capability returns the total number of pages across all attached documents. For multi-page documents, such as a bank statement PDF, each page is counted individually.
DetailDescription
TypeInteger
Range0–1000
Default0
This value can be used in evaluation rules to enforce minimum documentation requirements. For example, you might require that a proof of address document contains at least two pages, to confirm both the addressee and the statement period. A value of 0 indicates that no pages were captured.

​
Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.
OutcomeConditionDescription
ATTACHEDAttachment result is ATTACHEDOne or more documents were successfully uploaded and stored. The journey can proceed to manual review, downstream processing, or the next verification step.
NOT_ATTACHEDAttachment result is NOT_ATTACHEDNo documents were uploaded. Depending on your configuration, the journey may prompt the user to retry the upload, route to a reminder notification, or proceed without the supplementary documents if they’re optional.
ERRORDefault (no conditions matched)An unexpected error occurred during document processing.

​
Input payload

The following is a sample payload used to submit supporting documents to the Document Attachments module for processing.
JSON
{
  "resourceId": "<resourceId>",
  "context": {
    "subject": {
      "documents": [
        {
          "type": "Proof of Address (Utility Bill)",
          "side1Image": "<base64-encoded string>",
          "side2Image": "<base64-encoded string>"
        },
        {
          "type": "Proof of Address (Bank Statement)",
          "side1Image": "<base64-encoded string>",
          "side2Image": "<base64-encoded string>"
        },
        {
          "type": "Proof of Income (Payslip)",
          "side1Image": "<base64-encoded string>",
          "side2Image": "<base64-encoded string>"
        }
      ]
    }
  }
}
FieldRequiredDescription
typeYesDescribes the document being attached (for example, “Proof of Address (Utility Bill)”, “Proof of Address (Bank Statement)”, “Proof of Income (Payslip)”).
side1ImageYesBase64-encoded image of the front of the document.
side2ImageNoBase64-encoded image of the back of the document.
documentsYesAccepts between 1 and 10 items. Each item represents a separate attachment.