Translation results

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

Returns a readable HTML representation per source file, structured by page. Returns 409 if no upload was created with the translation feature.

Path parameters

string

required

TruEnroll case ID.

Response fields

object

Show data

string

TruEnroll case ID.

string

Your reference for this 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. null for raw files (uploads submitted with classify: false).

string

ID of the source file.

string

Original filename.

string

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

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": "6850abc123def456ghi789",
    "externalId": "applicant-9876",
    "status": "completed",
    "files": [
      {
        "uploadId": "6850def456ghi789abc123",
        "credentialId": "6850ghi789abc123def456",
        "fileId": "file_abc",
        "fileName": "transcript.pdf",
        "status": "completed",
        "htmlRepresentation": "<html>...</html>",
        "htmlPages": ["<html>page 1</html>", "<html>page 2</html>"]
      }
    ]
  }
}

Overview

Guides

API Reference

Translation results

Path parameters

Response fields

Example

​Path parameters

​Response fields

​Example

Path parameters

Response fields

Example