Skip to main content
GET
Get evaluation 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

Limit results to this upload. Cannot be used with credentialId.

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

Limit results to this existing credential. Cannot be used with uploadId.

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

Response

Current evaluation results, including progress for unfinished rows.

success
boolean
required
Example:

true

message
string
required
meta
object
required

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

data
object
required

Status aggregates the credentials in this response: queued only when nothing has been evaluated; completed when every credential has at least one evaluation and all are completed; processing otherwise. A credential with no evaluation rows counts as still waiting and holds the case at processing.