Data Scopes

Multiple data scopes are available depending on the needs of a given integration. Reading client data is available for all integrations. Other scopes are enabled on request, and some require additional verification before use is enabled in production. Once a scope is enabled for an integration, each agency must also opt into it when subscribing.

An agency may subscribe to your integration, but not opt into all of your available scopes. You can check which scopes have been enabled by each agency using the GET Agencies endpoint.

Definitions

Scope ID is the value that will be returned by the GET Agencies endpoint. Scope Name is the display value that agencies will see when enabling integrations in the HawkSoft Marketplace. Use the Name if communicating with an agency regarding data scopes.

Name	ID	Description
Read Client/Policy Data	client-read	Always enabled. Agencies cannot opt out of this scope.
Create Logs, Attachments, and Tasks	create-log-attachment-task	Enables creation of log notes, file attachments, and tasks on clients.
Read and Write Accounting Data	accounting-read-write	Enables reading client invoices and creating client payments.
Create Clients and Policies	client-create	Enables creation of prospect clients with limited policy details.