Connect Veracross to Addie

Who this is for: Veracross administrator (Steps 1–2) and an Addie counsellor with admin access (Steps 3–4) Time: 15–30 minutes You'll need: OAuth_App_Admin role in Veracross, an Addie counsellor account (admin-level), and your Veracross school route (e.g. /myschool)

What this does

Connects Veracross as a data source for Addie. Once connected, Addie automatically syncs student rosters, enrolments, courses, classes, grades, and staff records.

Before you begin

• Confirm your Veracross administrator has the OAuth_App_Admin security role.
• Confirm you have an Addie counsellor account with admin access. If your Veracross administrator does not have one, an existing Addie admin can invite them as a counsellor so they can complete Step 3 themselves.
• Have your Veracross school route ready (e.g. /myschool).

Add Addie as an integration partner in Veracross

Completed by your Veracross administrator.

1. Log in to Veracross (Axiom) and go to Identity & Access Management.
2. Click Add Integration Partner.
3. Find Addie in the partner list and click Start Integration.
4. On the integration record, click Add OAuth Application (green button, top right).

If Start Integration does not appear, the account is missing the OAuth_App_Admin role. Ask your Veracross system administrator to assign it, then refresh the page.

For full details, see Veracross's official guide: Adding Addie as an integration partner in Veracross.

Configure the required scopes

Inside the OAuth Application record, open the Scopes tab and enable each scope below. These define exactly which data Addie can read.

Students & Directory

Scope	Purpose
students:list	Retrieve a list of all students
students:read	Read individual student records
directory.student:list	Access the student directory

Academics

Scope	Purpose
academics.enrollments:list	List student enrolments
academics.enrollments:read	Read individual enrolment records
academics.classes:list	List class sections
academics.classes:read	Read class section details
academics.courses:list	List available courses
academics.courses:read	Read course details
academics.assignments.grades:read	Read assignment-level grades
academics.config.grading_periods:list	List grading period configuration
academics.config.grading_periods:read	Read grading period details
academics.qualitative_grades:read	Read qualitative (comment-based) grades
courses:read	Read course records

Report Card & Teacher Comments

Scope	Purpose
report_card.enrollments.qualitative_grades:read	Read qualitative grade details on report cards
report_card.enrollments.qualitative_grades:list	List qualitative grades on report cards
report_card.classes.teachers:list	List teachers assigned to report card classes
report_card.classes.teachers:read	Read teacher assignment details
report_card.students.gpas:read	Read student GPA records
report_card.enrollments:list	List report card enrolments
report_card.enrollments.numeric_grades:list	List numeric grades on report cards
report_card.enrollments.numeric_grades:read	Read numeric grade details
report_card.enrollments:read	Read individual report card enrolment records

Staff & Faculty

Scope	Purpose
staff_faculty:list	List staff and faculty members
staff_faculty:read	Read individual staff and faculty records

Enable only the scopes listed above — Addie requests the minimum permissions necessary. Do not enable write scopes unless instructed by Addie support.

Once scopes are saved, note down your Client ID, Client Secret, and School Route — you'll need these in Step 3.

Enter API credentials in Addie

Completed by an Addie counsellor with admin access (or the Veracross administrator, if invited as a counsellor).

1. Sign in to Addie as a counsellor.
2. Go to Settings in the navigation menu.
3. Select the Provision Accounts tab.
4. Click API Settings (left side of the page).
5. In the API Settings modal, fill in:

Field	Value
School Route	Your Veracross school route (e.g. /myschool) — enter only the path after https://api.veracross.com
Client ID	The Client ID from your Veracross OAuth Application record
Client Secret	The Client Secret from your Veracross OAuth Application record
Provider	Select VERACROSS
Status	Set to ACTIVE

6. Click Save Changes.

Provision student accounts

Once the API credentials are saved and validated, return to the Provision Accounts tab.

1. Click Provision Addie Accounts.
2. Addie syncs student records from Veracross. The account count appears in the button label once complete (e.g. Provision Addie Accounts (143)).

If the count stays at 0, check that all scopes in Step 2 are enabled and that the credentials in Step 3 match your Veracross OAuth Application exactly.

What happens next

• Addie keeps rosters, enrolments, courses, classes, grades, and staff records synced from Veracross.
• Counsellors can provision individual synced students into Addie accounts.

If something looks wrong

The Start Integration button does not appear in Veracross

• The account requires the OAuth_App_Admin security role. Contact your Veracross system administrator to assign it.

Addie returns an authentication error after saving credentials

• Verify the Client ID, Client Secret, and School Route are copied exactly from the Veracross OAuth Application record. School Route should not include https://api.veracross.com — enter only the path (e.g. /myschool).

Student accounts are not syncing

• Confirm all scopes in Step 2 are enabled in Veracross. A missing scope — particularly students:list or academics.enrollments:list — prevents records from appearing.

The Veracross administrator does not have an Addie account

• An existing Addie counsellor admin can invite them as a counsellor via the Counsellors settings tab. Once invited, they can complete Step 3 themselves.

Related tasks

• Provision an SIS student
• Sync SIS data for a student