V1 API Endpoints

GET Agencies

This endpoint returns the agency ID for all agencies that have subscribed to a vendor’s application / service. Once an agency subscribes to and agrees to share data with a third-party application through the HawkSoft License Management Portal, their agency ID will be returned.

Request

curl -v https://integration.hawksoft.app/vendor/agencies -u [user]:[pwd] --basic

Response

200

An array of one or more agencies subscribed to the vendor

[ 1, 2, 3 ]

204

No agencies are available to the vendor

401

The provided credentials are invalid

GET Agency Offices

This endpoint returns a list of offices defined for the agency ID.

Request

curl -v https://integration.hawksoft.app/vendor/agency/1/offices -u [user]:[pwd] --basic

Response

200

Returns an array of one or more Office objects

[
	{
		"OfficeId": 1,
		"OfficeDescription": "",
		"SubAgencyName": "",
		"PrimaryOffice" true,
		"AddressLine1": "",
		"AddressLine2": "",
		"City": "",
		"State": "",
		"Zipcode": ""
	}
]

401

The provided credentials are invalid

403

The requested agency is not available to the vendor

GET Changed Clients

Get a list of clients changed since a date. These Client IDs can be used when calling the Get Client or Get Client List endpoints.

Request

curl -v https://integration.hawksoft.app/vendor/agency/[agencyId]/clients?asOf=[timestamp]&deleted=[deleted] -u [user]:[pwd] --basic

URL Parameters

Name	Type	Optional	Description
AgencyId	Int	No

Query Parameters

Name	Type	Optional	Description
AsOf	DateTime	Yes
OfficeId	Int	Yes
Deleted	Boolean	Yes

Response

200

Returns an array of client IDs.
[ 1, 2, 3, 4 ]

401

The provided credentials are invalid

403

The requested agency is not available to the vendor

GET Client

Request

curl -v https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId] -u [user]:[pwd] --basic

Response

200

A Client object

{
    "id": 1,
    ...
}

404

The client does not exist.

POST List Clients

Request

A JSON array of up to 200 client IDs.

[ 1, 2, 3]

cURL Example

curl -v -x POST https://integration.hawksoft.app/vendor/agency/[agencyId]/clients -u [user]:[pwd] --basic -d "[ 1, 2, 3]"

Response

200

Returns a list of client objects

[
	{
		"id": 1,
		...
	},
	{
		"id": 2,
		...
	}
]

401

The provided credentials are invalid.

403

The requested agency is not available to the vendor

413

Too many client IDs were requested. Try again with fewer than 200 client IDs.

POST Log Note

Request

Body

Name	Type	Optional	Description
Action	LogAction	No
Body	String	No	Max length: 3000 characters.
Description	String	No	Max length: 140 characters.
PolicyIndex	Int	Yes
RefId	Guid	No
Suspense	Suspense	Yes
TS	DateTime	No

cURL Example

curl -v -x POST https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId] -u [user]:[pwd] --basic -d "{ 'refId': [guid], 'ts': 'Wed Sep 16 2026 18:35:07 GMT+0000 (Coordinated Universal Time)', 'policyIndex': 1, 'action': 1, 'description': 'Description', 'body': 'Log note' }"

Response

200

The log was created successfully.

202

The request was saved and the log will be created next time the agency is connected to the cloud.

400

Bad request. See response for details.

401

The provided credentials are invalid.

403

The requested agency is not available, or the integration does not have permission to access this endpoint.

POST Attachment

Attach a file to a client. Supported file types include: pdf, jpg/jpeg, mp3, png, eml, and msg. The maximum file size accepted is 5 Mb.

Request

Headers

Name	Type	Optional	Description
Action	LogAction	No
Desc	String	No	Base64 encoded string. Description of the attachment file.
FileExt	String	No	Valid file types: png, pdf, txt, jpg, jpeg, mp3
FileName	String	No	Base64 encoded string. The name of the file, excluding the file extension.
LogBody	String	No	Base64 encoded string.
LogDescription	String	No	Base64 encoded string.
PolicyIndex	Int	Yes
RefId	Guid	No
SuspendedFor	AgentRole	No
SuspendedForInitials	String	No
SuspenseCategory	String	No	Base64 encoded string.
SuspenseDueDate	DateTime	No
TS	DateTime	No

Body

