ARTICLE: Veracross' V3 API

ARTICLE: Veracross V3 API

Veracross V3 API (North America) 


V3 API Setup Instructions:

Veracross' V3 API for Schools provides access to school information such as users, academics, admissions, athletics, content, general school info, and lists. 

Before you begin to make the connection with Veracross and Reach, please review the Veracross API Overview article first. https://community.veracross.com/s/article/Veracross-API-Overview

Alert
Make sure that the Veracross account that is used to make the connection through Veracross is completed by a user with the OAuth_App_Admin security role (this feature isn't automatically enabled for SysAdmins).

Follow Veracross' setup instructions to connect to Reach via V3 API once you confirm the prerequisite are met:

Here are the steps to connect the V3 API sync to your Reach portal:

  2. Click the "Start Integration" link. This action generates an OAuth Application record that automatically connects your school to the Reach Student Life Management.
  3. After the OAuth Application record is created, we recommend you set the OAuth Application scopes.  The following scopes are required to connect with Reach:
    1. students:list (required)
    2. students:read (required)
    3. households:list (required)
    4. parents:list (required)
    5. boarding.dorms:list (required)
    6. boarding.dorms.students:list (required)
    7. staff_faculty:list (required)
    1. relationships:list (optional)
    2. contact_info:list (optional)
    1. athletics.rosters:list (not required for standard sync - required for group sync integrations)
    2. athletics.sports:list (not required for standard sync - required for group sync integrations and attendance write-back integrations)
    1. student_logistics_requests:list (not required for standard sync - required for attendance write-back integrations)
    2. student_logistics_requests:create (not required for standard sync - required for attendance write-back integrations)
  1. Once the steps are correctly followed, the connection is complete.  Please email support@reach.cloud to verify that you have completed the connection with Veracross' V3 to allow for confirmation of a successful connection.



Related Articles:
ARTICLE: Veracross Athletic Groups Sync in Reach
ARTICLE: Veracross Attendance Sync for Approved Leaves in Reach