EnrolHQ to Veracross Integration

Integration Overview

The EnrolHQ integration is built on the Veracross Admission API.

The integration:

  • Creates Applicant and Application records
  • Manages Household structures and establish Parent/Guardian relationships (Relatives)
  • Handles complex families
  • Writes custom fields via Person Profile Codes (for ACARA data, Indigenous status, Sports Houses, and similar)
  • Uploads student photos via the Files API
  • Attaches supporting documents (school reports, birth certificates, and similar) via the Files API

How to set up

EnrolHQ is in the process of gaining "Partner" status with Veracross. Until then, schools set EnrolHQ up as a new Partner manually.

API calls require:

  1. client_id
  2. client_secret
  3. Auth URL: https://accounts.veracross.com/<school_identifier>/oauth/token
  4. Endpoint URL: https://api.veracross.com/<school_identifier>/v3

The API user needs the scopes below. Core scopes are always required. The remaining groups apply only when the matching sync option is enabled in the Integration settings. Omit a group and that feature is simply skipped.

Core (always required)

Admission — applicants, applications and checklists:

  • admission.applicants :list, :read, :create, :update
  • admission.applications :list, :read, :create, :update
  • admission.applications.checklists :list, :read

Admission — households and relatives:

  • admission.households :list, :read, :update
  • admission.households.members :list
  • admission.relatives :list, :read, :create, :update
  • admission.relatives.relationships :list, :read, :create, :update
  • admission.applicants.relationships :list, :read, :create, :update

Admission — citizenships and languages:

  • admission.citizenships :list, :read, :create, :update
  • admission.languages :list, :read, :create, :update

Person roles and photos:

  • person_roles :list, :read, :create
  • files:person_photo :create, :read

Custom fields (only if sync lookups / profile codes is enabled)

  • person_profile_codes :list, :read, :create, :delete

Emergency contacts (only if sync emergency contacts is enabled)

  • emergency_contacts :create, :update

Application documents (only if sync applicant documents is enabled)

  • files:applicant_file :create, :read

Mappings

The integration maps standardised EnrolHQ values onto the equivalent codes in Veracross. Mappings are configured during setup:

  • Country codes: country names to Veracross's country IDs
  • Grade levels: EnrolHQ year levels to Veracross's grades
  • Application statuses: EnrolHQ statuses to Veracross's application workflow stages
  • Enrolment statuses: EnrolHQ enrolment states to Veracross's values
  • Campus codes: EnrolHQ campuses to Veracross's campus IDs
  • Titles/salutations: Mr, Mrs, Dr, etc.
  • Ethnicity values
  • Languages: EnrolHQ languages to Veracross's language records

Some values, such as gender and parent/guardian relationship types, use a fixed built-in mapping. There is nothing to configure for them during setup.

Syncing from EnrolHQ

The school registrar works from the Orientation (or Accepted) list, where offers are accepted. Pressing Sync to Veracross runs the following steps:

  1. Household: resolve or create the household the student belongs to
  2. Student profile: search by name and date of birth; Create the applicant if not found, otherwise update details, and assign to the household
  3. Application processing: check for an existing application for the year; create or update the record, map the status, set campus and grade level, and update key dates. The applicant's "Applicant" role is created at this step, and only when the applicant is eligible
  4. Citizenship and languages: sync the student's citizenship and language records
  5. Photo: upload the student photo if one is available
  6. Parent/guardian sync: for each parent: search or create the relative, establish the relationship, set custody and contact preferences, and map custom fields
  7. Supporting data: sync custom Profile Codes and emergency contacts (each only if the corresponding option is enabled)
  8. Documents: upload supporting documents via the Files API, if the "Sync applicant documents" option is enabled

Custom Profile Codes appear inside Veracross in their designated section. Syncing profile codes requires additional setup, which may add extra costs.

Last reviewed: 8 July 2026