Skip to main content
GET
/
cases
/
{id}
/
extraction
Get extraction results
curl --request GET \
  --url https://eval-api.trential.dev/partner/v1/cases/{id}/extraction \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "credentials": [
      {
        "credentialId": "<string>",
        "candidate": {
          "fullName": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "dateOfBirth": "<string>"
        },
        "institution": {
          "name": "<string>",
          "country": "<string>",
          "countryCode": "<string>",
          "state": "<string>",
          "stateCode": "<string>",
          "accreditation": {
            "isAccredited": true,
            "isRecognized": true,
            "lastChecked": "2023-11-07T05:31:56Z"
          }
        },
        "qualification": {
          "registrationNumber": "<string>",
          "name": "<string>",
          "level": "<string>",
          "program": "<string>",
          "majorOrSpecialization": "<string>",
          "status": "<string>",
          "yearOfAdmission": null,
          "yearOfCompletion": null,
          "programDuration": null,
          "dateOfIssue": "<string>",
          "cgpa": null,
          "totalCreditsOrMarks": null
        },
        "courses": [
          {
            "id": "<string>",
            "courseNumber": "<string>",
            "courseName": "<string>",
            "credit": null,
            "grade": "<string>",
            "alternateGrade": "<string>",
            "gradePoint": null,
            "marksScored": null,
            "maximumMarks": null,
            "passStatus": "<string>",
            "term": "<string>",
            "session": null,
            "year": null
          }
        ],
        "uploadId": "<string>",
        "credentialType": "<string>",
        "languageCode": "<string>",
        "language": "<string>",
        "markSheetMissing": true
      }
    ],
    "externalId": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Partner API key. Also accepted as Authorization: Bearer <key>.

Path Parameters

id
string
required

TruEnroll case ID.

Response

Extraction result.

success
boolean
required
Example:

true

message
string
required
data
object
required