Skip to main content

How do I set up the Transcript Reader integration?

The two syncs the Transcript Reader needs, how data flows between your systems and CollegeVine, and where to find each setup guide.

The Transcript Reader connects to your systems with two SFTP syncs: one that sends student information, and one that sends the transcripts themselves. A student record has to exist in CollegeVine before a transcript can be processed, so the constituent sync always comes first.


How the data flows

  1. Constituent sync (bi-directional). You send student information (first name, last name, email, and a unique ID) as a CSV. CollegeVine creates a student record for each row.

  2. Asset sync (one-way). You send the transcripts, as PDFs in a zip file, with an index file that matches each PDF to a student by the same unique ID. The Transcript Reader reads each transcript, extracts the courses, and calculates the GPA.

  3. Results return. The results are posted to the student record in CollegeVine, and sent back to your system through the same SFTP connection as the constituent sync.


Before you start

  • Choose your unique identifier. This is the ID that ties a transcript to a student, for example an Application ID, CRM ID, or Student ID. The same ID must appear in both syncs.

  • Confirm what properties you want written back. Ensure these properties exist on your system so you can ingest them once the Transcript Reader is live.


Step 1: Set up the constituent sync

The constituent sync exchanges student information between your systems and CollegeVine. Your CSV needs, at a minimum, each student's first name, last name, and email, plus your unique ID if it is not the email.

For the setup steps, see Constituent sync or CRM specific guides.


Step 2: Set up the asset sync

The asset sync sends the transcript files and maps each one to a student. You send a zip file that contains the PDFs and an index file named index.csv. The index file needs three columns:

  • Reference unique ID. The same unique ID used in the constituent sync.

  • Asset type. The kind of document, such as transcript.

  • File name. The exact name of the PDF.

A student can have more than one file, but each file needs its own row. The asset sync only succeeds for students who already exist from the constituent sync.

For the setup steps and an index file template, see Asset sync or CRM specific guides.


Step 3: Receive the results

Results are written to each student's record, and you choose which fields come back. See How will I receive the outputs from the Transcript Reader?

If you use Slate and want one row per course, you can also set up a separate course-level connection. See Exporting course-level data [Slate API]. For non-slate partners, reach out to your CollegeVine team to confirm other options available.


Test with a sample batch

Once both syncs are active, send a representative sample of transcripts from a prior cycle. CollegeVine processes the batch and returns the results so you can confirm that:

  • Files are syncing correctly.

  • Students and transcripts are matched properly.

  • The extracted data is accurate.

  • The calculations match your requirements.

  • The output format works for your downstream processes.

Note: you do not need to ingest the test data into your production environment. You can review results in a csv, ingest into a test environment, or create new CollegeVine-only properties that do not replace legacy data in your system.

Did this answer your question?