Extraction

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

Returns structured data extracted from all education credentials in the case. You can limit the response to one upload or one credential. Returns 409 if extraction was neither requested for nor run on any matching upload. Credentials an operator added in TruEnroll are always included.

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 therefore can return multiple credential results. Use credentialId when you need exactly one credential’s result.

Filter results

Use uploadId after an upload completes to retrieve only the results from that upload:

curl "https://api.truenroll.com/partner/v1/cases/$CASE_ID/extraction?uploadId=$UPLOAD_ID" \
  -H "x-api-key: $TRUENROLL_API_KEY"

Use credentialId when you need the result for one classified credential:

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

Response fields

object

Show data

number

The case number shown in TruEnroll and printed on reports. Accepted as {id} on any case route. See Addressing a case.

object[]

Extracted data for each education credential. One entry per credential identified by classification. A single uploaded file can produce multiple credentials.

Show credentials[]

string

Document category assigned by classification, e.g. Academic Credentials, Healthcare & Licensure.

string

Extraction status: queued, processing, completed, failed.

string | null

Human-readable language name of the original document, e.g. English.

string | null

ISO 639-1 language code of the original document, e.g. en.

boolean | null

true if the document appears to be missing a mark sheet.

object

Identity details of the document holder.

Show candidate

object

Identity details of the document holder.

Show candidate

string | null

Full name as it appears on the document.

string | null

First name.

string | null

Last name.

string | null

Date of birth. Format: MM/DD/YYYY.

object

Details of the issuing institution.

Show institution

object | null

Accreditation lookup result. null if not checked.

Show accreditation

object[]

Course-level records extracted from the transcript.

Show courses[]

string

Internal course record ID.

string | null

Course code, e.g. CSC148.

string | null

Course title.

number | null

Credit units for the course.

string | null

Letter or percentage grade.

string | null

Secondary grade representation if present.

number | null

Marks obtained.

number | null

Maximum marks possible.

string | null

Pass/fail status.

string | null

Academic term, e.g. Fall, Spring.

number | null

Academic session.

number | null

Year the course was taken.

object

Details of the degree or qualification.

Show qualification

object[]

Course-level records extracted from the transcript.

Show courses[]

Field reference

Credential

Field	Type	Description
`credentialId`	string	Unique credential ID. 24-character hex string.
`uploadId`	string \| null	ID of the upload that produced this credential. 24-character hex string.
`credentialType`	string \| null	Document category assigned by classification. One of: `Academic Credentials` · `Application` · `Professional` · `Identity` · `Legal` · `Financial` · `Healthcare & Licensure` · `Institutional & Administrative` · `Uncategorized`
`status`	string	`queued` · `processing` · `completed` · `failed`
`language`	string \| null	Human-readable language name of the original document, e.g. `English`.
`languageCode`	string \| null	ISO 639-1 two-letter language code, e.g. `en`, `zh`, `ar`.

Candidate

Field	Type	Description
`fullName`	string \| null	Full name as it appears on the document. Not normalized; reflects original formatting.
`firstName`	string \| null	First name extracted from the document.
`lastName`	string \| null	Last name extracted from the document.
`dateOfBirth`	string \| null	Date of birth. Format: `MM/DD/YYYY`.

Institution

Field	Type	Description
`name`	string \| null	Institution name as it appears on the document.
`country`	string \| null	Full country name, e.g. `Canada`.
`countryCode`	string \| null	ISO 3166-1 alpha-2 two-letter country code, e.g. `CA`.
`state`	string \| null	Full state or province name, e.g. `Ontario`.
`stateCode`	string \| null	ISO 3166-2 subdivision code, e.g. `CA-ON`.
`accreditation.isAccredited`	boolean \| null	Whether the institution is accredited per TruEnroll’s reference data.
`accreditation.isRecognized`	boolean \| null	Whether the institution is recognized per TruEnroll’s reference data.
`accreditation.lastChecked`	string \| null	ISO 8601 UTC datetime of the last accreditation check, e.g. `2025-06-01T00:00:00Z`.

Qualification

