---
title: "Finalize a collection"
method: POST
path: "/v1/documents/collections/{collection_id}/finalize/"
tags: ["Document Collections"]
---

# Finalize a collection

`POST /v1/documents/collections/{collection_id}/finalize/`

The endpoint finalizes a document collection by creating or updating links for all matched documents and users. Optionally accepts a subset of document IDs to finalize. If no document_ids provided, all recognized documents in the collection will be finalized.

## Request body

- FinalizeCollectionRequest
  - `document_ids` string[] — Optional list of document IDs to finalize. If not provided, all recognized documents in the collection will be finalized.
  - `product_type` 'income' | 'employment' — Product type for finalization. Defaults to 'income' if not provided.

## Response `200`

- FinalizeCollectionResponse
  - `users` FinalizeUser[], required — List of users with their links and documents
    - `id` string, required — Truv user ID
    - `external_user_id` string, nullable — External system user ID (optional)
    - `links` FinalizeLink[], required — List of links created/updated for this user
      - `link_id` string, required — Truv link ID
      - `status` 'new' | 'login' | 'mfa' | 'parse' | 'full_parse' | 'done' | 'no_data' | 'login_error' | 'mfa_error' | 'account_locked' | 'config_error' | 'error' | 'unavailable', required — Current status of the link. Final statuses (processing complete): done, no_data, config_error, error, unavailable. For more details, see the Connection Lifecycle documentation.
      - `documents` FinalizeDocument[], required — List of documents associated with this link
        - `id` string, required — Recognized document ID
        - `document_type` string, required — Type of the document (uppercase)
        - `document_subtype` string, nullable — Subtype of the document (uppercase, optional)

## Other responses

- `400` — HTTP 400 Bad Request
- `401` — HTTP 401 Unauthorized
- `403` — HTTP 403 Forbidden
- `404` — HTTP 404 Not Found

---

[API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/versions/b92671dcb52d/schema)