TRtruv
Document Collections

Get collection finalization results

Changed on

Returns the current finalization results for the collection: the users involved, their links, and the documents associated with each link. This endpoint does not expose a top-level status; use the presence and contents of users/links/documents to inspect the result.

get/v1/documents/collections/{collection_id}/finalize/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/documents/collections/{collection_id}/finalize/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Response

Example response

{
  "users": [
    {
      "id": "a1b2c3d4e5f6478899aabbccddeeff00",
      "external_user_id": "ext_user_789",
      "links": [
        {
          "link_id": "c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9",
          "status": "done",
          "documents": [
            {
              "id": "d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6",
              "document_type": "PAYSTUB"
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • e58688835e25Revision changes
    • warning

      added the new account_locked enum value to the //// response property for the response status

    • warning

      added the new login enum value to the //// response property for the response status

    • warning

      added the new login_error enum value to the //// response property for the response status

    • warning

      added the new mfa enum value to the //// response property for the response status

    • warning

      added the new mfa_error enum value to the //// response property for the response status