Skip to main content

Features

The Partner API exposes three features you can request per case. Features must be enabled for your organization before they can be used — requesting an unavailable feature fails synchronously with 403 before any files are uploaded.

Extraction

Included in every case. AI-powered extraction of:
  • Candidate identity (name, date of birth)
  • Institution (name, country, state, accreditation)
  • Qualification (degree, major, year of admission/completion)
  • Courses (number, title, credits, grade, grade point, marks)
  • CGPA and total credits
Extraction results are available via GET /cases/{id}/extraction once case.extraction.completed is received. Organization requirement: Always available. No special provisioning needed.

Forensics

Runs in parallel with extraction. Checks the original uploaded file for tampering, manipulation, metadata anomalies, and internal inconsistencies. See Forensics & verification for details. Organization requirement: Your organization must have the forensics feature provisioned. Contact your TruEnroll account manager. Webhook: case.forensics.completed / case.forensics.failed

Translation

Produces a page-structured, readable representation of each uploaded document. Results are returned per source file, preserving page order and file identity. Multi-file cases get one translation output per file. Organization requirement: Your organization must have either the standard translation or translation_on_demand feature provisioned. Webhook: case.translation.completed / case.translation.failed

Upload limits

ConstraintLimit
Files per case20
File size per file30 MB
Total request payload40 MB
Pages per PDF130
Accepted MIME typesapplication/pdf, image/png, image/jpeg, image/webp, application/zip, application/x-zip-compressed
ZIP archives are accepted and counted as a single file toward the 20-file limit. Files inside a ZIP that are not of a supported type will appear in the upload’s files[] list but will not be processed.
Need higher limits? Contact us to discuss increased file sizes or per-request limits for your organization.

Limit errors

ErrorHTTP status
File count exceeds 20400 Bad Request
Single file exceeds 30 MB413 Content Too Large
Total payload exceeds 40 MB413 Content Too Large
PDF exceeds 130 pagesProcessing fails with an error on that credential
Unsupported MIME type400 Bad Request
{
  "statusCode": 413,
  "message": "File size exceeds the 30 MB limit"
}

Feature validation timing

Feature checks happen before file upload begins. This means:
  1. TruEnroll reads your features array from the request.
  2. It loads your organization’s feature configuration.
  3. If any requested feature is not available, it returns 403 immediately.
  4. No files are transferred, no case is created.
This prevents wasted upload bandwidth when a feature is misconfigured.

Rate limits

Specific rate limits are configured per organization based on your contract. Contact your TruEnroll account manager for your organization’s limits. When a rate limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header.