Extraction - TruEnroll

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

Returns structured data extracted from all education credentials in the case. Returns 400 if no upload in the case was created with the extraction feature.

Path parameters

string

required

TruEnroll case ID.

Response fields

data

object

Show data

string

TruEnroll case ID.

externalId

string

Your reference for this case.

credentials

object[]

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

Show credentials[]

credentialId

string

Unique credential ID.

uploadId

string

ID of the upload this credential belongs to.

credentialType

string

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

status

string

Extraction status: queued, processing, completed, failed.

language

string | null

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

languageCode

string | null

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

markSheetMissing

boolean | null

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

candidate

object

Identity details of the document holder.

Show candidate

fullName

string | null

Full name as it appears on the document.

firstName

string | null

First name.

lastName

string | null

Last name.

dateOfBirth

string | null

Date of birth as it appears on the document.

institution

object

Details of the issuing institution.

Show institution

name

string | null

Institution name.

country

string | null

Country name.

countryCode

string | null

ISO 3166-1 alpha-2 country code, e.g. CA.

state

string | null

State or province name.

stateCode

string | null

State or province code.

accreditation

object | null

Accreditation lookup result. null if not checked.

Show accreditation

isAccredited

boolean | null

Whether the institution is accredited.

isRecognized

boolean | null

Whether the institution is recognized.

lastChecked

string | null

ISO 8601 timestamp of the last accreditation check.

qualification

object

Details of the degree or qualification.

Show qualification

name

string | null

Degree name, e.g. Bachelor of Science.

level

string | null

Degree level, e.g. Undergraduate, Postgraduate.

program

string | null

Program name.

majorOrSpecialization

string | null

Major or area of specialization.

status

string | null

Qualification status, e.g. Completed, In Progress.

registrationNumber

string | null

Student registration or roll number.

yearOfAdmission

number | null

Year the candidate was admitted to the program.

yearOfCompletion

number | null

Year the candidate completed the program.

programDuration

number | null

Duration of the program in years.

dateOfIssue

string | null

Date the credential was issued.

cgpa

number | null

Cumulative GPA as stated on the document.

totalCreditsOrMarks

number | null

Total credits or marks as stated on the document.

courses

object[]

Course-level records extracted from the transcript.

Show courses[]

string

Internal course record ID.

courseNumber

string | null

Course code, e.g. CSC148.

courseName

string | null

Course title.

credit

number | null

Credit units for the course.

grade

string | null

Letter or percentage grade.

alternateGrade

string | null

Secondary grade representation if present.

gradePoint

number | null

Grade point value, e.g. 4.0.

marksScored

number | null

Marks obtained.

maximumMarks

number | null

Maximum marks possible.

passStatus

string | null

Pass/fail status.

term

string | null

Academic term, e.g. Fall, Spring.

session

number | null

Academic session.

year

number | null

Year the course was taken.

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`.
`markSheetMissing`	boolean \| null	`true` if the document appears to be missing a mark sheet.

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.
`gradePoint`	number \| null	Numeric grade point, e.g. `3.7`. Scale depends on the institution.
`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",
  "data": {
    "id": "6850abc123def456ghi789",
    "externalId": "applicant-9876",
    "credentials": [
      {
        "credentialId": "6850ghi789abc123def456",
        "uploadId": "6850def456ghi789abc123",
        "credentialType": "Academic Credentials",
        "status": "completed",
        "languageCode": "en",
        "language": "English",
        "markSheetMissing": null,
        "candidate": {
          "fullName": "Jane Smith",
          "firstName": "Jane",
          "lastName": "Smith",
          "dateOfBirth": "1999-03-15"
        },
        "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",
            "gradePoint": 4.0,
            "marksScored": null,
            "maximumMarks": null,
            "passStatus": null,
            "term": "Fall",
            "year": 2017
          }
        ]
      }
    ]
  }
}

​Path parameters

​Response fields

​Field reference

​Credential

​Candidate

​Institution

​Qualification

​Courses

​Example

Path parameters

Response fields

Field reference

Credential

Candidate

Institution

Qualification

Courses

Example