The body should contain the attachment file compressed using gzip. Other compression formats are not supported.

Response

200

The attachment was created successfully.

202

The request was saved and the attachment will be created next time the agency is connected to the cloud.

400

Bad request. See response for details.

401

The provided credentials are invalid.

403

The requested agency is not available, or the integration does not have permission to access this endpoint.

Log Actions

Value	Description
1	Phone To Insured
2	Phone To Carrier
3	Phone To Agency Staff
4	Phone To 3rd Party
5	Phone From Insured
6	Phone From Carrier
7	Phone From Agency Staff
8	Phone From 3rd Party
9	Mail To Insured
10	Mail To Carrier
11	Mail To Agency Staff
12	Mail To 3rd Party
13	Mail From Insured
14	Mail From Carrier
15	Mail From Agency Staff
16	Mail From 3rd Party
17	Walk In To Insured
18	Walk In To Carrier
19	Walk In To Agency Staff
20	Walk In To 3rd Party
21	Walk In From Insured
22	Walk In From Carrier
23	Walk In From Agency Staff
24	Walk In From 3rd Party
25	Online To Insured
26	Online To Carrier
27	Online To Agency Staff
28	Online To 3rd Party
29	Online From Insured
30	Online From Carrier
31	Online From Agency Staff
32	Online From 3rd Party
33	Email To Insured
34	Email To Carrier
35	Email To Agency Staff
36	Email To 3rd Party
37	Email From Insured
38	Email From Carrier
39	Email From Agency Staff
40	Email From 3rd Party
41	Text To Insured
42	Text To Carrier
43	Text To Agency Staff
44	Text To 3rd Party
45	Text From Insured
46	Text From Carrier
47	Text From Agency Staff
48	Text From 3rd Party
49	Chat To Insured
50	Chat To Carrier
51	Chat To Agency Staff
52	Chat To 3rd Party
53	Chat From Insured
54	Chat From Carrier
55	Chat From Agency Staff
56	Chat From 3rd Party

JSON

{
  "1": "Phone To Insured",
  "2": "Phone To Carrier",
  "3": "Phone To Agency Staff",
  "4": "Phone To 3rd Party",
  "5": "Phone From Insured",
  "6": "Phone From Carrier",
  "7": "Phone From Agency Staff",
  "8": "Phone From 3rd Party",
  "9": "Mail To Insured",
  "10": "Mail To Carrier",
  "11": "Mail To Agency Staff",
  "12": "Mail To 3rd Party",
  "13": "Mail From Insured",
  "14": "Mail From Carrier",
  "15": "Mail From Agency Staff",
  "16": "Mail From 3rd Party",
  "17": "Walk In To Insured",
  "18": "Walk In To Carrier",
  "19": "Walk In To Agency Staff",
  "20": "Walk In To 3rd Party",
  "21": "Walk In From Insured",
  "22": "Walk In From Carrier",
  "23": "Walk In From Agency Staff",
  "24": "Walk In From 3rd Party",
  "25": "Online To Insured",
  "26": "Online To Carrier",
  "27": "Online To Agency Staff",
  "28": "Online To 3rd Party",
  "29": "Online From Insured",
  "30": "Online From Carrier",
  "31": "Online From Agency Staff",
  "32": "Online From 3rd Party",
  "33": "Email To Insured",
  "34": "Email To Carrier",
  "35": "Email To Agency Staff",
  "36": "Email To 3rd Party",
  "37": "Email From Insured",
  "38": "Email From Carrier",
  "39": "Email From Agency Staff",
  "40": "Email From 3rd Party",
  "41": "Text To Insured",
  "42": "Text To Carrier",
  "43": "Text To Agency Staff",
  "44": "Text To 3rd Party",
  "45": "Text From Insured",
  "46": "Text From Carrier",
  "47": "Text From Agency Staff",
  "48": "Text From 3rd Party",
  "49": "Chat To Insured",
  "50": "Chat To Carrier",
  "51": "Chat To Agency Staff",
  "52": "Chat To 3rd Party",
  "53": "Chat From Insured",
  "54": "Chat From Carrier",
  "55": "Chat From Agency Staff",
  "56": "Chat From 3rd Party"
}

Suspense

Name	Type	Optional	Description
Category	String	Yes
DueDate	DateTime	No
SuspendedFor	AgentRole	No
SuspendedForInitials	String	Yes