Translation results

GET /partner/v1/cases/{id}/translation

Returns a readable HTML representation per source file, structured by page, and a link to the rendered translated PDF when available. You can limit the response to one upload or one credential. Returns 409 if translation was neither requested for nor run on any matching upload.

Path parameters

string

required

TruEnroll case ID, or the case number. See Addressing a case.

Query parameters

string

Return results produced by one upload in this case.

string

Return the result for one credential in this case.

Omit both parameters to retrieve results for every upload in the case. Send at most one parameter: using both returns 400. The supplied ID must belong to the case, or the API returns 404. When an upload was submitted with classify: true, it can produce more than one credential. Filtering by uploadId can therefore return multiple credential results. Use credentialId when you need one credential’s result.

Filter results

Use the identifiers from your webhook event to retrieve results for the completed upload or credential:

curl "https://api.truenroll.com/partner/v1/cases/$CASE_ID/translation?uploadId=$UPLOAD_ID" \
  -H "x-api-key: $TRUENROLL_API_KEY"

curl "https://api.truenroll.com/partner/v1/cases/$CASE_ID/translation?credentialId=$CREDENTIAL_ID" \
  -H "x-api-key: $TRUENROLL_API_KEY"

Open the translated document

Open a file’s htmlUrl in your browser to view or download the translated PDF. The PDF is generated from the translated HTML pages in source order. Signed download links work without a TruEnroll portal login or API key. These URLs are temporary and expire. If a URL expires, request translation results again to obtain a fresh link. The URL is null when no rendered translated PDF is stored. Check the file’s status to confirm that translation completed successfully. Having a download link alone does not confirm successful completion. Existing translations receive a link when their rendered PDF is available. Retrieving results does not rerun translation. Treat the URL as a document access credential and share it only with intended recipients.

Response fields

object

Show data

string

TruEnroll case ID.

string

Your reference for this case.

number

The case number shown in TruEnroll and printed on reports. Accepted as {id} on any case route. See Addressing a case.

string

Aggregate translation status across all files: queued, processing, completed, failed.

object[]

One entry per source file across all uploads that had translation enabled.

Show files[]

string

ID of the upload this file belongs to.

string | null

ID of the credential this file belongs to. With classify: false this is the upload’s single credential.

string

ID of the source file.

string

Original filename.

string

Translation status for this file: queued, processing, completed, failed.

string | null

URL to the rendered translated PDF, or null when no PDF is stored. Check the file’s status to confirm that translation completed successfully. These URLs are temporary and expire. Request translation results again to obtain a fresh link after expiry.

string | null

Full HTML translation of the document as a single string. Available once status is completed.

string[] | null

Per-page HTML strings preserving the original page structure. Available once status is completed.

Example

{
  "success": true,
  "message": "Translation retrieved",
  "meta": {},
  "data": {
    "id": "6850abc123def456abc78901",
    "externalId": "applicant-9876",
    "caseNumber": 10482,
    "status": "completed",
    "files": [
      {
        "uploadId": "6850def456abc789abc12301",
        "credentialId": "6850abc789abc123def45601",
        "fileId": "file_abc",
        "fileName": "transcript.pdf",
        "status": "completed",
        "htmlUrl": "https://.../formattedFiles/transcript.pdf?...",
        "htmlRepresentation": "<html>...</html>",
        "htmlPages": ["<html>page 1</html>", "<html>page 2</html>"]
      }
    ]
  }
}

Overview

Guides

API Reference

Translation results

Path parameters

Query parameters

Filter results

Open the translated document

Response fields

Example

​Path parameters

​Query parameters

​Filter results

​Open the translated document

​Response fields

​Example

Path parameters

Query parameters

Filter results

Open the translated document

Response fields

Example