Searching Archived Process Instances

Early Access

The 'Archived Instances' page provides a list of all archived Process Instances in the TrustX system. This page provides robust search and filter functionality to return search results pertaining to specific properties.

The 'Archived Instances' page can be found under the 'Archives' tab in the Backoffice application.

Using the Search and Filter Controls

The 'Archived Process Instances' page provides a robust selection of search and filter controls.

Filter Archived Process Instances - Enables users to filter results by associated tokens. For example, processInstanceID:{YourIDHere}
Remove After Date - Filter by the date on which the archived will be removed from TrustX.
Created Between - Filter by date the Process Instance was created. A custom range can be entered using a 'Date Created From' and 'Date Created To' range.

Filtering Syntax

The full filtering syntax available for the 'Filter Archived Process Instances' field can be found in the Backoffice by selecting the search field and clicking the 'Filtering Syntax Documentation'.

The full syntax can be found below:

Exporting Archived Process Instances

Archived data associated with a Process Instance can be exported using the 'export' button under the 'Actions' column of a given Process Instance.

Example:

To unzip the downloaded archive, the passcode or .pem file used when creating the associated archiving policy will be required. See the Archive Policy Guide for more information.

Searching Archived Process Instances via TrustX API

The TrustX API can be used to search and export archived Process Instances. This process involves starting an archive search request, polling the status and completing once finished.

To utilize the TrustX API, an API key is required. See the API Keys Guide for more information on generating an API key.

Start an Archive Search

Submits an asynchronous query. Returns an executionID. After the query is executed, poll the status until SUCCEEDED is returned. The fromTime and toTime fields are required.

API Permissions: TNT#{tenantid}#ProcessManager:startQuery

Example Request:

POST https://{{tenant}}.{{region}}.trustx.com/api/process-manager/archives/queries/start Content-Type: application/json X-API-Key: {{apiKey}} { "processInstanceId": "{string}", "processTokenId": "{string}", "status": "{string}", "outcome": "{string}", "reviewedBy": "{string}", "processDefinitionId": "{string}", "processDefinitionName": "{string}", "processDefinitionVersion": "{int32}", "externalId": "{string}", "firstName": "{string}", "lastName": "{string}", "dateOfBirth": "{string}", "phoneNumber": "{string}", "email": "{string}", "nationality": "{string}", "docNum1": "{string}", "docNum2": "{string}", "docNum3": "{string}", "docNum4": "{string}", "docNum5": "{string}", "policyName": "{string}", "policyId": "{string}", "policyVersion": "{int32}", "archiveKey": "{string}", "location": "{string}", "removeAfterDate": "{string}", "sort": "{string}", "fromTime": "{date-time}", "toTime": "{date-time}" }

Example Response:

{ c872d90f-91a2-4ef2-b4ea-bcb38b8caea9 }

Polling Archive Search Status

Returns the query state of the given archive status. Possible statuses include: QUEUED, RUNNING, SUCCEEDED, FAILED, or CANCELLED.

API Permissions: TNT#{tenantid}#ProcessManager:getQueryStatus

Example Request:

GET https://{{tenant}}.{{region}}.trustx.com/api/process-manager/archives/queries/{executionId}/status Content-Type: application/json X-API-Key: {{apiKey}} { }

Example Response:

{ SUCCEEDED }

Complete Archive Search

Returns a page of archive metadata records. Pass nextToken to retrieve subsequent pages. Results contain S3 object keys only. ZIP files are not decrypted.

API Permissions: TNT#{tenantid}#ProcessManager:getQueryResults

Example Request:

GET https://{{tenant}}.{{region}}.trustx.com/api/process-manager/archives/queries/{executionId}/result Content-Type: application/json X-API-Key: {{apiKey}} { }

Example Response:

{ "results": [ { "processInstanceId": "DP3INE753VNU6U4SJB5F6NHLUA", "tenantId": "skydev1", "createdDtm": "2026-08-19T10:38:49.000Z", "completedDtm": "2026-08-19T10:39:44.423Z", "archiveDate": "2026-08-19", "processDefinitionId": "YDXSGSQN36Q5CZ4CHFGA7YBSD4", "processDefinitionName": "idcapturetest", "processDefinitionVersion": 3, "processTokenId": "JY6QOFVPRHN4BLGXA7L5K6P274", "status": "COMPLETED_ENDED_SUCCESS", "statusMapped": "Accepted", "firstName": "Example", "lastName": "Name", "dateOfBirth": "1984-04-03", "docNum1": "011869335", "archivePolicyId": "SKYO6U5UVEFQ25LAR7F6ND4JTQ", "archivePolicyName": "SimplePolicy", "archivePolicyVersion": 2, "location": "processArchives/SimplePolicy/2026-08-19/DP3INE753VNU6U4SJB5F6NHLUA.SKYO6U5UVEFQ25LAR7F6ND4JTQ.SKV1.zip", "archiveKey": "processArchives/SimplePolicy/2026-08-19/DP3INE753VNU6U4SJB5F6NHLUA.SKYO6U5UVEFQ25LAR7F6ND4JTQ.SKV1.zip", "signatureKey": "processArchives/SimplePolicy/2026-08-19/DP3INE753VNU6U4SJB5F6NHLUA.SKYO6U5UVEFQ25LAR7F6ND4JTQ.SKV1.zip.signature.asc", "fileKey": "53696d706c65506f6c6963792f323032362d30382d31392f445033494e45373533564e55365534534a423546364e484c55412e534b594f365535555645465132354c41523746364e44344a54512e534b56312e7a6970" }... ], "nextToken": "QVdMTkV2RXNESDZlNXg3cGY4Rm0wVWo2dElYNHRja01jS0xJdFZxSEFyUUdBUXZwUlpZenorZG9wUXZQczkyTlhNakF2RGxGSldUMUNGY2RIZWlid3ZCTG9IKzVpUkZGRnc9PQ" }

Download the Archive ZIP File

Decodes the fileKey to reconstruct the S3 key and streams the encrypted ZIP bytes. The fileKey is returned in each archive search result.

API Permissions: TNT#{tenantid}#ProcessManager:getArchiveFile

Example Request:

GET https://{{tenant}}.{{region}}.trustx.com/api/process-manager/archives/queries/{executionId}/result Content-Type: application/json X-API-Key: {{apiKey}} { }

Example Response:

{ PK3� c�\]��@��doc1/7e6ef97a-949c-4933-a981-a65c6bdb139e/processor-results.json ... }

Last updated on