What you can do
Submit a case
Upload up to 20 PDF or image files in one request. Choose which features to run
(extraction, forensics, translation) and get a
caseId back immediately.Track processing
List and inspect cases by your
externalId or by TruEnroll’s caseId. Check
overall status and per-feature progress.Fetch results
Pull structured extraction data, forensics findings, and translated representations
through dedicated result endpoints.
React to events
Receive webhooks as each stage completes or fails. Events are idempotent per case —
no need to poll.
Compliance
TruEnroll is SOC 2, ISO 27001, and ISO 27701 certified. See the Compliance page for details or to request audit documentation.Base URL
/partner/v1 and are separate from the internal
platform API.
Endpoints at a glance
| Method | Path | Description |
|---|---|---|
POST | /cases | Submit documents and create a case |
GET | /cases | List cases for your organization |
GET | /cases/{id} | Get case status and summary |
GET | /cases/{id}/extraction | Fetch structured extraction result |
GET | /cases/{id}/forensics | Fetch forensics findings |
GET | /cases/{id}/translation | Fetch translation output |
DELETE | /cases/{id} | Soft-delete a case |
Integration flow
Key design decisions
externalId identifies a case. It is unique per organization. Submitting to an externalId
that already exists adds a new upload to the existing case — it does not create a new one. Use
your candidate ID or application number as the externalId to group all their document
submissions under one case.
Events are idempotent. Each terminal event for a given case is dispatched at most once.
Your handler should be idempotent as well, since network infrastructure can deliver duplicates.
Organization feature is checked before upload. If you request a feature your
organization isn’t provisioned for, TruEnroll returns 403 synchronously — no files are
transferred.
Partner keys only. Partner API routes only accept partner API keys provisioned for your
organization.
Authentication
How to provision and send partner API keys.
Cases
Full case lifecycle, request schema, and status transitions.
Webhooks
Every event name, payload, and deduplication behavior.
Features & limits
Upload constraints, feature prerequisites, and error codes.