Skip to main content

API Scopes

As part of our platform's structured evolution, we have categorized our application programming interfaces (APIs) into three distinct classifications. Our initial framework was anchored by the Legacy API - a comprehensive set serving both user and administrative roles. Recognizing the need for specialized and distinct service offerings, we introduced the User and Admin APIs. The User API is crafted to encompass all functions necessary for basic users to successfully capture themselves. Conversely, the Admin API incorporates functionalities from the User and Adjudicator APIs and additionally integrates features specifically designed for comprehensive service administration. The following table offers a clear overview of these API classifications and their respective roles:

APIScopeDescription
UserUserEncompasses all functions necessary for basic users to interact with the system.
AdjudicatorAdjudicatorEncompasses all functions necessary for the adjudication workflow
AdminUser + Adjudicator + AdminCombines all User and Adjudicator API endpoints, plus additional endpoints for service administration.
LegacyUser + Adjudicator + AdminIncludes all endpoints. Deprecated in 13.3, removal scheduled for 2026.1.