Get extraction results
curl --request GET \
--url https://eval-api.trential.dev/partner/v1/cases/{id}/extraction \
--header 'x-api-key: <api-key>'import requests
url = "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://eval-api.trential.dev/partner/v1/cases/{id}/extraction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eval-api.trential.dev/partner/v1/cases/{id}/extraction")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eval-api.trential.dev/partner/v1/cases/{id}/extraction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"id": "<string>",
"caseNumber": 123,
"credentials": [
{
"credentialId": "<string>",
"status": "queued",
"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>",
"marksScored": null,
"maximumMarks": null,
"passStatus": "<string>",
"term": "<string>",
"session": null,
"year": null
}
],
"uploadId": "<string>",
"credentialType": "<string>",
"languageCode": "<string>",
"language": "<string>"
}
],
"externalId": "<string>"
}
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Results
Get extraction results
Returns structured data extracted from all credentials in the case. Optionally limit the response to one upload or one credential.
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>'import requests
url = "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://eval-api.trential.dev/partner/v1/cases/{id}/extraction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://eval-api.trential.dev/partner/v1/cases/{id}/extraction"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://eval-api.trential.dev/partner/v1/cases/{id}/extraction")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://eval-api.trential.dev/partner/v1/cases/{id}/extraction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"meta": {},
"data": {
"id": "<string>",
"caseNumber": 123,
"credentials": [
{
"credentialId": "<string>",
"status": "queued",
"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>",
"marksScored": null,
"maximumMarks": null,
"passStatus": "<string>",
"term": "<string>",
"session": null,
"year": null
}
],
"uploadId": "<string>",
"credentialType": "<string>",
"languageCode": "<string>",
"language": "<string>"
}
],
"externalId": "<string>"
}
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}{
"statusCode": 123,
"message": "<string>"
}Authorizations
Partner API key. Also accepted as Authorization: Bearer <key>.
Path Parameters
Identifies the case: its TruEnroll case ID, or the case number (the number shown in TruEnroll and printed on reports). Case numbers are unique across all organizations and lookups are scoped to your own.
Query Parameters
Return only results for this upload in the case. Cannot be used with credentialId.
Pattern:
^[a-fA-F0-9]{24}$Return only results for this credential in the case. Cannot be used with uploadId.
Pattern:
^[a-fA-F0-9]{24}$