Skip to main content
POST
/
v1
/
documents
/
collections
/
{collection_id}
/
finalize
Finalize a collection
curl --request POST \
  --url https://prod.truv.com/v1/documents/collections/{collection_id}/finalize/ \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "document_ids": [
    "d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6",
    "a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4"
  ],
  "product_type": "income"
}
'
{
  "users": [
    {
      "id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "links": [
        {
          "link_id": "c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9",
          "status": "done",
          "documents": [
            {
              "id": "d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6",
              "document_type": "PAYSTUB",
              "document_subtype": null
            }
          ]
        }
      ],
      "external_user_id": "ext_user_789"
    }
  ]
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
collection_id
string
required

Collection ID

Body

application/json
​
document_ids
string[]

Optional list of document IDs to finalize. If not provided, all recognized documents in the collection will be finalized.

Example:
[
  "d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6",
  "a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4"
]
​
product_type
enum<string>
default:income

Product type for finalization. Defaults to 'income' if not provided.

Available options:
income,
employment
Example:

"income"

Response

​
users
Users · object[]
required

List of users with their links and documents