Supporting Documents Review

What is Supporting Documents Review?

Supporting Documents Review is a feature that allows your compliance team to manually review and verify documents that fall outside of standard IDV or eKYC checks. This is useful for verifying proof of address, source of funds, or other supplementary evidence required by your compliance policies.

The process bridges manual verification with automated workflows. A compliance officer can approve or reject a document, and that decision is then automatically consumed by a workflow step to determine the outcome of the KYC process, ensuring a complete and auditable trail.

How It Works

The process involves uploading a supporting document, having an operator review it via an API call, and then executing a workflow that checks for the review outcome.

API Integration Guide

Integrating the Supporting Documents Review feature involves two main API calls: uploading the document and submitting the review decision.

1. Uploading a Supporting Document

To begin the process, create a document with the class specified as SUPPORTING. This is done by making a POST request to the /v2/individuals/{individualId}/documents endpoint.

The type field should specify the kind of supporting document being uploaded. See the table below for supported types.

Example Request: Uploading a Utility Bill

1
{
2
  "document": {
3
    "class": "SUPPORTING",
4
    "documentId": "doc-supp-12345-utility-bill",
5
    "type": "UTILITY_BILL",
6
    "country": "AUS"
7
  }
8
}

2. Submitting a Review Decision

After an internal review, you must submit the decision using the PATCH /v2/individuals/{entityId}/documents/{documentId}/status endpoint. This call updates the status of the document’s corresponding check.

You must provide the entityId and documentId in the URL path, and a request body containing a status of either APPROVED or REJECTED, and an optional reason.

Example Request: Approving a Document

Call PATCH /v2/individuals/ind-abc-123/documents/doc-supp-12345-utility-bill/status with the following body:

1
{
2
  "status": "APPROVED",
3
  "reason": "Document is clear and details match entity profile."
4
}

Workflow Step Configuration

To use the review decision in your automated checks, you must add the SUPPORTING_DOCUMENTS_REVIEW step to your workflow.

• Logic: This step checks for any SUPPORTING_DOC checks associated with the entity.
• Success Condition: The step will return SUCCESS if at least one supporting document has been APPROVED.
• Failure Condition: If no documents have been approved (i.e., they are all PENDING_REVIEW or REJECTED), the step will return FAILURE.
• Skipped Condition: If no supporting documents have been uploaded for the entity, the step will be SKIPPED.

Example Workflow Result

Here is an example of the workflowStepResult object you would receive after a workflow containing the SUPPORTING_DOCUMENTS_REVIEW step has been executed for an entity with an approved document.

1
{
2
  "workflowStepResults": [
3
    {
4
      "stepName": "SUPPORTING_DOCUMENTS_REVIEW",
5
      "result": "SUCCESS",
6
      "processResults": [
7
        {
8
          "provider": "MANUAL",
9
          "objectType": "SUPPORTING_DOC",
10
          "class": "KYC",
11
          "result": "APPROVED",
12
          "checkDate": "2025-10-15T08:15:30.000Z",
13
          "data": {
14
            "documentId": "doc-supp-12345-utility-bill",
15
            "reason": "Document is clear and details match entity profile."
16
          }
17
        }
18
      ]
19
    }
20
  ]
21
}

Supported Document Types

The type field for SUPPORTING class documents can be one of the following values: