Forensics results

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

Returns a forensics entry per analyzed file. Once a run is completed, each entry includes the structured verdict, document context, a plain-language summary, topEvidence, and the per-check outcomes in checks[] — so you can ingest results programmatically without parsing the PDF. A reportUrl still links to the full PDF report, viewerUrl opens the interactive result viewer, and documentUrl links to the analyzed source document. Returns 409 if forensics was neither requested for nor run on any matching upload. See Forensics & verification for what’s checked. Multi-file and multi-credential cases return one entry per credential (keyed by credentialId + fileId). Rich fields appear only for completed entries; while a run is still queued, processing, or failed the entry keeps the lean shape (uploadId, credentialId, fileId, status, reportUrl, viewerUrl, documentUrl).

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. A credential that has since been deleted also 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/forensics?uploadId=$UPLOAD_ID" \
  -H "x-api-key: $TRUENROLL_API_KEY"

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

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.

object[]

One entry per analyzed file across all uploads that had forensics enabled.

Show forensics[]

string | null

ID of the upload this forensics result belongs to.

string | null

ID of the credential this result relates to. Every upload becomes credentials, so with classify: false this is the upload’s single credential.

string

ID of the source file the forensics result was produced from.

string

Forensics status: queued, processing, completed, failed.

string | null

Overall risk verdict for the document, e.g. LOW RISK, MEDIUM RISK, HIGH RISK. Present once status is completed.

string | null

Name/title of the document as identified during analysis.

string | null

Candidate name extracted from the document.

string | null

Registration or serial number extracted from the document.

string | null

Issuing institution identified for the document.

string | null

Secondary issuer (e.g. affiliated college or partner program), when applicable.

integer | null

Year the document was issued.

string | null

Plain-language summary of the overall forensics assessment.

string[]

Key evidence statements supporting the verdict. Empty array when none apply.

object[]

Per-check outcomes from the standard forensics check set. Empty array until completed.

Show checks[]

integer

1-based position of the check in the standard check set.

string

Short name of the check.

string

Outcome of the check, e.g. PASS, FAIL, or UNVERIFIED when it could not be conclusively evaluated.

string

Human-readable explanation of the check outcome.

string | null

URL to the full forensics PDF report. Available once status is completed.

string | null

URL to the interactive forensics result viewer for this analysis. Available once status is completed.

string | null

URL to the source document the analysis was run against. Available once status is completed.

Example

{
  "success": true,
  "message": "Forensics retrieved",
  "meta": {},
  "data": {
    "id": "6850abc123def456abc78901",
    "externalId": "applicant-9876",
    "caseNumber": 10482,
    "forensics": [
      {
        "uploadId": "6850def456abc789abc12301",
        "credentialId": "6850abc789abc123def45601",
        "fileId": "file_abc",
        "status": "completed",
        "verdict": "LOW RISK",
        "documentName": "Bachelor of Science",
        "candidateName": "Syed Muhammad Ali",
        "registrationNumber": "150264",
        "issuerName": "Oxford Brookes University",
        "issuerSubName": null,
        "issuanceYear": 2019,
        "summary": "This Bachelor of Science has been identified as low risk. Oxford Brookes University is a recognized UK institution and the document terminology aligns with official templates.",
        "topEvidence": [
          "Terminology and spelling match official Oxford Brookes University templates.",
          "Oxford Brookes University is a recognized UK degree-awarding body.",
          "No structural anomalies or integrity issues detected."
        ],
        "checks": [
          { "checkNumber": 1, "title": "Name & Identity", "status": "PASS", "description": "The candidate's name is clearly stated and consistent throughout the document." },
          { "checkNumber": 5, "title": "Institution Identity", "status": "PASS", "description": "Oxford Brookes University is a legitimate, recognized UK higher education institution." },
          { "checkNumber": 11, "title": "Digital Footprint & URLs", "status": "UNVERIFIED", "description": "No verification QR code or URL was detected on the document." }
        ],
        "reportUrl": "https://...",
        "viewerUrl": "https://...",
        "documentUrl": "https://..."
      }
    ]
  }
}

Overview

Guides

API Reference

Path parameters

Query parameters

Filter results

Response fields

Example

​Path parameters

​Query parameters

​Filter results

​Response fields

​Example

Path parameters

Query parameters

Filter results

Response fields

Example