API V3.0

Versioning

To use the V3.0 API, include the following query parameter with every request: version=3.0

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

bash

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

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

Response

200204401

txt

An array of one or more agencies subscribed to the vendor

[ 1, 2, 3 ]

An array of one or more agencies subscribed to the vendor

[ 1, 2, 3 ]

txt

No agencies are available to the vendor

No agencies are available to the vendor

txt

The provided credentials are invalid

The provided credentials are invalid

GET Agency Offices

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

Request

bash

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

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

Response

200401403

json

Returns an array of one or more Office objects

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

Returns an array of one or more Office objects

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

txt

The provided credentials are invalid

The provided credentials are invalid

txt

The requested agency is not available to the vendor

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

bash

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

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

URL Parameters

Name	Type	Optional	Description
AgencyId	Int	No

Query Parameters

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

Response

200401403

json

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

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

txt

The provided credentials are invalid

The provided credentials are invalid

txt

The requested agency is not available to the vendor

The requested agency is not available to the vendor

GET Client

Request

bash

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

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

Response

200404

json

A Client object

{
    "clientNumber": 1,
    ...
}

A Client object

{
    "clientNumber": 1,
    ...
}

txt

The client does not exist.

The client does not exist.

See Client Model Reference for detailed documentation of the client model.

GET Client List

Request

bash

curl -v -x POST https://integration.hawksoft.app/vendor/agency/[agencyId]/clients?version=3.0 -u [user]:[pwd] --basic -d "{ 'clientNumbers': [1, 2]}"

curl -v -x POST https://integration.hawksoft.app/vendor/agency/[agencyId]/clients?version=3.0 -u [user]:[pwd] --basic -d "{ 'clientNumbers': [1, 2]}"

Response

200

json

An array of Client objects

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

An array of Client objects

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

See Client Model Reference for detailed documentation of the client model.

POST Log Note

Request

Body

Name	Type	Optional
RefId	Guid	No
TS	DateTime	No
PolicyId	Guid	true
Channel	LogAction	No
Note	String	No
Task	Task	Yes

Task

Name	Type	Optional	Description
DueDate	DateTime	No
Title	String	No
Description	String	No
Category	String	Yes
AssignedToRole	Enum	No	"SpecifiedUser", "Producer", "CSR", "Agent1", "Agent2", or "Agent3"
AssignedToEmail	string	Yes	Required if AssignedToRole is "SpecifiedUser"

cURL Example

bash

curl -v -X POST https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId]/log?version=3.0 -u [user]:[pwd] --basic -d "{ 'refId': [guid], 'ts': '2024-01-08T23:11:28.146Z', 'policyIndex': 1, 'action': 1, 'description': 'Description', 'body': 'Log note' }"

curl -v -X POST https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId]/log?version=3.0 -u [user]:[pwd] --basic -d "{ 'refId': [guid], 'ts': '2024-01-08T23:11:28.146Z', 'policyIndex': 1, 'action': 1, 'description': 'Description', 'body': 'Log note' }"

Response

txt

The log was created successfully.

The log was created successfully.

txt

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

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

txt

Bad request. See response for details.

Bad request. See response for details.

txt

The provided credentials are invalid.

The provided credentials are invalid.

txt

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

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

POST Attachment

Request

Headers

Name	Type	Optional	Description
RefId	Guid	No
TS	DateTime	No
Desc	String	No	Base64 encoded string.
LogNote	String	No	Base64 encoded string.
FileName	String	No
FileExt	String	No
PolicyId	Guid	Yes
Channel	LogAction	No
TaskTitle	String	No	Base64 encoded string.
TaskDescription	String	No	Base64 encoded string.
TaskAssignedTo	AgentRole	No
TaskAssignedToEmail	string	No
TaskCategory	String	Yes	Base64 encoded string.
TaskDueDate	DateTime	No

cURL Example

bash

curl -v -X POST https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId]/attachment?version=3.0 -u [user]:[pwd] --basic -H "RefId: [guid]" -H "TS: [timestamp]" -H "Desc: [string]" -H "LogNote: [string]" -H "FileName: [string]" -H "FileExt: [string]" -H "PolicyId: [guid]" -H "Channel: [int]" -d [data]

curl -v -X POST https://integration.hawksoft.app/vendor/agency/[agencyId]/client/[clientId]/attachment?version=3.0 -u [user]:[pwd] --basic -H "RefId: [guid]" -H "TS: [timestamp]" -H "Desc: [string]" -H "LogNote: [string]" -H "FileName: [string]" -H "FileExt: [string]" -H "PolicyId: [guid]" -H "Channel: [int]" -d [data]

Response

txt

The attachment was created successfully.

The attachment was created successfully.

txt

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

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

txt

Bad request. See response for details.

Bad request. See response for details.

txt

The provided credentials are invalid.

The provided credentials are invalid.

txt

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

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

API V3.0 ​

Versioning ​

GET Agencies ​

Request ​

Response ​

GET Agency Offices ​

Request ​

Response ​

GET Changed Clients ​

Request ​

URL Parameters ​

Query Parameters ​

Response ​

GET Client ​

Request ​

Response ​

GET Client List ​

Request ​

Response ​

POST Log Note ​

Request ​

Body ​

Task ​

cURL Example ​

Response ​

POST Attachment ​

Request ​

Headers ​

cURL Example ​

Response ​

Log Actions ​

API V3.0

Versioning

GET Agencies

Request

Response

GET Agency Offices

Request

Response

GET Changed Clients

Request

URL Parameters

Query Parameters

Response

GET Client

Request

Response

GET Client List

Request

Response

POST Log Note

Request

Body

Task

cURL Example

Response

POST Attachment

Request

Headers

cURL Example

Response

Log Actions