Skip to main content
GET
Get translation results

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Path Parameters

id
string
required

Identifies the case: its TruEnroll case ID, or the case number (the number shown in TruEnroll and printed on reports). Case numbers are unique across all organizations and lookups are scoped to your own.

Query Parameters

uploadId
string

Return only results for this upload in the case. Cannot be used with credentialId.

Pattern: ^[a-fA-F0-9]{24}$
credentialId
string

Return only results for this credential in the case. Cannot be used with uploadId.

Pattern: ^[a-fA-F0-9]{24}$

Response

Translation result.

success
boolean
required
Example:

true

message
string
required
meta
object
required

Optional metadata (e.g. pagination). Empty object when not applicable.

data
object
required