Overview

The Scholaro GPA Report integration allows institutions to automatically generate GPA reports from transcripts using multiple methods depending on their workflow.

You can choose from the following options:

1. API (Single Report) - create one report at a time
2. Bulk API Upload - process multiple transcripts in a ZIP file
3. SFTP Upload - fully automated file-based integration

All methods use the same underlying processing and produce identical GPA reports.

Choosing the Right Method

Authentication

To use the API, include your API key in every request.

Header:

X-API-Key: your_signing_secret_here

Note:

You can obtain your API key (Signing Secret) from the Developer page:

https://www.scholaro.com/app/developer/webhooks

Single Report API

POST

https://www.scholaro.com/appAPI/api/gpa-report/new

Request Parameters

Send data as multipart/form-data.

Response

{
  "message": "string",
  "url": "string",
  "gpa_report": {
    "report_id": 123456,
    "applicant_name": "string",
    "report_name": "string",
    "country": "string",
    "institution": "string",
    "total_credits": 0.0,
    "total_points": 0.0,
    "gpa": 0.0,
    "grades": []
  }
}

Example Requests

cURL

curl -X POST https://www.scholaro.com/appAPI/api/gpa-report/new \
-H "X-API-Key: your_signing_secret_here" \
-F "country=India" \
-F "applicant_name=Jane Smith" \
-F "report_name=Fall 2024 GPA Report" \
-F file=@/path/to/transcript.pdf

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_signing_secret_here");

using var content = new MultipartFormDataContent();
content.Add(new StringContent("Mexico"), "country");
content.Add(new StringContent("John Smith"), "applicant_name");
content.Add(new StringContent("Fall 2024 GPA Report"), "report_name");

string transcriptPath = "./path/to/transcript.pdf";
var fileContent = new ByteArrayContent(File.ReadAllBytes(transcriptPath));
fileContent.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");

content.Add(fileContent, "file", "transcript.pdf");

var response = await client.PostAsync(
    "https://www.scholaro.com/appAPI/api/gpa-report/new",
    content
);

JavaScript (Fetch)

import { FormData } from 'formdata-node';
import { fileFromPath } from 'formdata-node/file-from-path';

const formData = new FormData();
formData.append('country', 'Germany');
formData.append('applicant_name', 'Jack Smith');
formData.append('report_name', 'Fall 2024 GPA Report');

const file = await fileFromPath("./path/to/transcript.pdf");
formData.append('file', file);

const response = await fetch(
  'https://www.scholaro.com/appAPI/api/gpa-report/new',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'your_signing_secret_here'
    },
    body: formData
  }
);

Python

import requests

url = "https://www.scholaro.com/appAPI/api/gpa-report/new"

headers = {
    "X-API-Key": "your_signing_secret_here"
}

files = {
    'file': ('transcript.pdf', open('/path/to/transcript.pdf', 'rb'), 'application/pdf')
}

data = {
    'country': 'Brazil',
    'applicant_name': 'Jane Smith',
    'report_name': 'Fall 2024 GPA Report'
}

response = requests.post(url, headers=headers, files=files, data=data)
result = response.json()

Requirements & Access

Requirement:
The transcript file must be a valid PDF.

Access:
This API is available only to institutional Premium users.

https://www.scholaro.com/appAPI/api/gpa-report/bulk

file: bulk-upload.zip

file_name,country,applicant_name,report_name,date_of_birth,custom_field_1,custom_field_2,custom_field_3
brazil-transcript.pdf,Brazil,Jane Smith,Fall 2024 Report,01/15/1995,Field1,Field2,Field3
india-transcript.pdf,India,John Doe,Spring 2024 Report,,,,

{
  "batch_id": "5797602d-f05f-495b-8cb9-220c8e2c5df5",
  "total_items": 5,
  "status_url": "/api/gpa-report/bulk/{batch_id}"
}

curl -X POST https://www.scholaro.com/appAPI/api/gpa-report/bulk \
-H "X-API-Key: your_signing_secret_here" \
-F file=@/path/to/bulk-upload.zip

https://www.scholaro.com/appAPI/api/gpa-report/bulk/{batch_id}

{
  "batch_id": "5797602d-f05f-495b-8cb9-220c8e2c5df5",
  "status": "Completed",
  "total_items": 5,
  "completed_items": 3,
  "failed_items": 2,
  "created_on": "2024-12-15T10:30:00Z",
  "completed_on": "2024-12-15T10:35:00Z",
  "items": [
    {
      "file_name": "brazil-transcript.pdf",
      "status": "Completed",
      "report_id": 737271,
      "error_message": null
    }
  ]
}

curl -X GET https://www.scholaro.com/appAPI/api/gpa-report/bulk/{batch_id} \
-H "X-API-Key: your_signing_secret_here"

import requests
import time

url = "https://www.scholaro.com/appAPI/api/gpa-report/bulk"
headers = {"X-API-Key": "your_signing_secret_here"}

# Upload
files = {
    'file': ('bulk-upload.zip', open('/path/to/bulk-upload.zip', 'rb'), 'application/zip')
}
response = requests.post(url, headers=headers, files=files)
batch_id = response.json()['batch_id']

# Poll
while True:
    status = requests.get(f"{url}/{batch_id}", headers=headers).json()

    completed = status["completed_items"] + status["failed_items"]
    print(f"{completed}/{status['total_items']} processed")

    if status["status"] != "Processing":
        break

    time.sleep(10)

sftp scholaronorthussftp.myuser@scholaronorthussftp.blob.core.windows.net

put brazil-transcript.pdf
put india-transcript.pdf
put manifest.csv