Field	Type	Description
`name`	string \| null	Degree name as stated on the document, e.g. `Bachelor of Science`.
`level`	string \| null	Degree level. Typical values: `SECONDARY` · `HIGHER_SECONDARY` · `BACHELORS` · `MASTERS` · `DOCTORATE` · `POST_DOCTORATE` · `DIPLOMA` · `POST_GRADUATE_DIPLOMA` · `OTHER`
`program`	string \| null	Program or field of study name.
`majorOrSpecialization`	string \| null	Major or area of specialization within the program.
`status`	string \| null	Qualification status. One of: `PURSUING` · `COMPLETED` · `INCONCLUSIVE` · `WITHDRAWN`
`registrationNumber`	string \| null	Student registration or roll number as on the document.
`yearOfAdmission`	number \| null	4-digit year the candidate was admitted, e.g. `2019`.
`yearOfCompletion`	number \| null	4-digit year the candidate completed the program, e.g. `2023`.
`programDuration`	number \| null	Nominal duration of the program in years, e.g. `4`.
`dateOfIssue`	string \| null	Date the credential was issued. Format: `MM/DD/YYYY`.
`cgpa`	number \| null	Cumulative GPA as stated on the document. Scale varies by institution.
`totalCreditsOrMarks`	number \| null	Total credits or aggregate marks as stated on the document.

Courses

Field	Type	Description
`id`	string	Internal course record ID.
`courseNumber`	string \| null	Course code as on the transcript, e.g. `CSC148`.
`courseName`	string \| null	Course title as on the transcript.
`credit`	number \| null	Credit units assigned to the course.
`grade`	string \| null	Grade as on the transcript: letter, percentage, or other notation.
`alternateGrade`	string \| null	Secondary grade representation if the document shows two grading systems.
`marksScored`	number \| null	Marks obtained by the candidate.
`maximumMarks`	number \| null	Maximum marks possible for the course.
`passStatus`	string \| null	Pass/fail result. One of: `PASS` · `FAIL` · `INCOMPLETE` · `WITHDRAWN` · `AUDIT` · `UNKNOWN`
`term`	string \| null	Academic term label, e.g. `Fall`, `Spring`, `Semester 1`.
`session`	number \| null	Numeric academic session identifier.
`year`	number \| null	4-digit year the course was taken, e.g. `2022`.

Example

{
  "success": true,
  "message": "Extraction retrieved",
  "meta": {},
  "data": {
    "id": "6850abc123def456abc78901",
    "externalId": "applicant-9876",
    "caseNumber": 10482,
    "credentials": [
      {
        "credentialId": "6850abc789abc123def45601",
        "uploadId": "6850def456abc789abc12301",
        "credentialType": "Academic Credentials",
        "status": "completed",
        "languageCode": "en",
        "language": "English",
        "candidate": {
          "fullName": "Jane Smith",
          "firstName": "Jane",
          "lastName": "Smith",
          "dateOfBirth": "03/15/1999"
        },
        "institution": {
          "name": "University of Toronto",
          "country": "Canada",
          "countryCode": "CA",
          "state": null,
          "stateCode": null,
          "accreditation": null
        },
        "qualification": {
          "name": "Bachelor of Science",
          "level": "Undergraduate",
          "program": null,
          "majorOrSpecialization": "Computer Science",
          "status": "Completed",
          "yearOfAdmission": 2017,
          "yearOfCompletion": 2021,
          "programDuration": 4,
          "cgpa": 3.72,
          "totalCreditsOrMarks": 120,
          "registrationNumber": null,
          "dateOfIssue": null
        },
        "courses": [
          {
            "id": "course_001",
            "courseNumber": "CSC148",
            "courseName": "Introduction to Computer Science",
            "credit": 0.5,
            "grade": "A",
            "alternateGrade": null,
            "marksScored": null,
            "maximumMarks": null,
            "passStatus": null,
            "term": "Fall",
            "session": null,
            "year": 2017
          }
        ]
      }
    ]
  }
}

Overview

Guides

API Reference

Path parameters

Query parameters

Filter results

Response fields

Field reference

Credential

Candidate

Institution

Qualification

Courses

Example

​Path parameters

​Query parameters

​Filter results

​Response fields

​Field reference

​Credential

​Candidate

​Institution

​Qualification

​Courses

​Example

Path parameters

Query parameters

Filter results

Response fields

Field reference

Credential

Candidate

Institution

Qualification

Courses

Example