{
"openapi": "3.0.1",
"info": {
"title": "Digital WC API",
"description": "Digital WC API allows users to create, edit, and bind Worker’s Compensation (WC) quotes",
"version": "1.0"
},
"servers": [
{
"url": "https://gateway.amtrustgroup.com/DigitalAPI"
},
{
"url": "https://prod-apim-gw.amtrustservices.com/DigitalAPI"
}
],
"paths": {
"/api/v1/affirmation": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the affirmation statement that will need to be displayed to agents prior to binding the quote to a policy.\nThis can be called in conjunction with the V2 Bind endpoint; the actual submission of affirmation will occur in the V2 Quote Bind endpoint.\nIf you are already presenting a statement o",
"description": "Retrieves the affirmation statement that will need to be displayed to agents prior to binding the quote to a policy
\r\n This can be called in conjunction with the V2 Bind endpoint; the actual submission of affirmation will occur in the V2 Quote Bind endpoint.
\r\n __Please note:__ If you are already presenting a statement of affirmation to your agents/users, you do not need to use this endpoint. This is only for partners who do not currently have their own statement in place",
"operationId": "get-api-v1-affirmation",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6e419f211597",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "190e392ff359",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
}
}
}
},
"/api/v1/quotes/agent-contacts": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Returns all agent contact IDs, names, and emails linked to the agent associated with the current authentication token.",
"description": "Returns all agent contact IDs, names, and emails linked to the agent associated with the current authentication token.",
"operationId": "get-api-v1-quotes-agent-contacts",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "53efa729d74a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2a86ddec2859",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentContact"
}
},
"example": [
{
"Id": "string",
"FullName": "string",
"Email": "string",
"AgentId": 0
}
]
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/agent-contact": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the agent contact information for the quote specified by the URI parameter quoteId.",
"description": "Retrieves the agent contact information for the quote specified by the URI parameter __quoteId__",
"operationId": "get-api-v1-quotes-quoteid-agent-contact",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f3f1a6a0873a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "83a06f673974",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentContactBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Id": "string",
"FullName": "string",
"Email": "string",
"AgentId": 0
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "50e3ea70fcb3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/billType": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the bill type available for the agency associated with the current authentication token.",
"description": "Retrieves the bill type available for the agency associated with the current authentication token.",
"operationId": "get-api-v1-quotes-billtype",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "319f9dbcd8c1",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "ac87fd9dea4c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillTypeResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"BillTypes": [
"string"
],
"EndQuotingNewBusinessDate": "string"
}
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/classCodes": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all class codes currently saved on the specified quote.",
"description": "Retrieves all class codes currently saved on the specified quote.",
"operationId": "get-api-v1-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c709310264cd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "151c577c8640",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseClassCodeModelListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"OriginalClassCode": "string",
"OriginalDesc": "string",
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0,
"IsDeleted": true,
"ClassRate": 0,
"Description": "string",
"Premium": 0,
"Exposure": 0,
"IsSplitRate": true
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "73fe2cc7acad",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/available-class-codes": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of all class codes that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves a list of all class codes that can be added to the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-quotes-quoteid-available-class-codes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2a1e02af8086",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "6bdae2e75e80",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateClassCodesResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"ClassDescription": "string"
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b75911bae582",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/state-classes-eligibility/{state}/{classCode}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves eligibility status of a specified class code in the given state.\nEffective date may be passed in URL to see if a class code will be eligible after a specific date.",
"description": "Retrieves eligibility status of a specified class code in the state specified by the URI parameter __state.__
\r\n Effective date may be passed in URL, if wanting to see if a class code will be eligible after a specific date. If no effective date is passed, eligibility reflected is based on current date.",
"operationId": "get-api-v1-state-classes-eligibility-state-classcode",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "classCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "21debef20a5e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "20341d4edddb",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodeEligibilityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"ClassDescription": "string",
"Eligibility": "string",
"EffectiveDate": "string",
"ExpirationDate": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "913e30a8eda2",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/state-classes-eligibility/classCodes/{state}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of all class codes in a state along with all description and eligibility information.\nEffective date may be passed in URL to see if a class code will be eligible after a specific date.",
"description": "Retrieves a list of all class codes in a state along with all description and eligibility information.
\r\n Effective day may be passed in URL, if wanting to see if a class code will be eligible after a specific date. If no effective date is passed, eligibility reflected is based on current date.",
"operationId": "get-api-v1-state-classes-eligibility-classcodes-state",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e9dcbf4ff967",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "bd67ffc833e2",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodeEligibilityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"ClassDescription": "string",
"Eligibility": "string",
"EffectiveDate": "string",
"ExpirationDate": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "ce2d650792c4",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/state-classes-eligibility/{state}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of all class codes in a state. This list will not include eligibility or description information.\nList will be comprised of eligible, referred, and declined class codes.",
"description": "Retrieves a list of all class codes in a state.
\r\n This list will not include any eligibility or class code description information. List will be comprised of eligible, referred, and declined class codes.",
"operationId": "get-api-v1-state-classes-eligibility-state",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c7bee66ef0aa",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "009c06544330",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
"string"
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "65daa93defb9",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/classCodes/{indexId}": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Removes a specified class code from a specified quote.",
"description": "Removes a specified class code from a specified quote",
"operationId": "delete-api-v1-quotes-quoteid-classcodes-indexid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "indexId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "effd67d39c95",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "0f071a46ceed",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "2eccf371caa8",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/classcodes/{classCodeId}/information": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves class code information based on the NAICS or SIC code sent.\nThe state parameter is optional; if no state is specified, the return will display class code information for each applicable state.\nNAICS code can be up to 6 numeric characters. SIC code can be up to 4 numeric characters.",
"description": "Retrieves class code information based on the NAICS or SIC code sent
\r\n The state parameter is optional; if no state is specified, then the return will display class code information for each applicable state. If the state is included, then the response will include only the class code information for that specific state.
\r\n Character limits:
\r\n • NAICS code can be up to 6 numeric characters
\r\n • SIC code can be up to 4 numeric characters",
"operationId": "get-api-v1-classcodes-classcodeid-information",
"parameters": [
{
"name": "classCodeId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "classCodeType",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3cf063eeb899",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3cf063eeb899",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3cf063eeb899",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "89ad06a4df0e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "89ad06a4df0e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "89ad06a4df0e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ClassInformationResponseIEnumerableBaseResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassInformationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassCodeDescriptionCode": "string",
"ClassCodeDescription": "string",
"ExpirationDate": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassInformationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassCodeDescriptionCode": "string",
"ClassCodeDescription": "string",
"ExpirationDate": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "213c64fe9c1b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "213c64fe9c1b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "213c64fe9c1b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/classcodes/information/states": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all AmTrust class code information, including eligibility, description codes, descriptions, and NAICS and SIC codes.\nIf no state is passed, response comes back as a byte representation of a JSON. If state is passed, response comes back as a JSON object.",
"description": "Retrieves all AmTrust class code information, including eligibility, description codes, descriptions, and NAICS and SIC codes.
\r\n The state parameter is not required; if not passed, response will come back as a byte representation of a JSON, that can then be manipulated into any format user prefers.
\r\n If state is passed, the response will come back as a JSON object.
\r\n This endpoint is most helpful as a NAICS or SIC mapping tool. However, it can also be used to understand all class codes available within AmTrust’s WC quoting system.
",
"operationId": "get-api-v1-classcodes-information-states",
"parameters": [
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "663400e43511",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "663400e43511",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "663400e43511",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5063a1f40c0c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5063a1f40c0c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5063a1f40c0c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetSicNaicsResponseIEnumerableBaseResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSicNaicsResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"Eligibility": "string",
"Information": [
{
"DescriptionCode": "string",
"NaicsDescription": "string",
"NaicsCode": "string",
"SicCode": "string"
}
],
"AllStatesInformation": "string",
"ExpirationDate": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetSicNaicsResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"Eligibility": "string",
"Information": [
{
"DescriptionCode": "string",
"NaicsDescription": "string",
"NaicsCode": "string",
"SicCode": "string"
}
],
"AllStatesInformation": "string",
"ExpirationDate": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/classcodes/states/{state}/natural-language": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Allows user to search for a class code using natural language parameters.\nThe response will include the top matching class codes matching the description in the state requested.",
"description": "Allows user to search for a class code using natural language parameters in the path and query string.
\r\n The response will include the top matching class codes, matching the description, in the state requested, based on the number of results the user selects.",
"operationId": "get-api-v1-classcodes-states-state-natural-language",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "resultNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "productType",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "704ee08facb7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "704ee08facb7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "704ee08facb7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4d373fea4e4f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4d373fea4e4f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4d373fea4e4f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NaturalLanguageResponseIEnumerableBaseResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NaturalLanguageResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ProductLine": "string",
"SearchResults": [
{
"ClassCode": "string",
"ClassDecription": "string",
"ClassDecriptionCode": "string",
"MatchProbability": 0
}
]
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NaturalLanguageResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ProductLine": "string",
"SearchResults": [
{
"ClassCode": "string",
"ClassDecription": "string",
"ClassDecriptionCode": "string",
"MatchProbability": 0
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "429230eeb145",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "429230eeb145",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "429230eeb145",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/voluntary-compensation": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves a voluntary compensation endorsement to the quote specified by the quote ID passed.",
"description": "Saves a voluntary compensation endorsement to the quote specified by the quote ID passed.",
"operationId": "post-api-v1-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2038ee640381",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "3075e1bea6a9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "3eff5fb901f2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "3aa90bea3573",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves available voluntary compensation coverage information for the quote ID passed.",
"description": "Retrieves available voluntary compensation coverage information for the quote ID passed.",
"operationId": "get-api-v1-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ac0591133c38",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "6ecdad688960",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"EndorsementNumber": "string",
"Description": "string",
"FormDataFields": [
{
"IndexId": 0,
"Label": "string",
"Required": true,
"CanEnterFreeText": true,
"CurrentValue": "string",
"PresetValues": [
"string"
]
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "cfe58e6be62a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Removes the voluntary compensation coverage endorsement from the quote ID specified.\nIf no ID is sent, all endorsements on the quote will be removed. If ID is sent, only that ID will be removed.",
"description": "This endpoint removes the voluntary compensation coverage endorsement from the quote ID specified; Endorsement ID is optional.
\r\n If no ID is sent in request, then all endorsements that exist on the quote will be removed. If ID is sent, only that ID will be removed, and all others will remain.",
"operationId": "delete-api-v1-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "endorsementNumber",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "fe9f822eda04",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a3f3aa47e495",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "78c62b07b839",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/crossSellquotes/{quoteId}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the BOP quote number and premium information initiated by the Create Cross Sell Quote.\nThis endpoint is only accessible by appointed Cross Sell agencies.",
"description": "Retrieves the BOP quote number and premium information initiated by the Create Cross Sell Quote.
\r\n __Please note:__ This endpoint is only accessible by appointed Cross Sell agencies.",
"operationId": "get-api-v1-crosssellquotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6fabbd6c8746",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "124c76e6a4de",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CrossSellGetReturnModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"DeepLink": "string",
"BopQuoteNumber": 0,
"AnnualPremium": 0,
"GeneralLiabilityLimits": "string",
"MedicalPayments": 0,
"DamagestoPremisesLiabilityLimit": 0,
"BusinessPersonalProperty": 0,
"PropertyDeductible": "string",
"ExpansionEndorsement": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "0cbb7c65a9ff",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/documents": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Allows user to upload any supporting documentation that the Underwriter may need when reviewing the quote.",
"description": "Allows user to upload any supporting documentation that the Underwriter may need when reviewing the quote.",
"operationId": "post-api-v1-quotes-quoteid-documents",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "0061057ea18b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "6a1273e8ad17",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"LibraryId": 0
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "b430ca1e7a91",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "1082e3ce8633",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/eligibility": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the current eligibility and status of the quote specified by quoteId.\nQuote statuses include: Not Submitted, Submitted, Approved, UnderwriterDeclined, AdditionalInformationNeeded, and ApprovalSubjectTo.\nEligibility is broken down by Class Code, Questions, Territory, and Modifiers, each ret",
"description": "Retrieves the current eligibility and status of the quote specified by quoteId.
\r\n __Quote Statuses that will return are below:__
\r\n __•__ __Not Submitted__ – means quote has not been submitted to the underwriter; default status on quote creation and journey
\r\n __•__ __Submitted__ – means the quote is submitted to an underwriter, and awaiting review
\r\n __•__ __Approved__ – means the underwriter has approved this risk and quote can now be bound via the (POST) Bind Quote endpoint; the quote is now blocked for editing
\r\n __•__ __UnderwriterDeclined__ – means the underwriter has declined this risk, and quote cannot be bound; the quote is now blocked for editing
\r\n __•__ __AdditionalInformationNeeded__ – means the underwriter needs additional information before approving/declining risk. Underwriter will send an email to the agent listed as the contact on the quote
\r\n __•__ __ApprovalSubjectTo__ – means the underwriter has approved the quote submit to outlined changes being made prior to binding; those changes will be outlined in an email to the agent contact on the quote
\r\n Eligibility is broken down into the parameters below:
\r\n __•__ __Class Code: Bind Eligible, Refer, Declined__
\r\n __•__ __Questions: Bind Eligible, Refer, Declined__ (will default to Refer on initial quote creation, as questions have not been answered yet)
\r\n __•__ __Territory: Bind Eligible, Refer, Declined__
\r\n __•__ __Modifiers: Bind Eligible, Refer, Declined__
\r\n __Please note:__ There may be other factors, not included in the breakdown, that impact the overall eligibility on a quote",
"operationId": "get-api-v1-quotes-quoteid-eligibility",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d132dbc77f3c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a4430588bd5a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEligibilityResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
],
"QuoteStatus": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "07342dcda418",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/legalEntities/available": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves legal entities available for the quote specified by quote ID.",
"description": "Retrieves legal entities available for the quote specified by quote ID.",
"operationId": "get-api-v1-quotes-quoteid-legalentities-available",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b22bc9d2fa88",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "62fe3a1d5213",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"LegalEntityId": 0,
"EntityDescription": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "77975776fe29",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/payment-plans/payroll-companies": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all payroll companies currently available to the agency associated with the current authentication token.",
"description": "Retrieves all payroll companies currently available to the agency associated with the current authentication token.",
"operationId": "get-api-v1-payment-plans-payroll-companies",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e6d340bc1131",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "fe6c964eea01",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentPayrollCompaniesResponseIListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PayrollCompanyId": 0,
"PayrollCompanyName": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/contacts/agents": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves agent information associated with an email address passed in the query string.\nThis endpoint is only available to agencies granted permission.",
"description": "Retrieves agent information associated with an email address passed in the query string.
\r\n __Note:__ This endpoint is only available to agencies granted permission.",
"operationId": "get-api-v1-contacts-agents",
"parameters": [
{
"name": "emailAddress",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2d9b9735585e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "7bb2734f78ac",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentInfoReturnModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"AgentId": 0,
"AgentName": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/available-liability-limits": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the available liability limit options for the quote specified by the quote ID.",
"description": "Retrieves the available liability limit options for the quote specified by the quote ID.",
"operationId": "get-api-v1-quotes-quoteid-available-liability-limits",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "37a1e3296b25",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "bc40da61b3a1",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
"string"
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "6ab3b9ef849b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/modifiers": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all available modifiers on the quote specified by the URI parameter quoteId.",
"description": "Retrieves all available modifiers on the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-quotes-quoteid-modifiers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a0474fe299b4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "245fe7b32265",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateModifiersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "cea2f9f2bb40",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"patch": {
"tags": [
"Workers Comp"
],
"summary": "Updates the quote to include modifiers. Modifier IDs are case sensitive. Modifier values cannot be null.",
"description": "Updates the quote to include modifiers.
\r\n __•__ Modifier IDs are case sensitive. For example: “EmPct”, “ComContribPct”, etc…
\r\n __•__ Modifier values cannot be null.
",
"operationId": "patch-api-v1-quotes-quoteid-modifiers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "95f4e1d6cb17",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f01cfe3bf603",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifiersPatchResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4c131fe350b2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "406cf6dbefbe",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policy/{policyId}/netRate": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves net rate information on a PAYO or PSR policy.",
"description": "Retrieves net rate information on a PAYO or PSR policy.",
"operationId": "get-api-v1-policy-policyid-netrate",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "aad44d7a239f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b6ff607e7db8",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetRateResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassDescription": "string",
"NetRate": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b60ece6ab649",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quote/{quoteId}/netRate": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves net rate information on a PAYO or PSR quote.",
"description": "Retrieves net rate information on a PAYO or PSR quote.",
"operationId": "get-api-v1-quote-quoteid-netrate",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a097ab3af116",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "011cc9336a5e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetRateResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassDescription": "string",
"NetRate": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "e4c388769ddf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/additionalInformation/officers/{id}": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Deletes an officer record specified by ID from the quote specified by the URI parameter quoteId.",
"description": "Deletes an officer record specified by ID from the quote specified by the URI parameter __quoteId.__",
"operationId": "delete-api-v1-quotes-quoteid-additionalinformation-officers-id",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3027ca48f384",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4fb765b80309",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "ad1025803d65",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/officer-information": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all officer types and endorsement information that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves all officer types and endorsement information that can be added to the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-quotes-quoteid-officer-information",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a6614b153151",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1f74d6c7d06c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfficerInformationModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"OfficerType": "string",
"State": "string",
"LimitInformation": {
"ExcludedOfficerLimit": 0,
"ValidationMessage": "string"
},
"EndorsementInformation": {
"ValidationMessage": "string",
"Endorsements": [
{
"FormType": "string",
"FormSubType": "string",
"Id": "string",
"Description": "string",
"MinOwnershipPercentage": 0,
"MaxOwnershipPercentage": 0,
"OwnershipPctValidationMessage": "string",
"MinAnnualCompensation": 0,
"MaxAnnualCompensation": 0,
"AnnualCompensationValidationMessage": "string"
}
]
}
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5eed5fb24a47",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/available-officer-types": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all officer types that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves all officer types that can be added to the quote specified by the URI parameter __quoteId__",
"operationId": "get-api-v1-quotes-quoteid-available-officer-types",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3b83ca0c90c4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "464d1d14e2e3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
"string"
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "26b5584a73d9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/partners": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Removes saved California partner information from the quote.\nIf partnerId is not included, all partners are removed. If included, only that partner is removed.",
"description": "Removes saved California partner information from the quote.
\r\n The query string parameter __partnerId__ is optional:
\r\n __•__ If the parameter partner ID is not included in the URI, then all partners currently saved to the quote will be removed
\r\n __•__ If the parameter partner ID is included in the URI, then only the partner associated with that ID will be removed.",
"operationId": "delete-api-v1-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e90f91a00778",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2ee336c128eb",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": true
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "50731ddc1e7f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves California partner names to a quote. Required for certain legal entities in CA in order to bind.\nOne of the following fields is required: First Name and Last Name, OR Organization.",
"description": "This information is required, in order to bind, if the quote is in CA, and is one of the legal entities listed below:
\r\n __•__ General Partnership
\r\n __•__ Limited Liability Partnership
\r\n __•__ Limited Partnership
\r\n __•__ Tenants in Common
\r\n __Note 1:__ If the legal entity is __Tenants in Common__, no partners are required, but if one is added, a second is required.
\r\n __Note 2:__ One of the following fields is required: First Name and Last Name, OR Organization. Please include either First Name and Last Name, OR Organization in your request.",
"operationId": "post-api-v1-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3a793a452050",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1293d1d81806",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "441ac031d70a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"get": {
"tags": [
"Workers Comp"
],
"summary": "Returns the partner names and organization on the specified quote.\nIf partnerId is not included, all partners return. If included, only that partner returns.",
"description": "This endpoint will return the partner names and organization on the specified quote.
\r\n The URI parameter __partnerId__ is optional:
\r\n __•__ If __partnerId__ is not included in the URI, then all partners currently saved to the quote will return
\r\n __•__ If __partnerId__ is included in the URI, then only the partner associated with that ID will return",
"operationId": "get-api-v1-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "414287f22fb9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "51c038eabe6c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "55fc2b438267",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp"
],
"summary": "Updates the partner names or organizations on the specified quote.\nPartners not included in the request body will be removed if partnerId is not specified in the URI.",
"description": "This endpoint will update the partner names or organizations on the specified quote
\r\n The Partner ID is optional:
\r\n __•__ If __partnerId__ is not included in the URI, any partners that are desired to be kept on the quote will need to be passed in the body (including __partnerId__); if any are left off the request, the partner will be removed.
\r\n __•__ If __partnerId__ is included in the URI, you only need to include that partner ID, along with first and last name OR Organization, in the request body.
\r\n __Note:__ One of the following fields is required: First Name and Last Name, OR Organization. Please include either First Name and Last Name, OR Organization in your request.",
"operationId": "put-api-v1-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "275c113cd45f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "36083b090da0",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "629d84c6d079",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/partners/{partnerId}": {
"patch": {
"tags": [
"Workers Comp"
],
"summary": "Updates the partner name or organization for a specific partner ID on the specified quote.",
"description": "This endpoint will update the partner name or organization on the specified quote, associated with the specific partner ID passed.
\r\n __Note 1:__ To update name: Only the field being updated is required (first OR last name), but both can be sent.
\r\n __Note 2:__ To update organization: It is required to set only organization. Do not include both organization and partner name in the request.",
"operationId": "patch-api-v1-quotes-quoteid-partners-partnerid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "43557b0d294e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5b3af7cdbe6b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "759ca3abc113",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policyId}/payment": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Makes a payment on the policy. Payment sent must equal the current amount due.\nThe Balance Summary endpoint can be used to retrieve the current balance on the policy.\nPayment may take up to 24 hours to reflect on the account.",
"description": "This endpoint is used to make a payment on the policy.
\r\n The Balance Summary endpoint can be used to retrieve the current balance on the policy.
\r\n Payment sent must be equal to the current amount due.
\r\n __Please note:__ Payment may take up to 24 hours to reflect on the account",
"operationId": "post-api-v1-policies-policyid-payment",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6d17f9fcfd3d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "29be2b895e3e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"AmountProccessed": 0,
"RemainingPolicyPayment": 0,
"TransactionId": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4f47fbbc30ed",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "11a7130ce7e6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policyId}/balance-summary": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the current balance on a policy.\nIf CanMakePayment is false, the current balance will reflect $0.00.",
"description": "Retrieve the current balance on a policy.
\r\n __If \"CanMakePayment\" is false, the current balance will reflect $0.00 Policy.__",
"operationId": "get-api-v1-policies-policyid-balance-summary",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "0fb60f59e2e6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "82ba50dee5ef",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceSummaryResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"QuoteId": 0,
"PolicyId": 0,
"CurrentDueAmount": 0,
"RemainingDueAmount": 0,
"CanMakePayment": true
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "24c15d651af1",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/documents": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a specified policy document type in raw data (application-octet stream).\nAvailable file types can be retrieved via the List of All Available Policy Documents endpoint.",
"description": "Retrieves a specified policy's document type, displaying in raw data (application-octet stream). The headers will also contain a FileName and a DisplayName.
\r\n Available file types can be retrieved via the List of All Available Policy Documents endpoint.",
"operationId": "get-api-v1-policies-policy-documents",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "429172d0b9a4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "429172d0b9a4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c0cc3a30ebaf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c0cc3a30ebaf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
},
"example": "string"
}
}
},
"404": {
"description": "Not found",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "eef400292e76",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "eef400292e76",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/available-documents": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of all available policy documents currently available for viewing under the given policy number.",
"description": "Retrieves a list of all available policy documents that are currently available for viewing under the given policy number.",
"operationId": "get-api-v1-policies-policy-available-documents",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f2f69433d416",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9d9fe7a4283b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDocumentIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"DocumentName": "string",
"FileType": "string",
"DocumentType": "string",
"LibraryIndex": 0,
"DateReceived": "string",
"EndmtNum": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "0125cefc032a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/documents/{fileType}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a specified policy document type by file type in raw data (application-octet stream).\nAvailable file types can be retrieved via the List of All Available Policy Documents endpoint.",
"description": "Retrieves a specified policy's document type, displaying in raw data (application-octet stream). The headers will also contain a FileName and a DisplayName.
\r\n Available file types can be retrieved via the List of All Available Policy Documents endpoint:
\r\n (GET /api/v1/policies/{policy}/available-documents)",
"operationId": "get-api-v1-policies-policy-documents-filetype",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "libraryIndex",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3efab1a3358c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "421861d70812",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "2823bc65774f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/renewal": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the renewal policy number and information, if available, based on the expired policy number given.",
"description": "Retrieves the renewal policy number and information, if available, based on the expired policy number given.",
"operationId": "get-api-v1-policies-policy-renewal",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e91053b40a8f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a1c7712868c6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyRenewalResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"RenewalPolicyNumber": "string",
"TotalEstimatedAnnualPremium": 0,
"TotalStateAssessment": 0,
"ClassCodes": [
{
"State": "string",
"ClassCode": "string",
"ClassCodeDescription": "string",
"ExposureLimit": "string",
"Rate": 0
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b3452b6edefe",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Returns basic policy information on the requested policy number.",
"description": "Returns basic policy information on requested policy number.",
"operationId": "get-api-v1-policies-policy",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "573c23c2e257",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "7b1a993bfebb",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInformationResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"MasterAccountId": 0,
"Policy": "string",
"PolicyId": 0,
"Quote": "string",
"Premium": "string",
"DBA": "string",
"BusinessName": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"Fein": "string",
"EffectiveDate": "string",
"ExpirationDate": "string",
"InsuredContact": {
"Name": "string",
"Phone": "string",
"Email": "string"
},
"LegalEntity": "string",
"PolicyStatus": "string",
"StateTaxes": 0,
"EstimatedAnnual": 0,
"EarnedPremium": "string",
"RatingZip": "string",
"CancelInformation": {
"CancelDate": "string",
"CancelReason": "string",
"ShortRate": true
},
"CompanyWebsite": "string",
"CarrierName": "string",
"ClassCodes": [
{
"ClassCode": "string",
"DescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FTEmployees": 0,
"PTEmployees": 0,
"Rate": 0,
"Premium": 0
}
],
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"OfficerDOB": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"StopGapCoverages": [
{
"CoverageName": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"Partners": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
],
"Limits": [
{
"LiabilityLimits": {
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
}
}
],
"AdditionalInsureds": [
{
"Id": 0,
"NamedInsuredId": 0,
"Name": "string",
"Dba": "string",
"Fein": "string",
"LegalEntity": 0,
"UnemploymentNumber": "string",
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0
}
],
"PrimaryInsuredAdditionalLocations": [
{
"LocationNumber": 0,
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0
}
],
"AdditionalLocations": [
{
"LocationNumber": 0,
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0,
"NameInsured": "string"
}
],
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"SpecificWaivers": [
{
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
],
"NonRenewalDate": "string",
"NonRenewalReason": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "1f6b882c0a0c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Returns basic policy information based on one search parameter: Master Account ID, FEIN, Policy ID, or Quote Number.\nOnly the first 10 results will return.",
"description": "Returns basic policy information on requested policy number.
\r\n Retrieves policy number based on parameter used to search
\r\n User can search for a policy number using one of the following parameters:
\r\n • Master Account ID
\r\n • FEIN
\r\n • Policy ID
\r\n • Quote Number
\r\n Only one (1) parameter can be used to search
\r\n Only the first ten (10) results will return; if there are more than (10) records associated with the given search parameter, they will not all return.",
"operationId": "get-api-v1-policies",
"parameters": [
{
"name": "MasterAccountId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PolicyId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Fein",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Quote",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "dbc3aa50fc12",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "ce1ae51475f7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicySearchResponseIReadOnlyCollectionBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PolicyNumber": "string",
"BusinessName": "string",
"EffectiveDate": "string",
"PolicyStatus": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "6ffb5233073f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/print/{quoteId}": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a byte representation of the quote proposal in PDF format.",
"description": "Retrieves a byte representation of the quote proposal in PDF format.",
"operationId": "post-api-v1-print-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ebc8f5be6aab",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f483b1b23418",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "byte"
},
"example": "string"
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "f436c35a7b21",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/questions": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves underwriting questions applicable to a specific class code and state combination passed in the request body.",
"description": "Retrieves underwriting questions applicable to a specific class code and state combination passed in request body.",
"operationId": "post-api-v1-questions",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/Questions"
},
"example": {
"ClassCodeList": [
{
"ClassCode": "string",
"LocState": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Questions"
},
"example": {
"ClassCodeList": [
{
"ClassCode": "string",
"LocState": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Questions"
},
"example": {
"ClassCodeList": [
{
"ClassCode": "string",
"LocState": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Questions"
},
"example": {
"ClassCodeList": [
{
"ClassCode": "string",
"LocState": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d2b87007c11f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1ae334dbb1a9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionsResponse"
},
"example": {
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Questions": [
{
"QuestionId": 0,
"Question": "string",
"QuestionType": "string",
"DropdownOptions": [
{
"Key": "string",
"Value": "string"
}
],
"ParentQuestionId": 0,
"ParentAnswerToShow": "string",
"Answer": "string",
"IsDuplicateQuestion": true
}
],
"MasterEligibilityStatus": "0 = Incomplete"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "8987c067c1df",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/questions": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of underwriter questions that must be answered for the specified quote.",
"description": "Retrieve a list of underwriter questions that must be answered, for the specified quote.",
"operationId": "get-api-v1-quotes-quoteid-questions",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "0693b38310bc",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8a80804df03a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuestionResponse_2ListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"Id": 0,
"Question": "string",
"QuestionType": "string",
"DropdownOptions": [
{
"Key": "string",
"Text": "string"
}
],
"ParentQuestionId": 0,
"ParentAnswerToShow": "string",
"Answer": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "3474dc87f0a5",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/questions-answers": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Posts answers to one or more questions with question ID and answer. Questions must be answered before binding.\nRequesting eligibility can be included in the URL to return eligibility status in the response.",
"description": "Posts answers to one or more questions with question ID and answer.
\r\n __Questions must be answered before binding.__
\r\n __*__ Requesting Eligibility may be passed in the URL, if wanting to see the eligibility status of quote in the response. If including eligibility is marked false or not included in the URL it will not be returned in the response",
"operationId": "post-api-v1-quotes-quoteid-questions-answers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "loadEligibility",
"in": "query",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
}
},
"example": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
}
},
"example": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
}
},
"example": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
}
},
"example": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2405ec4201e2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1235ca50b8f1",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "d4a1213dfc28",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "75587fccac42",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}": {
"put": {
"tags": [
"Workers Comp"
],
"summary": "Updates information on an existing quote. The entire existing quote body must be included; omitted information will be deleted.",
"description": "Updates information on an existing quote.
\r\n __Please Note:__ entire existing quote body must be included, and any desired additonal/updated information should be \r\n added/changed within the body. If information is omitted, it will be deleted.",
"operationId": "put-api-v1-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "includeEligibility",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/QuotePutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QuotePutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QuotePutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b2e63b2f418d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "77db01a63390",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteApiReturnModel"
},
"example": {
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"LiabilityLimits": "string",
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"EstimatedAnnualPremium": 0,
"GoverningState": "string",
"MasterAccountId": 0,
"RatingZip": "string",
"UnemploymentId": "string",
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
],
"QuoteStatus": "string"
},
"DigitalClientWorkflow": "string",
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "03b23c926d8d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "1f63fa017f90",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"patch": {
"tags": [
"Workers Comp"
],
"summary": "Partially updates a quote. Supports targeted field updates by index ID for class codes.\nIf approved, only effective date may be changed. Declined quotes are fully locked.",
"description": "\r\n - If quote has been approved by an Underwriter, the only parameter that may be sent is Effective Date; all other parameters will be locked
\r\n - If quote has been declined by an Underwriter or due to class code/question answers, quote will be completely locked for editing
\r\n - If class code update is being made, the Class Code Index ID is required, but you may send only a single parameter linked to that ID (example: You want to update payroll amount on class code 123456 - that class code has an index ID of 589745 - you would pass Class Code Index ID 589745, and then Payroll (amount) in your request. You do not need to send anything else
\r\n
",
"operationId": "patch-api-v1-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseQuoteOperation"
}
},
"example": [
{
"op": "replace",
"value": 23,
"path": "/yearsInBusiness"
},
{
"op": "replace",
"value": true,
"path": "/isNonProfit"
},
{
"op": "replace",
"value": 12,
"path": "/classCodes/0/fullTimeEmployees"
},
{
"op": "replace",
"value": "test42",
"path": "primaryAddress/Line2"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseQuoteOperation"
}
},
"example": [
{
"op": "replace",
"value": 23,
"path": "/yearsInBusiness"
},
{
"op": "replace",
"value": true,
"path": "/isNonProfit"
},
{
"op": "replace",
"value": 12,
"path": "/classCodes/0/fullTimeEmployees"
},
{
"op": "replace",
"value": "test42",
"path": "primaryAddress/Line2"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseQuoteOperation"
}
},
"example": [
{
"op": "replace",
"value": 23,
"path": "/yearsInBusiness"
},
{
"op": "replace",
"value": true,
"path": "/isNonProfit"
},
{
"op": "replace",
"value": 12,
"path": "/classCodes/0/fullTimeEmployees"
},
{
"op": "replace",
"value": "test42",
"path": "primaryAddress/Line2"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseQuoteOperation"
}
},
"example": [
{
"op": "replace",
"value": 23,
"path": "/yearsInBusiness"
},
{
"op": "replace",
"value": true,
"path": "/isNonProfit"
},
{
"op": "replace",
"value": 12,
"path": "/classCodes/0/fullTimeEmployees"
},
{
"op": "replace",
"value": "test42",
"path": "primaryAddress/Line2"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "77a9417a6dcd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9de08874a531",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteApiReturnModelIApiResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "42405e49e563",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "90c87b90e4ba",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/submitToUnderwriter": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Submit to underwriter",
"description": "This endpoint can be used to submit Referred quotes to the underwriter.
\r\n The GET Quote Eligibility (v1/quotes/{quoteId}/eligibility) endpoint can be used to view current status of the quote.
\r\n Please Note - Declined quotes cannot be submitted.",
"operationId": "post-api-v1-quotes-quoteid-submittounderwriter",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a1586eb9e816",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "061ed4c7cdfd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterResponseModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"MasterAccountId": 0,
"SubmittedDate": "string",
"BusinessName": "string",
"QuoteInformation": {
"QuoteId": 0,
"Product": "string",
"EffectiveDate": "string",
"Premium": 0
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4b5da754fb10",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "a57ab0818abf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/additional-information": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves additional locations, additional insureds, and/or officers to the quote.\nIf a quote is in the state of Nebraska and is a non-profit corporation the annual compensation for the officer is required.\nIf the annual compensation is equal or less than 1,000 the Officer will be saved.\nIf the annual c",
"description": "If a quote is in the state of Nebraska and is a non-profit corporation the annual compensation for the officer is required. \r\nIf the annual compensation is equal or less than 1,000 the Officer will be saved. \r\nIf the annual compensation is equal or greater than 1,001 the officer will not be saved. \r\n\r\n**NOTE:** \r\n'TotalEmployeeNumber' is a required field if in the state of CA.",
"operationId": "post-api-v2-quotes-quoteid-additional-information",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "189eed4a3164",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "7c92d806b03d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoReturnModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Officers": [
{
"Id": 0,
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"DateOfBirth": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Id": 0,
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"DbaName": "string",
"UnemploymentId": "string",
"AdditionalLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"IndexId": 0,
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/bind/agent-contact/{agentContactId}": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Binds a quote to a policy.\nThe quote must be in either BindEligible or Approved status before bind will be successful.\nThe Get All Agent Contacts endpoint can be utilized to allow the submitting agent to select their name in order to pass \nthe contact ID through the URI.\nThis endpoint can be called ",
"description": "The quote must be in either BindEligible or Approved status before bind will be successful
\r\n The (GET) All Agent Contacts endpoint can and should be utilized to allow submitting agent to select his/her name, \r\n in order to pas contact ID through URI
\r\n This endpoint can be called in conjunction with the (GET) Affirmation Statement endpoint",
"operationId": "post-api-v2-quotes-quoteid-bind-agent-contact-agentcontactid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "agentContactId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6c0e2ea268a8",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "039808dc91d8",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "4ae96805dd8c",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BindResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"QuoteId": 0,
"Policy": "string",
"PolicyId": 0,
"EffectiveDate": "string",
"AnnualPremium": "string"
}
}
}
}
}
}
}
},
"/api/v2/fein/validation": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Optional but recommended endpoint to determine a FEIN's availability for use on a quote.",
"description": "This endpoint is optional, but recommended, and can be used to determine a FEIN's availability for use on a quote.",
"operationId": "post-api-v2-fein-validation",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "bf1057633ed7",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2c9980c899ba",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": true
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "29eb71d49ec1",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "f7cd85569191",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/states/{governingState}/effectiveDate/{effectiveDate}/legalEntities/available": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all legal entities that are available in a specified state as of the effective date passed.",
"description": "Retrieves all legal entities that are availablein a specified state, as of the effective date passed.",
"operationId": "get-api-v2-states-governingstate-effectivedate-effectivedate-legalentities-a",
"parameters": [
{
"name": "governingState",
"in": "path",
"required": true,
"schema": {
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "891c09ee1241",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2a5072d89e39",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"LegalEntityId": 0,
"EntityDescription": "string"
}
]
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/PaymentPlans": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves payment plans available for selection on the specified quote.\nIf mapping direct debit options, refer to the Save Direct Debit and Direct Debit Terms and Agreements endpoints.\nThis endpoint only saves payment plan information and does not process a payment.",
"description": "If you plan to map direct debit payment plan options, please refer to Save Direct Debit information and Direct Debit Terms and Agreements endpoint documentation. Please note that is endpoint only saves payment plan information and does not save information related to making a payment.",
"operationId": "get-api-v2-quotes-quoteid-paymentplans",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b3f8261f0b5d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "1fe7bcedbc1f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "31b17d5f1f81",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanResponseV2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Direct": [
{
"IsCurrentPaymentPlan": true,
"PaymentPlan": "0 = None",
"PaymentPlanDescription": "string",
"PaymentPlanId": 0,
"PayrollCompanyId": 0,
"NumberPayments": 0,
"TotalCost": 0,
"TotalPremium": 0,
"TotalStateTaxes": 0,
"TotalBillingFees": 0,
"DepositPercent": 0,
"DownPayment": 0,
"IsDirectDebit": true,
"Message": "string",
"Invoices": [
{
"PremiumAmount": 0,
"Taxes": 0,
"Fees": 0,
"TotalBillAmount": 0,
"BillDate": "string",
"DueDate": "string",
"IsDownPayment": true
}
]
}
],
"Agency": [
{
"IsCurrentPaymentPlan": true,
"PaymentPlan": "0 = None",
"PaymentPlanDescription": "string",
"PaymentPlanId": 0,
"PayrollCompanyId": 0,
"NumberPayments": 0,
"TotalCost": 0,
"TotalPremium": 0,
"TotalStateTaxes": 0,
"TotalBillingFees": 0,
"DepositPercent": 0,
"DownPayment": 0,
"IsDirectDebit": true,
"Message": "string",
"Invoices": [
{
"PremiumAmount": 0,
"Taxes": 0,
"Fees": 0,
"TotalBillAmount": 0,
"BillDate": "string",
"DueDate": "string",
"IsDownPayment": true
}
]
}
]
}
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/paymentPlans": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves the selected payment plan to the specified quote.",
"description": "Saves the selected payment plan to the specified quote.",
"operationId": "post-api-v2-quotes-quoteid-paymentplans",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "42d934517a69",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b6e0bbac7f91",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "85d760329c19",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
}
}
}
},
"/api/v2/policies/{policy}/endorsement-eligibility": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves a list of all endorsements the given policy is eligible for.",
"description": "Retrieves a list of all endorsements the given policy is eligible for.",
"operationId": "get-api-v2-policies-policy-endorsement-eligibility",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "377ec5d0d1f4",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5a2b0c63f3f6",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndorsementEligibilityResponseVer2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EndorsementType": [
"string"
],
"IneligibilityReason": [
"string"
],
"CurrentPartners": [
{
"FirstName": "string",
"LastName": "string",
"Id": 0
}
],
"SubChangeReasons": [
{
"EndmtSubType": "string",
"EndmtChangeReason": "string",
"EndmtChangeReasonId": 0
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "70cc9c16e75c",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/questions/states": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Returns all AmTrust class codes along with their accompanying underwriting questions and general underwriting questions.\nState and effective date are optional. If no state is passed, response returns all states as byte array.",
"description": "This endpoint will return all AmTrust class codes, along with their accompanying underwriting questions. It will also return the general underwriting questions that will need to be answered, regardless of what class code is passed in a quote.
\r\n __Please note:__
\r\n __•__ If a class code is not returned in this endpoint, it means that only the general questions will need to be answered for it.
\r\n __•__ The state and effective date are optional:
\r\n __•__ If no state is passed, the response will return in a byte representation of a JSON response, and will include all states. If state is passed, a JSON response will return, and will include only information within that state
\r\n __•__ If no effective date is passed, the effective date will be defaulted to today",
"operationId": "get-api-v2-questions-states",
"parameters": [
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "fa0f29d55ed7",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "def9ed701c3c",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UwQuestionsResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"GeneralQuestions": [
{
"QuestionId": 0,
"QuestionType": "string",
"Question": "string",
"ExpirationDate": "string"
}
],
"AllQuestionsBinary": "string",
"ClassCodeQuestions": [
{
"State": "string",
"ClassCode": "string",
"Questions": [
{
"QuestionId": 0,
"QuestionType": "string",
"Question": "string",
"ExpirationDate": "string"
}
]
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "27088642a165",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "fb409e785306",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/quotes": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Creates a new WC quote.\nTo add a single experience modifier, use either the ExperienceModifier or StateModifiers field. Do not use both at once.",
"description": "Create a quote.
\r\n __•__ Note! To add a single experience modifier, use either the 'ExperienceModifier' or 'StateModifiers' field. To add multiple experience modifiers, use the 'StateModifiers' field. Do not use both fields at once.",
"operationId": "post-api-v2-quotes",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/QuotePostModel"
},
"example": {
"Quote": {
"MasterAccountId": null,
"BillType": null,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"ExpirationDate": null,
"Fein": "070818854",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": null,
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"ClassCodes": [
{
"ClassCode": "9082",
"ClassDescriptionCode": "02",
"State": "FL",
"Payroll": 65000,
"FullTimeEmployees": 2,
"PartTimeEmployees": 0
}
],
"RatingZip": "44114",
"UnemploymentId": null,
"PayrollCompanyId": null,
"LiabilityLimits": null,
"FirmId": null,
"AdditionalCoverages": null,
"SpousesNames": null
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 201,
"AnswerValue": "true"
}
],
"ExperienceModifier": null,
"StateModifiers": [
{
"State": "FL",
"Modifiers": {
"Empct": "0.64"
}
},
{
"State": "CA",
"Modifiers": {
"Empct": "0.55"
}
}
],
"DigitalClientWorkflow": "Workflow",
"LoadRateSummary": true,
"PricingTiers": null
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePostModel"
},
"example": {
"Quote": {
"MasterAccountId": null,
"BillType": null,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"ExpirationDate": null,
"Fein": "070818854",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": null,
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"ClassCodes": [
{
"ClassCode": "9082",
"ClassDescriptionCode": "02",
"State": "FL",
"Payroll": 65000,
"FullTimeEmployees": 2,
"PartTimeEmployees": 0
}
],
"RatingZip": "44114",
"UnemploymentId": null,
"PayrollCompanyId": null,
"LiabilityLimits": null,
"FirmId": null,
"AdditionalCoverages": null,
"SpousesNames": null
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 201,
"AnswerValue": "true"
}
],
"ExperienceModifier": null,
"StateModifiers": [
{
"State": "FL",
"Modifiers": {
"Empct": "0.64"
}
},
{
"State": "CA",
"Modifiers": {
"Empct": "0.55"
}
}
],
"DigitalClientWorkflow": "Workflow",
"LoadRateSummary": true,
"PricingTiers": null
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QuotePostModel"
},
"example": {
"Quote": {
"MasterAccountId": null,
"BillType": null,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"ExpirationDate": null,
"Fein": "070818854",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": null,
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"ClassCodes": [
{
"ClassCode": "9082",
"ClassDescriptionCode": "02",
"State": "FL",
"Payroll": 65000,
"FullTimeEmployees": 2,
"PartTimeEmployees": 0
}
],
"RatingZip": "44114",
"UnemploymentId": null,
"PayrollCompanyId": null,
"LiabilityLimits": null,
"FirmId": null,
"AdditionalCoverages": null,
"SpousesNames": null
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 201,
"AnswerValue": "true"
}
],
"ExperienceModifier": null,
"StateModifiers": [
{
"State": "FL",
"Modifiers": {
"Empct": "0.64"
}
},
{
"State": "CA",
"Modifiers": {
"Empct": "0.55"
}
}
],
"DigitalClientWorkflow": "Workflow",
"LoadRateSummary": true,
"PricingTiers": null
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QuotePostModel"
},
"example": {
"Quote": {
"MasterAccountId": null,
"BillType": null,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"ExpirationDate": null,
"Fein": "070818854",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": null,
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"ClassCodes": [
{
"ClassCode": "9082",
"ClassDescriptionCode": "02",
"State": "FL",
"Payroll": 65000,
"FullTimeEmployees": 2,
"PartTimeEmployees": 0
}
],
"RatingZip": "44114",
"UnemploymentId": null,
"PayrollCompanyId": null,
"LiabilityLimits": null,
"FirmId": null,
"AdditionalCoverages": null,
"SpousesNames": null
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 201,
"AnswerValue": "true"
}
],
"ExperienceModifier": null,
"StateModifiers": [
{
"State": "FL",
"Modifiers": {
"Empct": "0.64"
}
},
{
"State": "CA",
"Modifiers": {
"Empct": "0.55"
}
}
],
"DigitalClientWorkflow": "Workflow",
"LoadRateSummary": true,
"PricingTiers": null
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d265c30541ed",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "233f445f1fde",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteReturnModelBaseResponse"
},
"example": {
"Data": {
"EffectiveDate": "2026-08-13T11:08:11.0000000+00:00",
"Fein": "070818854",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": "",
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102,
"AgentContactName": "Test Tester AH"
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"RatingZip": "",
"PayrollCompanyId": 0,
"UnemploymentId": "",
"AccountInformation": {
"QuoteId": 1,
"MasterAccountId": 1,
"GoverningState": "FL",
"Status": "Refer Eligible",
"AccountUrl": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/1",
"Carrier": "Technology Insurance Company, Inc."
},
"PremiumDetails": {
"PriceIndication": 1122,
"StateTaxes": 0,
"LimitPerAccident": 100000,
"BodilyInjuryFromDiseasePolicyLimit": 500000,
"BodilyInjuryFromDiseasePerEmployeeLimit": 100000,
"LiabilityLimits": "100/500/100"
},
"ClassCodes": [
{
"IndexId": 8530395,
"ClassCode": "9082",
"ClassDescriptionCode": "00",
"State": "FL",
"Payroll": "65000",
"FullTimeEmployees": 2,
"PartTimeEmployees": 0,
"HttpStatusCode": 200,
"StatusCode": "200",
"Service": null,
"Message": "ok",
"AdditionalMessages": []
}
],
"Eligibility": {
"Eligibility": "Refer",
"Details": [
{
"Type": "ClassCodes",
"Eligibility": "BindEligible"
},
{
"Type": "Questions",
"Eligibility": "Refer"
},
{
"Type": "Territory",
"Eligibility": "BindEligible"
},
{
"Type": "Modifiers",
"Eligibility": "BindEligible"
}
]
},
"Questions": [
{
"Id": 1,
"Question": "Does business have more than 50 people working at one location at a time?",
"QuestionType": "bool",
"DropdownOptions": [],
"ParentQuestionId": 0,
"ParentAnswerToShow": null,
"Answer": null
}
],
"ExperienceModifier": [
{
"State": "FL",
"Modifiers": [
{
"Id": "EmPct",
"Value": "0.6",
"ModifierUiInformation": {
"Description": "Experience Modifier",
"RegexFormatting": "\\d?\\.\\d\\d?$",
"ModifierType": "Decimal",
"OnlyAvailableValues": null,
"MinValue": 0.5,
"MaxValue": 3
},
"ExcludingModifier": null,
"State": "FL"
}
]
},
{
"State": "CA",
"Modifiers": [
{
"Id": "EmPct",
"Value": "0.55",
"ModifierUiInformation": {
"Description": "Experience Modifier",
"RegexFormatting": "\\d?\\.\\d\\d?$",
"ModifierType": "Decimal",
"OnlyAvailableValues": null,
"MinValue": 0.49,
"MaxValue": 3
},
"ExcludingModifier": null,
"State": "CA"
}
]
}
],
"DigitalClientWorkflow": "Workflow",
"Modifiers": null,
"RatingSummary": [
{
"GovState": null,
"ModelType": "Discount",
"ItemType": "ExpConstant1",
"ClassCode": "0900",
"Description": "Expense Constant",
"Premium": 100,
"Year": 1,
"Rate": 0,
"Exposure": 0
}
],
"PricingTiers": []
},
"StatusCode": 200,
"Exception": null,
"Message": "Quote created",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "aacfa537380f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all currently saved information on a specified quote, including class codes, addresses, eligibility, price indication, etc.",
"description": "Retrieves all currently saved information on a specified quote, including (but not limited to) class codes, mailing/primary addresses, current eligibility, price indication, etc…",
"operationId": "get-api-v2-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "loadQuestions",
"in": "query",
"description": "Set to \"true\" to return all questions associated with the created quote",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "150a4f9a5470",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1105654ff4ac",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FullQuoteReturnModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"PayrollCompanyId": 0,
"UnemploymentId": "string",
"AccountInformation": {
"QuoteId": 0,
"MasterAccountId": 0,
"GoverningState": "string",
"Status": "string",
"AccountUrl": "string",
"Carrier": "string"
},
"PremiumDetails": {
"PriceIndication": 0,
"StateTaxes": 0,
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
},
"Questions": [
{
"Id": 0,
"Question": "string",
"QuestionType": "string",
"DropdownOptions": [
{
"Key": "string",
"Text": "string"
}
],
"ParentQuestionId": 0,
"ParentAnswerToShow": "string",
"Answer": "string"
}
],
"FirmId": "string",
"ExperienceModifier": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"DigitalClientWorkflow": "string",
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
},
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
],
"AdditionalInformation": {
"Officers": [
{
"Id": 0,
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"DateOfBirth": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Id": 0,
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"DbaName": "string",
"UnemploymentId": "string",
"AdditionalLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"IndexId": 0,
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
},
"QuoteStatus": "string",
"ClosedDate": "string",
"ForeignVoluntaryCoverage": [
{
"IndexId": 0,
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
],
"SpecificWaivers": [
{
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
]
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "456961975976",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v3/policies/{policy}/endorsements": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves the selected policy endorsement. Supports insured-name-update, insured-mailing-address-update,\ninsured-fein-change, partners-update, and insured-primary-address-update.",
"description": "The full list of potential endorsements based on the policy are
\r\n • 'insured-name-update'
\r\n • 'insured-mailing-address-update'
\r\n • 'insured-fein-change'
\r\n • 'partners-update'
\r\n • 'insured-primary-address-update'
\r\n • 'additional-insureds-update'
\r\n • 'exposure-update'
\r\n • 'officers-update'
\r\n • 'legal-entity-update'
\r\n • 'agent-other-request'
\r\n • 'blanket-waiver-change'
\r\n • 'specific-waivers-change'
\r\n Primary Address Change endorsement fields
\r\n Required fields
\r\n Line1
\r\n City
\r\n State
\r\n ZipCode
\r\n UpdateMailingAddress
\r\n Optional Fields
\r\n Line2
\r\n UpdateBillingAddress - This is needed if UpdateMailingAddress is TRUE
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n Additional Insureds Update endorsement fields
\r\n Required fields
\r\n AddressLine1
\r\n City
\r\n State
\r\n ZipCode
\r\n Optional Fields
\r\n Id
\r\n AddressLine2
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n Exposure Update endorsement fields
\r\n Required fields
\r\n State
\r\n ClassCode
\r\n DescriptionCode
\r\n FullTimeEmployees
\r\n PartTimeEmployees
\r\n Payroll
\r\n Optional Fields
\r\n Notes, DisplayName, WindowsFileType and FileData - Those are required only if the payroll changes by more than 40%, including a 40% decrease.
\r\n officers Update endorsement fields
\r\n Required fields
\r\n OfficerName
\r\n Type
\r\n State
\r\n FormType
\r\n EndorsementId
\r\n OwnershipPercentage
\r\n Optional Fields
\r\n Id - Is required only for update
\r\n Legal Entity Update endorsement fields
\r\n Required fields
\r\n LegalEntityCode
\r\n Optional Fields
\r\n Notes
\r\n DisplayName, WindowsFileType, FileData - All three fields should be entered together
\r\n Inspection contact information fields
\r\n Required fields
\r\n FirstName
\r\n LastName
\r\n Phone
\r\n Optional Fields
\r\n Email
\r\n Agent Other endorsement fields
\r\n Required fields
\r\n Notes
\r\n Optional Fields
\r\n DisplayName, WindowsFileType, FileData - All three fields should be entered together
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n Blanket Waiver Change endorsement fields
\r\n Required fields
\r\n RemoveWaiver - True = remove waiver, False = add waiver
\r\n Specific Waivers Change endorsement fields
\r\n Required fields
\r\n Id
\r\n StartDate
\r\n EndDate
\r\n State
\r\n FirstName
\r\n LastName
\r\n Line1
\r\n Line2
\r\n City
\r\n State
\r\n Zip
\r\n JobDescription
\r\n Payroll
\r\n ClassCode
\r\n Delete - True = remove waiver, False = add waiver
",
"operationId": "post-api-v3-policies-policy-endorsements",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": null
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": null
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": null
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": null
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "50520e55005b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a51285d26521",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyEndorsementBulkResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"Reason": "Change in Ownership",
"Type": null,
"Endorsements": null
},
{
"Reason": "Data Correction",
"Type": null,
"Endorsements": null
},
{
"Reason": "Change in Entity",
"Type": null,
"Endorsements": null
}
],
"StatusCode": 0,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "a874f8125ec7",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "562ded2f7d4f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/terms-of-agreement": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves an acknowledgement that the insured has read the Terms of Agreement statement before submitting Direct Debit information.",
"description": "This endpoint is meant to be used in conjunction with the (GET) Terms of Agreement endpoint. Insureds will need to acknowledge that they have red the statement in order to submit their Direct Debit Information.",
"operationId": "post-api-v1-quotes-quoteid-terms-of-agreement",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ff2447e3a9cd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c322bf32f2d6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "e85b7b6f7b35",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isOk": {
"type": "boolean"
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"responseId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"messageCode": {
"type": "string"
},
"isOk": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}
},
"maxMessageIndex": {
"type": "integer",
"format": "int32"
},
"_v": {
"type": "string"
}
}
},
"example": {
"isOk": true,
"httpStatusCode": 200,
"responseId": "bf30862e05fe",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"messages": [
{
"httpStatusCode": 200,
"messageCode": "SUCCESS",
"isOk": true,
"detail": "Acknowledgement saved successfully!"
}
],
"maxMessageIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/terms-of-agreement": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves the Terms of Agreement statement. Insureds must acknowledge they have read this statement before entering Direct Debit information.\nUse in conjunction with the POST Terms of Agreement endpoint.",
"description": "This endpoint is meant to be used in conjunction with the (POST) Terms of Agreement endpoint. Insureds will need to acknowledge that they have read the statement before entering the Direct Debit information. ",
"operationId": "get-api-v1-terms-of-agreement",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "5376eb0e41b3",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2e8da76310cd",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"example": "string"
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/underwriter-messages": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieve underwriter message history.",
"operationId": "get-api-v1-quotes-quoteid-underwriter-messages",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d6cafb41b1d2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8cf3a64b7564",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUnderwritingMessageListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"IndexId": 0,
"User": "string",
"Message": "string",
"AgentEntry": true,
"Sent": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "345b7ab9c12e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/policies/{policy}/PaymentPlans/DirectDebit/Documents": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Allows user to upload the EFT form and/or voided check necessary to use direct debit as a payment plan.",
"description": "Allows user to upload the EFT form and/or the voided check necessary to use direct debit as a payment plan",
"operationId": "post-api-v2-policies-policy-paymentplans-directdebit-documents",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a6126fa98aca",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "692371f22e1c",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "2cd5129f7814",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"LibraryId": 0
}
}
}
}
}
}
}
},
"/api/v2/policies/{policy}/PaymentPlans/DirectDebit": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves bank account information for direct debit payments on a policy.",
"description": "Allows user to save their bank account information for direct debit payments",
"operationId": "post-api-v2-policies-policy-paymentplans-directdebit",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "744278e12a3e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "7f394ab36d2f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "389f4cf6e849",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"NameOnAccount": "string",
"AccountNumber": "string",
"RoutingNumber": "string",
"Email": "string",
"AccountType": "1 = Checking",
"BankName": "string"
}
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/additionalInformation/insured-locations": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Deletes a specified insured location record, by location ID and address, from the quote specified by the URI parameter quoteId.",
"description": "Deletes a specified insured location record, by location ID and address, from the quote specified by the URI parameter quoteId.",
"operationId": "delete-api-v2-quotes-quoteid-additionalinformation-insured-locations",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ec57caf5806b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "bd3856777853",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "411a72751a0e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quote": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Creates a specialty program quote. Only use this endpoint if specifically directed to; it is for Specialty Programs.",
"description": "Create a quote.
\r\n __•__ If you have not specifically been told to use this endpoint, please do not map. This is for Specialty Programs",
"operationId": "post-api-v1-specialty-program-quote",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModel"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
]
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModel"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
]
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModel"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
]
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModel"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
]
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "36595a13af6d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "cc643deacabd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyReturnModelBaseResponse"
},
"example": {
"Data": {
"EffectiveDate": "2026-08-13T11:08:11.0000000+00:00",
"ExpirationDate": null,
"Fein": "070818854",
"FirmId": "0",
"PrimaryAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"MailingAddress": {
"Line1": "4th",
"Line2": "",
"City": "Florida",
"State": "FL",
"Zip": "94022"
},
"BusinessName": "Stark Industries",
"DBA": "",
"ContactInformation": {
"FirstName": "Pepper",
"LastName": "Potts-Stark",
"Email": "IronLove3000@mail.com",
"Phone": "1112224444",
"AgentContactId": 406102,
"AgentContactName": "Test Tester AH"
},
"NatureOfBusiness": "Defense",
"LegalEntity": 3,
"YearsInBusiness": 5,
"ExpiredPremium": 0,
"IsNonProfit": false,
"CompanyWebsiteAddress": "",
"RatingZip": "",
"PayrollCompanyId": 0,
"UnemploymentId": "",
"AccountInformation": {
"QuoteId": 1,
"MasterAccountId": 1,
"GoverningState": "FL",
"Status": "Refer Eligible",
"AccountUrl": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/1",
"Carrier": "Technology Insurance Company, Inc."
},
"PremiumDetails": {
"PriceIndication": 1122,
"StateTaxes": 0,
"LimitPerAccident": 100000,
"BodilyInjuryFromDiseasePolicyLimit": 500000,
"BodilyInjuryFromDiseasePerEmployeeLimit": 100000,
"LiabilityLimits": "100/500/100"
},
"ClassCodes": [
{
"IndexId": 8530395,
"ClassCode": "9082",
"ClassDescriptionCode": "00",
"State": "FL",
"Payroll": "65000",
"FullTimeEmployees": 2,
"PartTimeEmployees": 0,
"HttpStatusCode": 200,
"StatusCode": "200",
"Service": null,
"Message": "ok",
"AdditionalMessages": []
}
],
"Eligibility": {
"Eligibility": "Refer",
"Details": [
{
"Type": "ClassCodes",
"Eligibility": "BindEligible"
},
{
"Type": "Questions",
"Eligibility": "Refer"
},
{
"Type": "Territory",
"Eligibility": "BindEligible"
},
{
"Type": "Modifiers",
"Eligibility": "BindEligible"
}
]
},
"Questions": [
{
"Id": 1,
"Question": "Does business have more than 50 people working at one location at a time?",
"QuestionType": "bool",
"DropdownOptions": [],
"ParentQuestionId": 0,
"ParentAnswerToShow": null,
"Answer": null
}
],
"AdditionalCoverages": null,
"RatingSummary": [
{
"GovState": null,
"ModelType": "Discount",
"ItemType": "ExpConstant1",
"ClassCode": "0900",
"Description": "Expense Constant",
"Premium": 100,
"Year": 1,
"Rate": 0,
"Exposure": 0
}
],
"PricingTiers": []
},
"StatusCode": 201,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "c2039a2b0b67",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quote/{quoteId}": {
"patch": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates the majority of fields on a specialty program quote.",
"description": "You can update majority of fields on a quote",
"operationId": "patch-api-v1-specialty-program-quote-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "07b03a2c9b60",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "020dd1fe51d0",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuoteSpecialtyReturnModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"FirmId": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"PayrollCompanyId": 0,
"UnemploymentId": "string",
"AccountInformation": {
"QuoteId": 0,
"MasterAccountId": 0,
"GoverningState": "string",
"Status": "string",
"AccountUrl": "string",
"Carrier": "string"
},
"PremiumDetails": {
"PriceIndication": 0,
"StateTaxes": 0,
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
},
"Modifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
]
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "70408743bfee",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/firms/{state}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Shows all available firms in a specific state.",
"description": "This endpoint will show all available firms in a specific state",
"operationId": "get-api-v1-specialty-program-firms-state",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"description": "Query will use the current date if unsent.",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "54e0b64e4957",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "fc616c24825e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFirmResponseDtoIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"FirmId": 1,
"FirmName": "AmTrust Test Firm 1",
"FirmNameShort": "ATF1",
"AuthorizedState": "AL"
},
{
"FirmId": 2,
"FirmName": "AmTrust Test Firm 2",
"FirmNameShort": "ATF2",
"AuthorizedState": "AL"
},
{
"FirmId": 3,
"FirmName": "AmTrust Test Firm 3",
"FirmNameShort": "ATF3",
"AuthorizedState": "AL"
}
],
"StatusCode": 200,
"Exception": null,
"Message": "OK",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorBaseResponse"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/firms": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Shows all available firms for the specified quote.",
"description": "This endpoint will show all available firms for this quote",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-firms",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "447d929c2d60",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1605d8130fd6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetFirmResponseDtoIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"FirmId": 1,
"FirmName": "AmTrust Test Firm 1",
"FirmNameShort": "ATF1",
"AuthorizedState": "AL"
},
{
"FirmId": 2,
"FirmName": "AmTrust Test Firm 2",
"FirmNameShort": "ATF2",
"AuthorizedState": "AL"
},
{
"FirmId": 3,
"FirmName": "AmTrust Test Firm 3",
"FirmNameShort": "ATF3",
"AuthorizedState": "AL"
}
],
"StatusCode": 200,
"Exception": null,
"Message": "OK",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all currently saved information on a specified specialty program quote.",
"description": "Retrieves all currently saved information on a specified quote, including (but not limited to) class codes, mailing/primary addresses, current eligibility, price indication, etc…",
"operationId": "get-api-v1-specialty-program-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "loadQuestions",
"in": "query",
"description": "Set to \"true\" to return all questions associated with the created quote",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c932b646511d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "156d934f8203",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetQuoteSpecialtyReturnModelBaseResponse"
},
"example": {
"Data": {
"ForeignVoluntaryCoverage": null,
"SpecificWaivers": null,
"AdditionalInformation": null,
"Dividends": null,
"QuoteStatus": null,
"EffectiveDate": null,
"ExpirationDate": null,
"Fein": null,
"FirmId": null,
"PrimaryAddress": null,
"MailingAddress": null,
"BusinessName": null,
"DBA": null,
"ContactInformation": null,
"NatureOfBusiness": null,
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": null,
"IsNonProfit": null,
"CompanyWebsiteAddress": null,
"RatingZip": null,
"PayrollCompanyId": null,
"UnemploymentId": null,
"AccountInformation": null,
"PremiumDetails": null,
"ClassCodes": null,
"Eligibility": {
"Eligibility": null,
"Details": []
},
"Questions": null,
"AdditionalCoverages": null,
"RatingSummary": [],
"PricingTiers": []
},
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates a specialty program quote. Fields not included in the request body will remain unchanged; information is not deleted on omission.",
"description": "Use this to update the quote
\r\n Please be aware if a field that is on the quote is not included in the\r\n request body it will remain as is. We will NOT delete the information\r\n previously included.",
"operationId": "put-api-v1-specialty-program-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "includeEligibility",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPutModel"
},
"example": {
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"LiabilityLimits": "string",
"UnemploymentId": "string",
"DigitalClientWorkflow": "string",
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"MasterAccountId": 0,
"BillType": "0 = A",
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2dd908a0110c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f368ae898010",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpecialtyQuoteApiReturnModel"
},
"example": {
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"EffectiveDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"LiabilityLimits": "string",
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbantAgent": true,
"CompanyWebsiteAddress": "string",
"EstimatedAnnualPremium": 0,
"GoverningState": "string",
"MasterAccountId": 0,
"RatingZip": "string",
"UnemploymentId": "string",
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
],
"QuoteStatus": "string"
},
"DigitalClientWorkflow": "string",
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"ExpirationDate": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"PayrollCompanyId": 0,
"StateModifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "08803cb50d30",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "c0e6ddf93461",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"patch": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Partially updates the majority of fields on a specialty program quote.",
"description": "You can update majority of fields on a quote",
"operationId": "patch-api-v1-specialty-program-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
},
"example": [
{
"value": "Stark",
"path": "/BusinessName",
"op": "replace"
},
{
"value": "15",
"path": "/YearsInBusiness",
"op": "replace"
},
{
"value": "12",
"path": "/LegalEntity",
"op": "replace"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b6d8b340a6c5",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8e29d793b95a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuoteSpecialtyReturnModelV2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"PayrollCompanyId": 0,
"UnemploymentId": "string",
"AccountInformation": {
"QuoteId": 0,
"MasterAccountId": 0,
"GoverningState": "string",
"Status": "string",
"AccountUrl": "string",
"Carrier": "string"
},
"PremiumDetails": {
"PriceIndication": 0,
"StateTaxes": 0,
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
},
"Questions": [
{
"Id": 0,
"Question": "string",
"QuestionType": "string",
"DropdownOptions": [
{
"Key": "string",
"Text": "string"
}
],
"ParentQuestionId": 0,
"ParentAnswerToShow": "string",
"Answer": "string"
}
],
"FirmId": "string",
"ExperienceModifier": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"DigitalClientWorkflow": "string",
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
},
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
],
"AdditionalInformation": {
"Officers": [
{
"Id": 0,
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"DateOfBirth": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Id": 0,
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"DbaName": "string",
"UnemploymentId": "string",
"AdditionalLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"IndexId": 0,
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
},
"QuoteStatus": "string",
"ClosedDate": "string",
"ForeignVoluntaryCoverage": [
{
"IndexId": 0,
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
],
"SpecificWaivers": [
{
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
]
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "4e744a721e8f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/classcodes/information/{states}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Provides a list of class codes in each state along with the firms and net rate for the class codes.",
"description": "This endpoint will provide you with a list of class codes in each state along with the firms and net rate for the class codes",
"operationId": "get-api-v1-specialty-program-classcodes-information-states",
"parameters": [
{
"name": "states",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "classcode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "50521080ae09",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b2351522d81e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetClassCodeWithFirmResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"ClassCodes": [
{
"State": "string",
"ClassCode": "string",
"Information": [
{
"DescriptionCode": "string",
"NaicsDescription": "string",
"NaicsCode": "string",
"SicCode": "string"
}
],
"AvailableFirms": [
{
"FirmId": 0,
"BaseRate": 0
}
]
}
],
"Firms": [
{
"FirmId": 0,
"FirmName": "string"
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/available-liability-limits": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the available liability limit options for the specialty program quote specified by the quote ID.",
"description": "Retrieves the available liability limit options for the quote specified by the quote ID",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-available-liability-limits",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "5fc401203d4f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "0e743a7d23eb",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
"string"
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/policies/{policyId}/dividends": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Provides details on dividends included on the policy.",
"description": "Provides details on dividends included on the policy.",
"operationId": "get-api-v1-policies-policyid-dividends",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6d6f03ea6134",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "990857b2adf7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDividentDetailsResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"PlanDescription": "string",
"ApprovedDate": "string",
"DivCalcDone": "string",
"DividendAmount": 0,
"DivWrittenPremium": 0,
"NetIncurred": 0,
"States": [
"string"
],
"ApprovedBy": "string",
"DisqualifyNotes": "string",
"DividentPercentage": 0,
"DivLossRatio": 0
}
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/classCodes": {
"put": {
"tags": [
"Workers Comp"
],
"summary": "Replaces the entire collection of current class codes on a quote with the class code collection supplied in the request body.\nIf existing class codes are excluded from the request, they will be removed from the quote.\nratingZip is only required if the class code is in the state of CA and the ratingZ",
"description": "Replaces the entire collection of current class codes on a quote with the class code collection supplied in the request body.
\r\n To add one or more class codes: include all current class codes including the class code(s) you wish to add.
\r\n To remove one or more class codes: include all class codes you wish to keep except for the class code(s) you wish to remove.
\r\n To replace one or more class codes: include, unchanged, all class codes you wish to keep as-is and replace class codes you wish to replace with replacement class codes.
\r\n If all current class codes on the quote are desired to remain, and additional class codes are needed, the existing class codes __must__ be included in the request body, along with the new class codes
\r\n __If existing class codes are excluded from request, they will be removed from the quote__
\r\n Multiple of the same class code and description code are not allowed in a single state quote
\r\n ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"operationId": "put-api-v2-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a306fbae9905",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "87beb8a9371e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassApiReturnModelV2"
},
"example": {
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "720dad614b2b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "a13a394487a4",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp"
],
"summary": "Saves additional class codes to a specified quote. The response will include any class codes already existing on the quote, as well as any added with this call.\nMultiples of the same class code and description code are not allowed in a single state quote.\nratingZip is only required if the class code",
"description": "Saves additional class codes to a specified quote.
\r\n The response will include any class codes already existing on the quote, as well as any added with this call.
\r\n Multiples of the same class code and description code are not allowed in a single state quote
\r\n ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"operationId": "post-api-v2-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "327b66e66a97",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9554ee5fe4ea",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassApiReturnModelV2"
},
"example": {
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "65c2892c7186",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "2bc0870da30d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/submitToUnderwriter": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Submit to underwriter",
"description": "This endpoint can be used to submit quotes to the underwriter.
\r\n This endpoint allows Managing General Agents (MGAs) to reserve accounts/block the market for quotes they want to proceed with.
\r\n Note that this endpoint is for #WC - Specialty Programs only.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-submittounderwriter",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SpecialtySubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SpecialtySubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SpecialtySubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SpecialtySubmitToUnderwriterModel"
},
"example": {
"NoteToUnderwriter": "string",
"AgentNeedByDate": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "7bbd06c084f2",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a19a1766ec14",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitToUnderwriterResponseModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"MasterAccountId": 0,
"SubmittedDate": "string",
"BusinessName": "string",
"QuoteInformation": {
"QuoteId": 0,
"Product": "string",
"EffectiveDate": "string",
"Premium": 0
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "1ac5f1123820",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "8f1a2589c67d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/voluntary-compensation": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Retrieves all voluntary compensation added at the quote level for a given policy.",
"description": "Retrieves all voluntary compensation added at the quote level.",
"operationId": "get-api-v1-policies-policy-voluntary-compensation",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2c67b6e574bc",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a3d8fbeee92e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"EndorsementNumber": "string",
"Description": "string",
"FormDataFields": [
{
"IndexId": 0,
"Label": "string",
"Required": true,
"CanEnterFreeText": true,
"CurrentValue": "string",
"PresetValues": [
"string"
]
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "34cfdc4ea5f9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/quotes/{quoteId}/underwriter-messages": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Send message to underwriter.",
"description": "The Reason available options:
\r\n __•__ Price
\r\n __•__ Waiver of Subrogation (WOS)
\r\n __•__ Form/Coverage Request (not WOS)
\r\n __•__ Dividend
\r\n __•__ Deductible
\r\n __•__ Class Code Verification
\r\n __•__ Other
",
"operationId": "post-api-v2-quotes-quoteid-underwriter-messages",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2dfa58fca1cc",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "42355348fa68",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4e11fe8cd97f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "d2c0d8cdfb83",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isOk": {
"type": "boolean"
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"responseId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"messageCode": {
"type": "string"
},
"isOk": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}
},
"maxMessageIndex": {
"type": "integer",
"format": "int32"
},
"_v": {
"type": "string"
}
}
},
"example": {
"isOk": true,
"httpStatusCode": 200,
"responseId": "bf30862e05fe",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"messages": [
{
"httpStatusCode": 200,
"messageCode": "SUCCESS",
"isOk": true,
"detail": "Your message has been successfully sent to the underwriter!"
}
],
"maxMessageIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/PaymentPlans": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves payment plans available for selection on the specified quote.\nIf mapping direct debit options, refer to the Save Direct Debit and Direct Debit Terms and Agreements endpoints.\nThis endpoint only saves payment plan information and does not process a payment.",
"description": "If you plan to map direct debit payment plan options, please refer to Save Direct Debit information and Direct Debit Terms and Agreements endpoint documentation. Please note that is endpoint only saves payment plan information and does not save information related to making a payment.",
"operationId": "get-api-v2-specialty-program-quotes-quoteid-paymentplans",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "99416eaf03bb",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "99243765496c",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "c4d3ddf262a6",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanResponseV2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Direct": [
{
"IsCurrentPaymentPlan": true,
"PaymentPlan": "0 = None",
"PaymentPlanDescription": "string",
"PaymentPlanId": 0,
"PayrollCompanyId": 0,
"NumberPayments": 0,
"TotalCost": 0,
"TotalPremium": 0,
"TotalStateTaxes": 0,
"TotalBillingFees": 0,
"DepositPercent": 0,
"DownPayment": 0,
"IsDirectDebit": true,
"Message": "string",
"Invoices": [
{
"PremiumAmount": 0,
"Taxes": 0,
"Fees": 0,
"TotalBillAmount": 0,
"BillDate": "string",
"DueDate": "string",
"IsDownPayment": true
}
]
}
],
"Agency": [
{
"IsCurrentPaymentPlan": true,
"PaymentPlan": "0 = None",
"PaymentPlanDescription": "string",
"PaymentPlanId": 0,
"PayrollCompanyId": 0,
"NumberPayments": 0,
"TotalCost": 0,
"TotalPremium": 0,
"TotalStateTaxes": 0,
"TotalBillingFees": 0,
"DepositPercent": 0,
"DownPayment": 0,
"IsDirectDebit": true,
"Message": "string",
"Invoices": [
{
"PremiumAmount": 0,
"Taxes": 0,
"Fees": 0,
"TotalBillAmount": 0,
"BillDate": "string",
"DueDate": "string",
"IsDownPayment": true
}
]
}
]
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/affirmation": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the affirmation statement that will need to be displayed to agents prior to binding the quote to a policy.\nThis can be called in conjunction with the V2 Bind endpoint; the actual submission of affirmation will occur in the V2 Quote Bind endpoint.\nIf you are already presenting a statement o",
"description": "Retrieves the affirmation statement that will need to be displayed to agents prior to binding the quote to a policy
\r\n This can be called in conjunction with the V2 Bind endpoint; the actual submission of affirmation will occur in the V2 Quote Bind endpoint.
\r\n __Please note:__ If you are already presenting a statement of affirmation to your agents/users, you do not need to use this endpoint. This is only for partners who do not currently have their own statement in place",
"operationId": "get-api-v1-specialty-program-affirmation",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "821a5b8c6042",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "90e083d6cbb3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
}
}
}
},
"/api/v1/specialty-program/contacts/agents": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves agent information associated with an email address passed in the query string.\nThis endpoint is only available to agencies granted permission.",
"description": "Retrieves agent information associated with an email address passed in the query string.
\r\n __Note:__ This endpoint is only available to agencies granted permission.",
"operationId": "get-api-v1-specialty-program-contacts-agents",
"parameters": [
{
"name": "emailAddress",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f16b4a7a1774",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "50c05d7d3d78",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentInfoReturnModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"AgentId": 0,
"AgentName": "string"
}
]
}
}
}
}
}
}
},
"/api/v2/specialty-program/fein/validation": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Optional but recommended endpoint to determine a FEIN's availability for use on a quote.",
"description": "This endpoint is optional, but recommended, and can be used to determine a FEIN's availability for use on a quote.",
"operationId": "post-api-v2-specialty-program-fein-validation",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FeinPostModel"
},
"example": {
"Fein": "string",
"QuoteId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "027527a08a94",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "afb691f9326b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": true
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "fd33a3bd895e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "6e88df1fe0fb",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/payment-plans/payroll-companies": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all payroll companies currently available to the agency associated with the current authentication token.",
"description": "Retrieves all payroll companies currently available to the agency associated with the current authentication token.",
"operationId": "get-api-v1-specialty-program-payment-plans-payroll-companies",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "17e9330109a3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "ea2fd790549b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentPayrollCompaniesResponseIListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PayrollCompanyId": 0,
"PayrollCompanyName": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Returns basic policy information on the requested policy number.",
"description": "Returns basic policy information on requested policy number.",
"operationId": "get-api-v1-specialty-program-policies-policy",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "83df077fca0f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1eedfffd245f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyInformationResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"MasterAccountId": 0,
"Policy": "string",
"PolicyId": 0,
"Quote": "string",
"Premium": "string",
"DBA": "string",
"BusinessName": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"Fein": "string",
"EffectiveDate": "string",
"ExpirationDate": "string",
"InsuredContact": {
"Name": "string",
"Phone": "string",
"Email": "string"
},
"LegalEntity": "string",
"PolicyStatus": "string",
"StateTaxes": 0,
"EstimatedAnnual": 0,
"EarnedPremium": "string",
"RatingZip": "string",
"CancelInformation": {
"CancelDate": "string",
"CancelReason": "string",
"ShortRate": true
},
"CompanyWebsite": "string",
"CarrierName": "string",
"ClassCodes": [
{
"ClassCode": "string",
"DescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FTEmployees": 0,
"PTEmployees": 0,
"Rate": 0,
"Premium": 0
}
],
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"OfficerDOB": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"StopGapCoverages": [
{
"CoverageName": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"Partners": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
],
"Limits": [
{
"LiabilityLimits": {
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
}
}
],
"AdditionalInsureds": [
{
"Id": 0,
"NamedInsuredId": 0,
"Name": "string",
"Dba": "string",
"Fein": "string",
"LegalEntity": 0,
"UnemploymentNumber": "string",
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0
}
],
"PrimaryInsuredAdditionalLocations": [
{
"LocationNumber": 0,
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0
}
],
"AdditionalLocations": [
{
"LocationNumber": 0,
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"EmployeeCount": 0,
"NameInsured": "string"
}
],
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"SpecificWaivers": [
{
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
],
"NonRenewalDate": "string",
"NonRenewalReason": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "507423c1c03b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}/available-documents": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a list of all available policy documents currently available for viewing under the given policy number.",
"description": "Retrieves a list of all available policy documents that are currently available for viewing under the given policy number.",
"operationId": "get-api-v1-specialty-program-policies-policy-available-documents",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2ced14a88e07",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "0a8dcd6d3b38",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDocumentIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"DocumentName": "string",
"FileType": "string",
"DocumentType": "string",
"LibraryIndex": 0,
"DateReceived": "string",
"EndmtNum": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "557b97c63953",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}/documents": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a specified policy document type in raw data (application-octet stream).\nAvailable file types can be retrieved via the List of All Available Policy Documents endpoint.",
"description": "Retrieves a specified policy's document type, displaying in raw data (application-octet stream). The headers will also contain a FileName and a DisplayName.
\r\n Available file types can be retrieved via the List of All Available Policy Documents endpoint.",
"operationId": "get-api-v1-specialty-program-policies-policy-documents",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3f0fddcdc104",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "3f0fddcdc104",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "675f9ddc085a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "675f9ddc085a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
},
"example": "string"
}
}
},
"404": {
"description": "Not found",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5b2a614d16f6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5b2a614d16f6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}/documents/{fileType}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a specified policy document type by file type in raw data (application-octet stream).\nAvailable file types can be retrieved via the List of All Available Policy Documents endpoint.",
"description": "Retrieves a specified policy's document type, displaying in raw data (application-octet stream). The headers will also contain a FileName and a DisplayName.
\r\n Available file types can be retrieved via the List of All Available Policy Documents endpoint:
\r\n (GET /api/v1/policies/{policy}/available-documents)",
"operationId": "get-api-v1-specialty-program-policies-policy-documents-filetype",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "libraryIndex",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "89a2e868e733",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "16f7b9ddcb44",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ByteArrayBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "d1766dada0f6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/policies/{policy}/endorsement-eligibility": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a list of all endorsements the given policy is eligible for.",
"description": "Retrieves a list of all endorsements the given policy is eligible for.",
"operationId": "get-api-v2-specialty-program-policies-policy-endorsement-eligibility",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ced5ff4101ab",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8543532b94c5",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndorsementEligibilityResponseVer2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EndorsementType": [
"string"
],
"IneligibilityReason": [
"string"
],
"CurrentPartners": [
{
"FirstName": "string",
"LastName": "string",
"Id": 0
}
],
"SubChangeReasons": [
{
"EndmtSubType": "string",
"EndmtChangeReason": "string",
"EndmtChangeReasonId": 0
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "984fcf75ab01",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v3/specialty-program/policies/{policy}/endorsements": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves the selected policy endorsement. Supports insured-name-update, insured-mailing-address-update,\ninsured-fein-change, partners-update, cancellation, and insured-primary-address-update.",
"description": "The full list of potential endorsements based on the policy are
\r\n • 'insured-name-update'
\r\n • 'insured-mailing-address-update'
\r\n • 'insured-fein-change'
\r\n • 'partners-update'
\r\n • 'cancellation'
\r\n • 'insured-primary-address-update'
\r\n • 'additional-insureds-update'
\r\n • 'exposure-update'
\r\n • 'officers-update'
\r\n • 'legal-entity-update'
\r\n • 'agent-other-request'
\r\n • 'blanket-waiver-change'
\r\n • 'specific-waivers-change'
\r\n • 'liability-limits-update'
\r\n Cancellation endorsement fields
\r\n Required fields
\r\n PrimaryReason
\r\n SecondaryReason
\r\n DisplayName
\r\n WindowsFileType
\r\n FileData
\r\n Optional Fields
\r\n NewCancellationDate - Is required if flatCancel is false
\r\n Carrier
\r\n Details
\r\n NewInsuredEmailAddress
\r\n EmailAddress
\r\n NewMailingAddress
\r\n flatCancel
\r\n shortRate
\r\n Line1
\r\n Line2
\r\n City
\r\n State
\r\n Zip
\r\n StillIncumbentAgent
\r\n SetAsPrimaryAddress
\r\n NewBillingAddress
\r\n Note: Cancellations can only be committed within its own endorsement request, separate from other endorsements.
\r\n Primary Address Change endorsement fields
\r\n Required fields
\r\n Line1
\r\n City
\r\n State
\r\n ZipCode
\r\n UpdateMailingAddress
\r\n Optional Fields
\r\n Line2
\r\n UpdateBillingAddress - This is needed if UpdateMailingAddress is TRUE
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n Additional Insureds Update endorsement fields
\r\n PrimaryInsuredAdditionalLocations
\r\n Required fields
\r\n AddressLine1
\r\n City
\r\n State
\r\n ZipCode
\r\n Optional Fields
\r\n Id
\r\n AddressLine2
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n AdditionalInsureds
\r\n Required fields
\r\n FirstName
\r\n LastName
\r\n State
\r\n TaxId
\r\n LegalEntity
\r\n Locations
\r\n Optional Fields
\r\n Id
\r\n DbaName
\r\n UnemploymentId
\r\n AdditionalInsureds Locations
\r\n Required fields
\r\n AddressLine1
\r\n City
\r\n State
\r\n ZipCode
\r\n EmployeeCount
\r\n Optional Fields
\r\n Id
\r\n AddressLine2
\r\n Exposure Update endorsement fields
\r\n Required fields
\r\n State
\r\n ClassCode
\r\n DescriptionCode
\r\n FullTimeEmployees
\r\n PartTimeEmployees
\r\n Payroll
\r\n Optional Fields
\r\n Notes, DisplayName, WindowsFileType and FileData - Those are required only if the payroll changes by more than 40%, including a 40% decrease.
\r\n officers Update endorsement fields
\r\n Required fields
\r\n OfficerName
\r\n Type
\r\n State
\r\n FormType
\r\n EndorsementId
\r\n OwnershipPercentage
\r\n Optional Fields
\r\n Id - Is required only for update
\r\n Legal Entity Update endorsement fields
\r\n Required fields
\r\n LegalEntityCode
\r\n Optional Fields
\r\n Notes
\r\n DisplayName, WindowsFileType, FileData - All three fields should be entered together
\r\n Inspection contact information fields
\r\n Required fields
\r\n FirstName
\r\n LastName
\r\n Phone
\r\n Optional Fields
\r\n Email
\r\n Agent Other endorsement fields
\r\n Required fields
\r\n Notes
\r\n Optional Fields
\r\n DisplayName, WindowsFileType, FileData - All three fields should be entered together
\r\n EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT.
\r\n Blanket Waiver Change endorsement fields
\r\n Required fields
\r\n RemoveWaiver - True = remove waiver, False = add waiver
\r\n Specific Waivers Change endorsement fields
\r\n Required fields
\r\n Id
\r\n StartDate
\r\n EndDate
\r\n State
\r\n FirstName
\r\n LastName
\r\n Line1
\r\n Line2
\r\n City
\r\n State
\r\n Zip
\r\n JobDescription
\r\n Payroll
\r\n ClassCode
\r\n Delete - True = remove waiver, False = add waiver
\r\n Specific Liability Limits update endorsement fields
\r\n Required fields
\r\n LiabilityLimits
\r\n ChangeReason
",
"operationId": "post-api-v3-specialty-program-policies-policy-endorsements",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Cancellation": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryReason": "Insured Request",
"SecondaryReason": "Price",
"Carrier": "Westfield Group",
"Details": "1-5%",
"NewInsuredEmailAddress": true,
"FlatCancel": true,
"ShortRate": false,
"SetAsPrimaryAddress": false,
"NewBillingAddress": false,
"EmailAddress": "aa@mail.com",
"NewMailingAddress": true,
"Line1": "1234 Main St",
"Line2": null,
"City": "Los Angeles",
"State": "CA",
"Zip": "90210",
"StillIncumbentAgent": true,
"NewCancellationDate": "2025-11-29",
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh"
}
],
"Type": "cancellation",
"Reason": null
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": [
{
"Id": 1,
"FirstName": "John",
"LastName": "Doe",
"DbaName": "Doe Enterprises",
"TaxId": "123456789",
"State": "CA",
"LegalEntity": 1,
"UnemploymentId": "UI12345",
"Locations": [
{
"Id": 2,
"AddressLine1": "500 Main St",
"AddressLine2": "Suite 100",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90001",
"NoSpecificLocation": false,
"EmployeeCount": 5
}
]
}
]
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"liability-limits-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-09-12T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"LiabilityLimits": "100/500/100",
"ChangeReason": 23
}
],
"Type": "liability-limits-update",
"Reason": "Data Correction"
}
]
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Cancellation": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryReason": "Insured Request",
"SecondaryReason": "Price",
"Carrier": "Westfield Group",
"Details": "1-5%",
"NewInsuredEmailAddress": true,
"FlatCancel": true,
"ShortRate": false,
"SetAsPrimaryAddress": false,
"NewBillingAddress": false,
"EmailAddress": "aa@mail.com",
"NewMailingAddress": true,
"Line1": "1234 Main St",
"Line2": null,
"City": "Los Angeles",
"State": "CA",
"Zip": "90210",
"StillIncumbentAgent": true,
"NewCancellationDate": "2025-11-29",
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh"
}
],
"Type": "cancellation",
"Reason": null
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": [
{
"Id": 1,
"FirstName": "John",
"LastName": "Doe",
"DbaName": "Doe Enterprises",
"TaxId": "123456789",
"State": "CA",
"LegalEntity": 1,
"UnemploymentId": "UI12345",
"Locations": [
{
"Id": 2,
"AddressLine1": "500 Main St",
"AddressLine2": "Suite 100",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90001",
"NoSpecificLocation": false,
"EmployeeCount": 5
}
]
}
]
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"liability-limits-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-09-12T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"LiabilityLimits": "100/500/100",
"ChangeReason": 23
}
],
"Type": "liability-limits-update",
"Reason": "Data Correction"
}
]
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Cancellation": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryReason": "Insured Request",
"SecondaryReason": "Price",
"Carrier": "Westfield Group",
"Details": "1-5%",
"NewInsuredEmailAddress": true,
"FlatCancel": true,
"ShortRate": false,
"SetAsPrimaryAddress": false,
"NewBillingAddress": false,
"EmailAddress": "aa@mail.com",
"NewMailingAddress": true,
"Line1": "1234 Main St",
"Line2": null,
"City": "Los Angeles",
"State": "CA",
"Zip": "90210",
"StillIncumbentAgent": true,
"NewCancellationDate": "2025-11-29",
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh"
}
],
"Type": "cancellation",
"Reason": null
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": [
{
"Id": 1,
"FirstName": "John",
"LastName": "Doe",
"DbaName": "Doe Enterprises",
"TaxId": "123456789",
"State": "CA",
"LegalEntity": 1,
"UnemploymentId": "UI12345",
"Locations": [
{
"Id": 2,
"AddressLine1": "500 Main St",
"AddressLine2": "Suite 100",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90001",
"NoSpecificLocation": false,
"EmployeeCount": 5
}
]
}
]
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"liability-limits-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-09-12T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"LiabilityLimits": "100/500/100",
"ChangeReason": 23
}
],
"Type": "liability-limits-update",
"Reason": "Data Correction"
}
]
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostPolicyEndorsementModelV3"
},
"examples": {
"Insured Name Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Name": "Name",
"DBA": "dba"
}
],
"Type": "insured-name-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Mailing Address Update": {
"value": {
"AgentContactId": 123,
"EffectiveDate": "2025-05-20T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "7501 Saint Cecelia St",
"Line2": null,
"City": "Austin",
"State": "TX",
"Zip": "78757"
}
],
"Type": "insured-mailing-address-update",
"Reason": "Change in Entity"
}
]
}
},
"Insured Fein Change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Fein": "987654321"
}
],
"Type": "insured-fein-change",
"Reason": "Correction"
}
]
}
},
"Partners Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PartnerId": 1,
"FirstName": "Jane",
"LastName": "Woods",
"Organization": "Stark Industries"
}
],
"Type": "partners-update",
"Reason": "Correction"
}
]
}
},
"Cancellation": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryReason": "Insured Request",
"SecondaryReason": "Price",
"Carrier": "Westfield Group",
"Details": "1-5%",
"NewInsuredEmailAddress": true,
"FlatCancel": true,
"ShortRate": false,
"SetAsPrimaryAddress": false,
"NewBillingAddress": false,
"EmailAddress": "aa@mail.com",
"NewMailingAddress": true,
"Line1": "1234 Main St",
"Line2": null,
"City": "Los Angeles",
"State": "CA",
"Zip": "90210",
"StillIncumbentAgent": true,
"NewCancellationDate": "2025-11-29",
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh"
}
],
"Type": "cancellation",
"Reason": null
}
]
}
},
"Insured Primary Address Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Line1": "1700 E Bayshore Rd",
"Line2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"EmployeeCount": 18,
"UpdateMailingAddress": "false",
"UpdateBillingAddress": "true"
}
],
"Type": "insured-primary-address-update",
"Reason": null
}
]
}
},
"Additional Insureds Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"PrimaryInsuredAdditionalLocations": [
{
"Id": 1,
"AddressLine1": "1700 E Bayshore Rd",
"AddressLine2": "17",
"City": "East Palo Alto",
"State": "CA",
"ZipCode": "94303",
"NoSpecificLocation": false,
"EmployeeCount": 18
}
],
"AdditionalInsureds": [
{
"Id": 1,
"FirstName": "John",
"LastName": "Doe",
"DbaName": "Doe Enterprises",
"TaxId": "123456789",
"State": "CA",
"LegalEntity": 1,
"UnemploymentId": "UI12345",
"Locations": [
{
"Id": 2,
"AddressLine1": "500 Main St",
"AddressLine2": "Suite 100",
"City": "Los Angeles",
"State": "CA",
"ZipCode": "90001",
"NoSpecificLocation": false,
"EmployeeCount": 5
}
]
}
]
}
],
"Type": "additional-insureds-update",
"Reason": "Change in Ownership"
}
]
}
},
"Exposure Update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Exposures": [
{
"State": "TX",
"DescriptionCode": "00",
"FullTimeEmployees": "2",
"PartTimeEmployees": "1",
"Payroll": "650000",
"ClassCode": "0005"
}
],
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null
}
],
"Type": "exposure-update",
"Reason": "Added Staff"
}
]
}
},
"officers-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": null,
"OfficerName": "John Smith",
"Type": "SoleProprietor",
"State": "AL",
"FormType": "E",
"EndorsementId": "WC000308",
"OwnershipPercentage": "12"
}
],
"Type": "officers-update",
"Reason": null
}
]
}
},
"legal-entity-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": null,
"LegalEntityCode": "4"
}
],
"Type": "legal-entity-update",
"Reason": "Change in Ownership"
}
]
}
},
"agent-other-request": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T11:08:12.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"DisplayName": "myDoc",
"WindowsFileType": "pdf",
"FileData": "RmlsZSBEYXRh",
"Notes": "notes"
}
],
"Type": "agent-other-request",
"Reason": null
}
]
}
},
"blanket-waiver-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-08-13T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"RemoveWaiver": false
}
],
"Type": "blanket-waiver-change",
"Reason": null
}
]
}
},
"specific-waivers-change": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2025-06-15T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"Id": "1",
"StartDate": "2026-08-13",
"EndDate": "2026-09-02",
"State": "AK",
"FirstName": "John",
"LastName": "Doe",
"Line1": "123 Main St",
"Line2": "Suite 100",
"City": "Anchorage",
"Zip": "99501",
"JobDescription": "Carpentry",
"Payroll": 50000,
"ClassCode": "0005",
"Delete": "false"
}
],
"Type": "specific-waivers-change",
"Reason": null
}
]
}
},
"liability-limits-update": {
"value": {
"AgentContactId": 456,
"EffectiveDate": "2026-09-12T12:00:00.0000000+00:00",
"PolicyEndorsements": [
{
"Endorsements": [
{
"LiabilityLimits": "100/500/100",
"ChangeReason": 23
}
],
"Type": "liability-limits-update",
"Reason": "Data Correction"
}
]
}
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d78802dac5cb",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4278c305f54a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyEndorsementBulkResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"Reason": "Change in Ownership",
"Type": null,
"Endorsements": null
},
{
"Reason": "Data Correction",
"Type": null,
"Endorsements": null
},
{
"Reason": "Change in Entity",
"Type": null,
"Endorsements": null
}
],
"StatusCode": 0,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "345b0ff5522e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "89fc2244a8f0",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/policies/{policy}/PaymentPlans/DirectDebit": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves bank account information for direct debit payments on a policy.",
"description": "Allows user to save their bank account information for direct debit payments",
"operationId": "post-api-v2-specialty-program-policies-policy-paymentplans-directdebit",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitRequest"
},
"example": {
"NameOnAccount": "Business Bank Account",
"AccountNumber": "123456789012",
"RoutingNumber": "987654321",
"Email": "business@email.com",
"AccountType": 1
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "74df81822006",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "fd9d6739acc0",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "dda4dcc19a41",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDirectDebitResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"NameOnAccount": "string",
"AccountNumber": "string",
"RoutingNumber": "string",
"Email": "string",
"AccountType": "1 = Checking",
"BankName": "string"
}
}
}
}
}
}
}
},
"/api/v2/specialty-program/policies/{policy}/PaymentPlans/DirectDebit/Documents": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Allows user to upload the EFT form and/or voided check necessary to use direct debit as a payment plan.",
"description": "Allows user to upload the EFT form and/or the voided check necessary to use direct debit as a payment plan",
"operationId": "post-api-v2-specialty-program-policies-policy-paymentplans-directdebit-docum",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "5aed31411fed",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "a52f95c0d175",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "da91a6da5ef5",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"LibraryId": 0
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}/renewal": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the renewal policy number and information, if available, based on the expired policy number given.",
"description": "Retrieves the renewal policy number and information, if available, based on the expired policy number given.",
"operationId": "get-api-v1-specialty-program-policies-policy-renewal",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "7c6bc028b388",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "49b8b89d16db",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyRenewalResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"RenewalPolicyNumber": "string",
"TotalEstimatedAnnualPremium": 0,
"TotalStateAssessment": 0,
"ClassCodes": [
{
"State": "string",
"ClassCode": "string",
"ClassCodeDescription": "string",
"ExposureLimit": "string",
"Rate": 0
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "75d3ae3fd41d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policy}/voluntary-compensation": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all voluntary compensation added at the quote level for a given policy.",
"description": "Retrieves all voluntary compensation added at the quote level.",
"operationId": "get-api-v1-specialty-program-policies-policy-voluntary-compensation",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d37a22ea398b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f314b7352ae1",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"EndorsementNumber": "string",
"Description": "string",
"FormDataFields": [
{
"IndexId": 0,
"Label": "string",
"Required": true,
"CanEnterFreeText": true,
"CurrentValue": "string",
"PresetValues": [
"string"
]
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "510ba14980e9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/balance-summary": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the current balance on a policy.\nIf CanMakePayment is false, the current balance will reflect $0.00.",
"description": "Retrieve the current balance on a policy.
\r\n __If \"CanMakePayment\" is false, the current balance will reflect $0.00 Policy.__",
"operationId": "get-api-v1-specialty-program-policies-policyid-balance-summary",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "4ca1228e6488",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "1e0954f578e3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceSummaryResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"QuoteId": 0,
"PolicyId": 0,
"CurrentDueAmount": 0,
"RemainingDueAmount": 0,
"CanMakePayment": true
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "67c44ab41844",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/dividends": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Provides details on dividends included on the policy.",
"description": "Provides details on dividends included on the policy.",
"operationId": "get-api-v1-specialty-program-policies-policyid-dividends",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a5ffa5e3589a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f972c22c3dcf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicyDividentDetailsResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"PlanDescription": "string",
"ApprovedDate": "string",
"DivCalcDone": "string",
"DividendAmount": 0,
"DivWrittenPremium": 0,
"NetIncurred": 0,
"States": [
"string"
],
"ApprovedBy": "string",
"DisqualifyNotes": "string",
"DividentPercentage": 0,
"DivLossRatio": 0
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/payment": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Makes a payment on the policy. Payment sent must equal the current amount due.\nThe Balance Summary endpoint can be used to retrieve the current balance on the policy.\nPayment may take up to 24 hours to reflect on the account.",
"description": "This endpoint is used to make a payment on the policy.
\r\n The Balance Summary endpoint can be used to retrieve the current balance on the policy.
\r\n Payment sent must be equal to the current amount due.
\r\n __Please note:__ Payment may take up to 24 hours to reflect on the account",
"operationId": "post-api-v1-specialty-program-policies-policyid-payment",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPostModel"
},
"example": {
"QuoteId": 0,
"SendEmail": true,
"PayerInfo": {
"FirstName": "string",
"LastName": "string",
"Address": {
"Line1": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Line2": "string",
"Country": "225 = US",
"CountryName": "string"
},
"EmailAddress": "string",
"Phone": "string"
},
"ECheck": {
"AccountNumber": "string",
"RoutingNumber": "string",
"FinancialInstitution": "string",
"AccountType": "1 = Checking"
},
"CreditCard": {
"CreditCardNumber": "string",
"CardType": "0 = Visa",
"CVV": "string",
"ExpirationMonth": 0,
"ExpirationYear": 0
},
"PaymentSystemInfo": {
"Id": 0,
"Name": "string",
"LOB": "string",
"Type": "string",
"PayrollMonth": "string",
"Amount": {
"Currency": "string",
"Total": 0
},
"TaxAmount": {
"Currency": "string",
"Total": 0
},
"FeeAmount": {
"Currency": "string",
"Total": 0
},
"PaymentDescription": "string"
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "0c2bb2ff2bfd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "6f00245f6d5a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"AmountProccessed": 0,
"RemainingPolicyPayment": 0,
"TransactionId": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "038d7ffe9df7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "cac7c6ba4432",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policy/{policyId}/netRate": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves net rate information on a PAYO or PSR policy.",
"description": "Retrieves net rate information on a PAYO or PSR policy.",
"operationId": "get-api-v1-specialty-program-policy-policyid-netrate",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6b0b8e4080ad",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b93a84b41cf2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetRateResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassDescription": "string",
"NetRate": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "8df3221561c4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/print/{quoteId}": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a byte representation of the quote proposal in PDF format.",
"description": "Retrieves a byte representation of the quote proposal in PDF format.",
"operationId": "post-api-v1-specialty-program-print-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "50b787f4372c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c3e5d1010777",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "byte"
},
"example": "string"
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "6ce836fea251",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quote/{quoteId}/netRate": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves net rate information on a PAYO or PSR quote.",
"description": "Retrieves net rate information on a PAYO or PSR quote.",
"operationId": "get-api-v1-specialty-program-quote-quoteid-netrate",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e2ff0ce964ba",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "44810e852fa9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetRateResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCode": "string",
"ClassDescription": "string",
"NetRate": 0
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "454a6a98f587",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Creates a specialty program quote (V2). Only use this endpoint if specifically directed to; it is for Specialty Programs.",
"description": "Create a quote.
\r\n __•__ If you have not specifically been told to use this endpoint, please do not map. This is for Specialty Programs",
"operationId": "post-api-v2-specialty-program-quotes",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModelV2"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
}
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"ExperienceModifier": {
"State": "string",
"Modifiers": {}
},
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"DigitalClientWorkflow": "string",
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModelV2"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
}
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"ExperienceModifier": {
"State": "string",
"Modifiers": {}
},
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"DigitalClientWorkflow": "string",
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModelV2"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
}
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"ExperienceModifier": {
"State": "string",
"Modifiers": {}
},
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"DigitalClientWorkflow": "string",
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyPostModelV2"
},
"example": {
"Quote": {
"MasterAccountId": 0,
"BillType": "0 = A",
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": 0,
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string",
"UnemploymentId": "string",
"PayrollCompanyId": 0,
"LiabilityLimits": "string",
"FirmId": "string",
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
}
},
"LoadQuestions": true,
"Questions": [
{
"QuestionId": 0,
"AnswerValue": "string"
}
],
"ExperienceModifier": {
"State": "string",
"Modifiers": {}
},
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
],
"DigitalClientWorkflow": "string",
"LoadRateSummary": true,
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b6e5e21599dd",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8745efa64855",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuoteSpecialtyReturnModelV2BaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"EffectiveDate": "string",
"ExpirationDate": "string",
"Fein": "string",
"PrimaryAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"MailingAddress": {
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
},
"BusinessName": "string",
"DBA": "string",
"ContactInformation": {
"FirstName": "string",
"LastName": "string",
"Email": "string",
"Phone": "string",
"AgentContactId": 0,
"AgentContactName": "string"
},
"NatureOfBusiness": "string",
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": 0,
"IsNonProfit": true,
"IsIncumbentAgent": true,
"CompanyWebsiteAddress": "string",
"RatingZip": "string",
"PayrollCompanyId": 0,
"UnemploymentId": "string",
"AccountInformation": {
"QuoteId": 0,
"MasterAccountId": 0,
"GoverningState": "string",
"Status": "string",
"AccountUrl": "string",
"Carrier": "string"
},
"PremiumDetails": {
"PriceIndication": 0,
"StateTaxes": 0,
"LimitPerAccident": 0,
"BodilyInjuryFromDiseasePolicyLimit": 0,
"BodilyInjuryFromDiseasePerEmployeeLimit": 0,
"LiabilityLimits": "string"
},
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
},
"Questions": [
{
"Id": 0,
"Question": "string",
"QuestionType": "string",
"DropdownOptions": [
{
"Key": "string",
"Text": "string"
}
],
"ParentQuestionId": 0,
"ParentAnswerToShow": "string",
"Answer": "string"
}
],
"FirmId": "string",
"ExperienceModifier": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"DigitalClientWorkflow": "string",
"SpousesNames": {
"Spouse1": "string",
"Spouse2": "string"
},
"AdditionalCoverages": [
{
"Coverage": "string",
"State": "string",
"Limit": "string",
"Period": "string",
"AnnualPayroll": "string"
}
],
"Modifiers": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
],
"RatingSummary": [
{
"GovState": "string",
"ModelType": "string",
"ItemType": "string",
"ClassCode": "string",
"Description": "string",
"Premium": 0,
"Year": 0,
"Rate": 0,
"Exposure": 0
}
],
"PricingTiers": [
{
"TierId": 0,
"State": "string"
}
]
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "49b4916e71b0",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all currently saved information on a specified specialty program quote, including class codes, addresses, eligibility, and price indication.",
"description": "Retrieves all currently saved information on a specified quote, including (but not limited to) class codes, mailing/primary addresses, current eligibility, price indication, etc…",
"operationId": "get-api-v2-specialty-program-quotes-quoteid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "loadQuestions",
"in": "query",
"description": "Set to \"true\" to return all questions associated with the created quote",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "loadRateSummary",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f5bb08d00d7d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "4dee64a51e56",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetQuoteSpecialtyReturnModelV2BaseResponse"
},
"example": {
"Data": {
"Dividends": null,
"AdditionalInformation": null,
"QuoteStatus": null,
"ForeignVoluntaryCoverage": null,
"SpecificWaivers": null,
"EffectiveDate": null,
"Fein": null,
"PrimaryAddress": null,
"MailingAddress": null,
"BusinessName": null,
"DBA": null,
"ContactInformation": null,
"NatureOfBusiness": null,
"LegalEntity": 0,
"YearsInBusiness": 0,
"ExpiredPremium": null,
"IsNonProfit": null,
"CompanyWebsiteAddress": null,
"RatingZip": null,
"PayrollCompanyId": null,
"UnemploymentId": null,
"AccountInformation": null,
"PremiumDetails": null,
"ClassCodes": null,
"Eligibility": {
"Eligibility": null,
"Details": []
},
"Questions": null,
"Modifiers": null,
"RatingSummary": [],
"PricingTiers": []
},
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/additional-information": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves additional locations, additional insureds, and/or officers to the specialty program quote.\nIf a quote is in the state of Nebraska and is a non-profit corporation the annual compensation for the officer is required.\nIf the annual compensation is equal or less than 1,000 the Officer will be save",
"description": "If a quote is in the state of Nebraska and is a non-profit corporation the annual compensation for the officer is required. \r\nIf the annual compensation is equal or less than 1,000 the Officer will be saved. \r\nIf the annual compensation is equal or greater than 1,001 the officer will not be saved. \r\n\r\n**NOTE:** \r\n'TotalEmployeeNumber' is a required field if in the state of CA.",
"operationId": "post-api-v2-specialty-program-quotes-quoteid-additional-information",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoPostModelV2"
},
"example": {
"Officers": [
{
"Name": "string",
"EndorsementId": "string",
"Type": "1 = Officers",
"State": "string",
"OfficeHeld": "string",
"OwnershipPercent": 0,
"FormType": "0 = I",
"DateOfBirth": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"UnemploymentId": "string",
"DbaName": "string",
"AdditionalLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "8280a74f1989",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5d693d633d58",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdditionalInfoReturnModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Officers": [
{
"Id": 0,
"Name": "string",
"EndorsementId": "string",
"Type": "string",
"State": "string",
"OwnershipPercent": 0,
"FormType": "string",
"DateOfBirth": "string",
"OfficeHeld": "string",
"AnnualCompensation": 0
}
],
"AdditionalInsureds": [
{
"Id": 0,
"Name": "string",
"TaxId": "string",
"State": "string",
"LegalEntity": 0,
"DbaName": "string",
"UnemploymentId": "string",
"AdditionalLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
]
}
],
"AdditionalPrimaryInsuredLocations": [
{
"Id": 0,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string",
"TotalEmployeeNumber": 0,
"NoSpecificLocation": true
}
],
"ThirdPartyNotices": [
{
"IndexId": 0,
"FirstName": "string",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/additionalInformation/insured-locations": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Deletes a specified insured location record, by location ID and address, from the quote specified by the URI parameter quoteId.",
"description": "Deletes a specified insured location record, by location ID and address, from the quote specified by the URI parameter quoteId.",
"operationId": "delete-api-v2-specialty-program-quotes-quoteid-additionalinformation-insured",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/DeleteLocationModel"
},
"example": {
"LocationId": 1,
"AddressLine1": "617 W Haiti Ave"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "9f1a9844c192",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "70bb581ece29",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "92cd29d88f61",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/additionalInformation/officers/{id}": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Deletes an officer record specified by ID from the quote specified by the URI parameter quoteId.",
"description": "Deletes an officer record specified by ID from the quote specified by the URI parameter __quoteId.__",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-additionalinformation-officer",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e58981269c88",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5cffbe15c161",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "fbe0477915e5",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/agent-contact": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the agent contact information for the quote specified by the URI parameter quoteId.",
"description": "Retrieves the agent contact information for the quote specified by the URI parameter __quoteId__",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-agent-contact",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "96d1a396b857",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "68e08bd96396",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentContactBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Id": "string",
"FullName": "string",
"Email": "string",
"AgentId": 0
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "a55bf53ffdb9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/available-class-codes": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves a list of all class codes that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves a list of all class codes that can be added to the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-available-class-codes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "88e159f4704a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f9422b6e5534",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateClassCodesResponseListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"ClassDescription": "string"
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "c24ec3b3e528",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/available-officer-types": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all officer types that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves all officer types that can be added to the quote specified by the URI parameter __quoteId__",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-available-officer-types",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a9074e9ac634",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9349d292f22b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
"string"
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "c134d1a94e1b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/classCodes": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all class codes currently saved on the specified quote.",
"description": "Retrieves all class codes currently saved on the specified quote.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d6a511263f9b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "85d8087fef93",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseClassCodeModelListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"OriginalClassCode": "string",
"OriginalDesc": "string",
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0,
"IsDeleted": true,
"ClassRate": 0,
"Description": "string",
"Premium": 0,
"Exposure": 0,
"IsSplitRate": true
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4d5d5da2d7e8",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/classCodes": {
"put": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Replaces the entire collection of current class codes on a quote with the class code collection supplied in the request body.\nIf existing class codes are excluded from the request, they will be removed from the quote.\nratingZip is only required if the class code is in the state of CA and the ratingZ",
"description": "Replaces the entire collection of current class codes on a quote with the class code collection supplied in the request body.
\r\n To add one or more class codes: include all current class codes including the class code(s) you wish to add.
\r\n To remove one or more class codes: include all class codes you wish to keep except for the class code(s) you wish to remove.
\r\n To replace one or more class codes: include, unchanged, all class codes you wish to keep as-is and replace class codes you wish to replace with replacement class codes.
\r\n If all current class codes on the quote are desired to remain, and additional class codes are needed, the existing class codes __must__ be included in the request body, along with the new class codes
\r\n __If existing class codes are excluded from request, they will be removed from the quote__
\r\n Multiple of the same class code and description code are not allowed in a single state quote
\r\n ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"operationId": "put-api-v2-specialty-program-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ClassPutModelV2"
},
"example": {
"ClassCodes": [
{
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "9842289dc24e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "eac58c23688b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassApiReturnModelV2"
},
"example": {
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "59d936589f6f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "4ce2b7862b1b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves additional class codes to a specified quote. The response will include any class codes already existing on the quote, as well as any added with this call.\nMultiples of the same class code and description code are not allowed in a single state quote.\nratingZip is only required if the class code",
"description": "Saves additional class codes to a specified quote.
\r\n The response will include any class codes already existing on the quote, as well as any added with this call.
\r\n Multiples of the same class code and description code are not allowed in a single state quote
\r\n ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"operationId": "post-api-v2-specialty-program-quotes-quoteid-classcodes",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ClassCodePostModel"
},
"example": {
"ClassCodes": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"LocState": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "102bd85bf792",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8cdff039bdd8",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassApiReturnModelV2"
},
"example": {
"ClassCodes": [
{
"HttpStatusCode": "100 = Continue",
"StatusCode": "string",
"Service": "string",
"Message": "string",
"AdditionalMessages": [
"string"
],
"IndexId": 0,
"ClassCode": "string",
"ClassDescriptionCode": "string",
"State": "string",
"Payroll": "string",
"FullTimeEmployees": 0,
"PartTimeEmployees": 0
}
],
"RatingZip": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "de49540bd261",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "c78fd61c0479",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/documents": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Allows user to upload any supporting documentation that the Underwriter may need when reviewing the quote.",
"description": "Allows user to upload any supporting documentation that the Underwriter may need when reviewing the quote.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-documents",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/FilePostModel"
},
"example": {
"WindowsFileType": "string",
"FileData": "string",
"DisplayName": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "93ab28f2945a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2ad32254b133",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadFileResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"LibraryId": 0
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "4a7dfa35a872",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4a77aaf7337b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/eligibility": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the current eligibility and status of the quote specified by quoteId.\nQuote statuses include: Not Submitted, Submitted, Approved, UnderwriterDeclined, AdditionalInformationNeeded, and ApprovalSubjectTo.\nEligibility is broken down by Class Code, Questions, Territory, and Modifiers, each ret",
"description": "Retrieves the current eligibility and status of the quote specified by quoteId.
\r\n __Quote Statuses that will return are below:__
\r\n __•__ __Not Submitted__ – means quote has not been submitted to the underwriter; default status on quote creation and journey
\r\n __•__ __Submitted__ – means the quote is submitted to an underwriter, and awaiting review
\r\n __•__ __Approved__ – means the underwriter has approved this risk and quote can now be bound via the (POST) Bind Quote endpoint; the quote is now blocked for editing
\r\n __•__ __UnderwriterDeclined__ – means the underwriter has declined this risk, and quote cannot be bound; the quote is now blocked for editing
\r\n __•__ __AdditionalInformationNeeded__ – means the underwriter needs additional information before approving/declining risk. Underwriter will send an email to the agent listed as the contact on the quote
\r\n __•__ __ApprovalSubjectTo__ – means the underwriter has approved the quote submit to outlined changes being made prior to binding; those changes will be outlined in an email to the agent contact on the quote
\r\n Eligibility is broken down into the parameters below:
\r\n __•__ __Class Code: Bind Eligible, Refer, Declined__
\r\n __•__ __Questions: Bind Eligible, Refer, Declined__ (will default to Refer on initial quote creation, as questions have not been answered yet)
\r\n __•__ __Territory: Bind Eligible, Refer, Declined__
\r\n __•__ __Modifiers: Bind Eligible, Refer, Declined__
\r\n __Please note:__ There may be other factors, not included in the breakdown, that impact the overall eligibility on a quote",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-eligibility",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f42c49ccc23a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "5843eb686698",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEligibilityResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
],
"QuoteStatus": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5a426667f700",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/legalEntities/available": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves legal entities available for the quote specified by quote ID.",
"description": "Retrieves legal entities available for the quote specified by quote ID.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-legalentities-available",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "72ee66743468",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2360ad86dd6e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"LegalEntityId": 0,
"EntityDescription": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "dcff8d8ab479",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/modifiers": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all available modifiers on the quote specified by the URI parameter quoteId.",
"description": "Retrieves all available modifiers on the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-modifiers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "88118a245403",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "fdb21babd38a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateModifiersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"State": "string",
"Modifiers": [
{
"Id": "string",
"Value": "string",
"ModifierUiInformation": {
"Description": "string",
"RegexFormatting": "string",
"ModifierType": "string",
"OnlyAvailableValues": [
0
],
"MinValue": 0,
"MaxValue": 0
},
"ExcludingModifier": {
"Id": "string",
"Description": "string",
"Value": "string"
},
"State": "string"
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b802dcd5fbea",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"patch": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates the quote to include modifiers. Modifier IDs are case sensitive. Modifier values cannot be null.",
"description": "Updates the quote to include modifiers.
\r\n __•__ Modifier IDs are case sensitive. For example: “EmPct”, “ComContribPct”, etc…
\r\n __•__ Modifier values cannot be null.
",
"operationId": "patch-api-v1-specialty-program-quotes-quoteid-modifiers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ModifierPatchModel"
},
"example": {
"LoadEligibility": true,
"StateModifiers": [
{
"State": "string",
"Modifiers": {}
}
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "807378df9c0b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9d254b47dcd7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifiersPatchResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Eligibility": {
"Eligibility": "string",
"Details": [
{
"Type": "string",
"Eligibility": "string"
}
]
}
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "96bb0fcb1d7a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "3cbe5e459bbf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/officer-information": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all officer types and endorsement information that can be added to the quote specified by the URI parameter quoteId.",
"description": "Retrieves all officer types and endorsement information that can be added to the quote specified by the URI parameter __quoteId.__",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-officer-information",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "1e84f08c3667",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "ede12c8a5601",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfficerInformationModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"OfficerType": "string",
"State": "string",
"LimitInformation": {
"ExcludedOfficerLimit": 0,
"ValidationMessage": "string"
},
"EndorsementInformation": {
"ValidationMessage": "string",
"Endorsements": [
{
"FormType": "string",
"FormSubType": "string",
"Id": "string",
"Description": "string",
"MinOwnershipPercentage": 0,
"MaxOwnershipPercentage": 0,
"OwnershipPctValidationMessage": "string",
"MinAnnualCompensation": 0,
"MaxAnnualCompensation": 0,
"AnnualCompensationValidationMessage": "string"
}
]
}
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "f29e3fdbf31c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/partners": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Removes saved California partner information from the quote.\nIf partnerId is not included, all partners are removed. If included, only that partner is removed.",
"description": "Removes saved California partner information from the quote.
\r\n The query string parameter __partnerId__ is optional:
\r\n __•__ If the parameter partner ID is not included in the URI, then all partners currently saved to the quote will be removed
\r\n __•__ If the parameter partner ID is included in the URI, then only the partner associated with that ID will be removed.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b19539ed3411",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "aba1aecf9691",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": true
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "e3c05113ba74",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves California partner names to a quote. Required for certain legal entities in CA in order to bind.\nOne of the following fields is required: First Name and Last Name, OR Organization.",
"description": "This information is required, in order to bind, if the quote is in CA, and is one of the legal entities listed below:
\r\n __•__ General Partnership
\r\n __•__ Limited Liability Partnership
\r\n __•__ Limited Partnership
\r\n __•__ Tenants in Common
\r\n __Note 1:__ If the legal entity is __Tenants in Common__, no partners are required, but if one is added, a second is required.
\r\n __Note 2:__ One of the following fields is required: First Name and Last Name, OR Organization. Please include either First Name and Last Name, OR Organization in your request.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostQuotePartnerRequest"
}
},
"example": [
{
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e0b57cb36352",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "e9309109c9cf",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "9b89055259ce",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Returns the partner names and organization on the specified quote.\nIf partnerId is not included, all partners return. If included, only that partner returns.",
"description": "This endpoint will return the partner names and organization on the specified quote.
\r\n The URI parameter __partnerId__ is optional:
\r\n __•__ If __partnerId__ is not included in the URI, then all partners currently saved to the quote will return
\r\n __•__ If __partnerId__ is included in the URI, then only the partner associated with that ID will return",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b799bb4bbbfc",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b6e322095170",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b82cc715ac7a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates the partner names or organizations on the specified quote.\nPartners not included in the request body will be removed if partnerId is not specified in the URI.",
"description": "This endpoint will update the partner names or organizations on the specified quote
\r\n The Partner ID is optional:
\r\n __•__ If __partnerId__ is not included in the URI, any partners that are desired to be kept on the quote will need to be passed in the body (including __partnerId__); if any are left off the request, the partner will be removed.
\r\n __•__ If __partnerId__ is included in the URI, you only need to include that partner ID, along with first and last name OR Organization, in the request body.
\r\n __Note:__ One of the following fields is required: First Name and Last Name, OR Organization. Please include either First Name and Last Name, OR Organization in your request.",
"operationId": "put-api-v1-specialty-program-quotes-quoteid-partners",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutQuotePatnerRequest"
}
},
"example": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "adbbd01f7b03",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f675d2a21bd1",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "7c0dcf524f92",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/partners/{partnerId}": {
"patch": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates the partner name or organization for a specific partner ID on the specified quote.",
"description": "This endpoint will update the partner name or organization on the specified quote, associated with the specific partner ID passed.
\r\n __Note 1:__ To update name: Only the field being updated is required (first OR last name), but both can be sent.
\r\n __Note 2:__ To update organization: It is required to set only organization. Do not include both organization and partner name in the request.",
"operationId": "patch-api-v1-specialty-program-quotes-quoteid-partners-partnerid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "partnerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PatchQuotePatnerRequest"
},
"example": {
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "9531e6d5e518",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "87617973716a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QuotePartnersResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"PartnerId": 0,
"FirstName": "string",
"LastName": "string",
"Organization": "string"
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "33274ccd2b9d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/paymentPlans": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves the selected payment plan to the specified quote.",
"description": "Saves the selected payment plan to the specified quote.",
"operationId": "post-api-v2-specialty-program-quotes-quoteid-paymentplans",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PaymentPlanPostModel"
},
"examples": {
"Standard payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Agency"
}
},
"Direct payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "None",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
},
"Payo payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PAYO",
"InsuredName": null,
"InsuredEmail": null,
"AgentName": null,
"AgentEmail": null,
"AccountManagerCSRName": null,
"AccountManagerCSREmail": null,
"PayrollCompanyId": 10020
},
"BillingType": "Direct"
}
},
"Psr payment plan": {
"value": {
"DepositPercent": 50,
"NumberPayments": 6,
"PaymentPlanId": 1,
"IsDirectDebit": false,
"PaymentPlan": {
"PaymentPlanType": "PSR",
"InsuredName": "Test Insured",
"InsuredEmail": "insured@email.com",
"AgentName": "Test Agent",
"AgentEmail": "agent@email.com",
"AccountManagerCSRName": "Test Account Manager CSR",
"AccountManagerCSREmail": "csr@email.com",
"PayrollCompanyId": null
},
"BillingType": "Direct"
}
}
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c38427a812ea",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5e8f073b58b9",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "f88b7f52a0e2",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/terms-of-agreement": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves acknowledgement that the insured has read the Terms of Agreement statement before submitting Direct Debit information.",
"description": "This endpoint is meant to be used in conjunction with the (GET) Terms of Agreement endpoint. Insureds will need to acknowledge that they have red the statement in order to submit their Direct Debit Information.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-terms-of-agreement",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TermsOfAgreementModel"
},
"example": {
"IsAcknowledged": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d2fad18be6f3",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "d7b05517ea10",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "d3f6be632143",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isOk": {
"type": "boolean"
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"responseId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"messageCode": {
"type": "string"
},
"isOk": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}
},
"maxMessageIndex": {
"type": "integer",
"format": "int32"
},
"_v": {
"type": "string"
}
}
},
"example": {
"isOk": true,
"httpStatusCode": 200,
"responseId": "bf30862e05fe",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"messages": [
{
"httpStatusCode": 200,
"messageCode": "SUCCESS",
"isOk": true,
"detail": "Acknowledgement saved successfully!"
}
],
"maxMessageIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/underwriter-messages": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Send message to underwriter",
"description": "Send message to underwriter",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-underwriter-messages",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModel"
},
"example": {
"Message": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModel"
},
"example": {
"Message": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModel"
},
"example": {
"Message": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModel"
},
"example": {
"Message": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "edb9bf9e2757",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c158da195cbe",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "c37118dab887",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "b6e12239d40f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isOk": {
"type": "boolean"
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"responseId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"messageCode": {
"type": "string"
},
"isOk": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}
},
"maxMessageIndex": {
"type": "integer",
"format": "int32"
},
"_v": {
"type": "string"
}
}
},
"example": {
"isOk": true,
"httpStatusCode": 200,
"responseId": "bf30862e05fe",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"messages": [
{
"httpStatusCode": 200,
"messageCode": "SUCCESS",
"isOk": true,
"detail": "Your message has been successfully sent to the underwriter!"
}
],
"maxMessageIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieve underwriter message history.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-underwriter-messages",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "36539c3e1045",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c4f0ea92af8d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetUnderwritingMessageListBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"IndexId": 0,
"User": "string",
"Message": "string",
"AgentEntry": true,
"Sent": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "c4c9c10f0d6e",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/voluntary-compensation": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Saves a voluntary compensation endorsement to the quote specified by the quote ID passed.",
"description": "Saves a voluntary compensation endorsement to the quote specified by the quote ID passed.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostCompensationRequest"
}
},
"example": [
{
"EndorsementNumber": "string",
"FormDataFields": [
{
"IndexId": 0,
"Values": "string"
}
]
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "38e78b7ec852",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "ae22ca88ec7b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "636db5e80997",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "cdb859c93caa",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves available voluntary compensation coverage information for the quote ID passed.",
"description": "Retrieves available voluntary compensation coverage information for the quote ID passed.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "13eb9393f97b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "beee95f55c0a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"EndorsementNumber": "string",
"Description": "string",
"FormDataFields": [
{
"IndexId": 0,
"Label": "string",
"Required": true,
"CanEnterFreeText": true,
"CurrentValue": "string",
"PresetValues": [
"string"
]
}
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "9b52dc14fe4b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Removes the voluntary compensation coverage endorsement from the quote ID specified.\nIf no ID is sent, all endorsements on the quote will be removed. If ID is sent, only that ID will be removed.",
"description": "This endpoint removes the voluntary compensation coverage endorsement from the quote ID specified; Endorsement ID is optional.
\r\n If no ID is sent in request, then all endorsements that exist on the quote will be removed. If ID is sent, only that ID will be removed, and all others will remain.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-voluntary-compensation",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "endorsementNumber",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c430496ff63d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "a85b73f6e2de",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": "string"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "2a1da9d1ac69",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/agent-contacts": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Returns all agent contact IDs, names, and emails linked to the agent associated with the current authentication token.",
"description": "Returns all agent contact IDs, names, and emails linked to the agent associated with the current authentication token.",
"operationId": "get-api-v1-specialty-program-quotes-agent-contacts",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c368f3afdffa",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "93c86e8d3301",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentContact"
}
},
"example": [
{
"Id": "string",
"FullName": "string",
"Email": "string",
"AgentId": 0
}
]
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/billType": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the bill type available for the agency associated with the current authentication token.",
"description": "Retrieves the bill type available for the agency associated with the current authentication token.",
"operationId": "get-api-v1-specialty-program-quotes-billtype",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a1fcdfc21d47",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8a032bb1bc1a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillTypeResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"BillTypes": [
"string"
],
"EndQuotingNewBusinessDate": "string"
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/state-classes-eligibility/{state}/{classCode}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves eligibility status of a specified class code in the given state.\nEffective date may be passed in URL to see if a class code will be eligible after a specific date.",
"description": "Retrieves eligibility status of a specified class code in the state specified by the URI parameter __state.__
\r\n Effective date may be passed in URL, if wanting to see if a class code will be eligible after a specific date. If no effective date is passed, eligibility reflected is based on current date.",
"operationId": "get-api-v1-specialty-program-state-classes-eligibility-state-classcode",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "classCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "a0663ede9bfa",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "2d904fa28c3b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassCodeEligibilityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ClassCode": "string",
"ClassDescriptionCode": "string",
"ClassDescription": "string",
"Eligibility": "string",
"EffectiveDate": "string",
"ExpirationDate": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "e0719835ef05",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/states/{governingState}/effectiveDate/{effectiveDate}/legalEntities/available": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all legal entities that are available in a specified state as of the effective date passed.",
"description": "Retrieves all legal entities that are availablein a specified state, as of the effective date passed.",
"operationId": "get-api-v2-specialty-program-states-governingstate-effectivedate-effectiveda",
"parameters": [
{
"name": "governingState",
"in": "path",
"required": true,
"schema": {
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
{
"name": "effectiveDate",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b0b3c1d39ed4",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "061ee618b04b",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntityResponseIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"LegalEntityId": 0,
"EntityDescription": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/specialty-program/terms-of-agreement": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves the Terms of Agreement statement. Insureds must acknowledge they have read this statement before entering Direct Debit information.\nUse in conjunction with the POST Terms of Agreement endpoint.",
"description": "This endpoint is meant to be used in conjunction with the (POST) Terms of Agreement endpoint. Insureds will need to acknowledge that they have read the statement before entering the Direct Debit information. ",
"operationId": "get-api-v1-specialty-program-terms-of-agreement",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "8a0870f4752a",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "e58e8c065627",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string"
},
"example": "string"
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/stop-gap/{id}": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Deletes the stop gap coverage selected as well as all additional locations in that state.\nThe ID used should be the one associated with the Stop Gap Coverage.",
"description": "This endpoint will delete the stop gap coverage selected as well as all additional locations in that state. The ID that should be used is that associated with the Stop Gap Coverage.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-stop-gap-id",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c25244d47165",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "145d135973d4",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteStopGapCoverageResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"CoverageId": 0,
"Locations": [
{
"Line1": "string",
"Line2": "string",
"City": "string",
"State": "string",
"Zip": "string"
}
]
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "b27a25d0d674",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/additionalInformation/insureds/{insuerdId}": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Removes a specified insured from the quote specified by the URI parameter quoteId.",
"description": "Removes a specified insured from the quote specified by the URI parameter quoteId.",
"operationId": "remove_quote_additional_information_insured",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "insuerdId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "6412e55aa35d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "075459a41c0e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "4c1afc3f9f09",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/additionalInformation/insureds/{insuerdId}": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Removes a specified insured from the specialty quote specified by the URI parameter quoteId.",
"description": "Removes a specified insured from the quote specified by the URI parameter quoteId.",
"operationId": "remove_specialty_quote_additional_information_insured",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "insuerdId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "7dff195c84a5",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "cbdd1fce64ba",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "8e61a7a96b9f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/bind/agent-contact/{agentContactId}": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Binds a specialty program quote to a policy.",
"description": "This endpoint is used to bind quotes",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-bind-agent-contact-agentcontact",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "agentContactId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "85be146042d2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "fcb251eba4a0",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BindResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"QuoteId": 0,
"Policy": "string",
"PolicyId": 0,
"EffectiveDate": "string",
"AnnualPremium": "string"
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/dividends": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Adds dividends to the specified specialty program quote.",
"description": "Add dividends to quote
",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-dividends",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PostDividendsModel"
},
"example": {
"DividendId": 0,
"DividendSubTypeId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDividendsModel"
},
"example": {
"DividendId": 0,
"DividendSubTypeId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PostDividendsModel"
},
"example": {
"DividendId": 0,
"DividendSubTypeId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/PostDividendsModel"
},
"example": {
"DividendId": 0,
"DividendSubTypeId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d49a5b687d49",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "3f4d7d2fa864",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostDividendsResponseModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"DividendId": 0,
"DividendSubTypeId": 0
}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Removes a dividend from the specified specialty program quote.",
"description": "Allows users to remove a dividend from a quote.
",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-dividends",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "cdd981206a74",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "009c999ed0c4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
},
"424": {
"description": "An internal dependency has failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailedDependencyErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/foreign-voluntary-coverage": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Save Foreign Voluntary Coverage.",
"description": "Allows users to submit Foreign Voluntary Coverage.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-foreign-voluntary-coverage",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageWriteModel"
}
},
"example": [
{
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageWriteModel"
}
},
"example": [
{
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageWriteModel"
}
},
"example": [
{
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageWriteModel"
}
},
"example": [
{
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "2a74ce9fdf4d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "08633afe92b4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"IndexId": 0,
"GovState": "string",
"Employee": "string",
"Location": "string",
"WcLaw": "string"
}
]
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "695f86c39506",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/third-party-notices": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Deletes the specified third-party notice from a quote.",
"description": "This endpoint will delete the specified third-party notice.",
"operationId": "delete-api-v1-quotes-quoteid-third-party-notices",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "da98bc8a4bb7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "11d375fad216",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/available_dividends": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Provides a list of all available dividends for a specialty program quote.",
"description": "Provides a list of all available dividends for a specialty quote.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-available_dividends",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "c5481c1b8ba4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b5d1a5574312",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSpecialtyQuoteAvailableDividendsResponseModelBaseResponse"
},
"example": {
"Data": {
"SingleState": [
{
"DividendSubTypeId": 1,
"DividendName": "Test Single State Dividend",
"DividendId": 123
}
],
"MultiState": [
{
"DividendSubTypeId": 2,
"DividendName": "Test Multi State Dividend",
"DividendId": 234
}
],
"NationalGroup": [
{
"DividendSubTypeId": 3,
"DividendName": "Test National Group Dividend",
"DividendId": 345
}
]
},
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/third-party-notices": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Deletes the specified third-party notice from a specialty program quote.",
"description": "This endpoint will delete the specified third-party notice.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-third-party-notices",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ThirdPartyNoticeDeleteModelV1"
},
"example": {
"Indexes": [
0
]
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e7899db25b6d",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "e679abb20a87",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/modifiers/available_schedulemodifier": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Get available state category rationales",
"description": "If a scheduled modifier is added to a quote, user can provide additional information to explain the reason for adding this modifier. This endpoint provides the options for the additional information required. It is not required, and the rationale will default if no user selected rationale is included.",
"operationId": "get-api-v1-quotes-quoteid-modifiers-available_schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "96e8c147efab",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "3e95c40154ae",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateCategoryRationaleIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "CA",
"Categories": [
{
"CategoryTypeId": 1,
"Category": "Employees",
"Minimum": -10,
"Maximum": 10,
"Rationales": [
{
"RationalName": "Turnover rate",
"RationaleTypeId": 17
},
{
"RationalName": "Wage scales",
"RationaleTypeId": 11
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "a6587bad9bb6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/modifiers/schedulemodifier": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Get available schedule modifiers",
"description": "Provides all scheduled modifier rationales added to a quote.",
"operationId": "get-api-v1-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "7812ab8dc17d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "bfecf7581ad8",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "NY",
"Categories": [
{
"CategoryTypeId": 1,
"CategoryName": "Employees",
"Amount": 1,
"Rationales": [
{
"RationaleTypeId": 20,
"RationaleName": "Training at hire and ongoing"
},
{
"RationaleTypeId": 27,
"RationaleName": "Supervised workforce"
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "8fac17ba264d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp"
],
"summary": "Get available modifier schedules",
"description": "If a scheduled modifier is added to a quote the rationale for this modifier is defaulted at time of adding to the quote. This endpoint allows users to update the rationale included on the quote for the scheduled modifier.",
"operationId": "post-api-v1-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "8e7193514dcc",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "cd813dbe4c7d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "04d387ff82ca",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp"
],
"summary": "Update schedule modifier rationale information",
"description": "This endpoint allows users to edit information entered for the schedule modifier rationale",
"operationId": "put-api-v1-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "4ddbb0966e2f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "59ac17d71caf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "NY",
"Categories": [
{
"CategoryTypeId": 1,
"CategoryName": "Employees",
"Amount": 1,
"Rationales": [
{
"RationaleTypeId": 20,
"RationaleName": "Training at hire and ongoing"
},
{
"RationaleTypeId": 27,
"RationaleName": "Supervised workforce"
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "ea8dfedbbbd7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/reinstatement": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "This endpoint allows authorized users to reinstate a cancelled policy.",
"description": "This endpoint allows authorized users to reinstate a cancelled policy.",
"operationId": "post-api-v1-specialty-program-policies-policyid-reinstatement",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ReinstatePolicyRequest"
},
"example": {
"ReinstatementReason": "string",
"ReinstatementDate": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReinstatePolicyRequest"
},
"example": {
"ReinstatementReason": "string",
"ReinstatementDate": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ReinstatePolicyRequest"
},
"example": {
"ReinstatementReason": "string",
"ReinstatementDate": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ReinstatePolicyRequest"
},
"example": {
"ReinstatementReason": "string",
"ReinstatementDate": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d2105dab72cd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "92d61c661275",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "900e5d598ba3",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "ce5ddbd9e20e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/foreign-voluntary-coverage/{indexId}": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Delete Foreign Voluntary Coverage",
"description": "This endpoint allows users to delete foreign voluntary coverages from a quote.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-foreign-voluntary-coverage-in",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "indexId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d9685d5da94b",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9dab87f7a96a",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "5466a7361a39",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policy}/endorsement-history": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "This endpoint provides a list of all endorsements added to a policy",
"description": "This endpoint provides a list of all endorsements added to a policy",
"operationId": "get-api-v1-policies-policy-endorsement-history",
"parameters": [
{
"name": "policy",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "04aee5992811",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "d0faae733004",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndorsementHistoryResponseBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"Summary": [
{
"EndorsementNumber": 0,
"EffectiveDate": "string",
"Type": "string",
"Description": "string",
"CommitedBy": "string",
"DateCompleted": "string"
}
],
"Written": [
{
"State": "string",
"Date": "string",
"Description": "string",
"WrittenAmount": 0
}
],
"Earned": [
{
"State": "string",
"DateEarned": "string",
"Description": "string",
"EarnedAmount": 0
}
]
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/Nonrenewal-reason": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Returns full list of all available reasons for not renewing a policy",
"description": " Provides full list of all available reasons for not renewing a policy",
"operationId": "get-api-v1-specialty-program-policies-nonrenewal-reason",
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "b5437558cf3e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "693a7228eb94",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NonrenewCodeModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"NonrenewReasonCode": 0,
"NonrenewReasonDesc": "string",
"StateExclusion": [
"string"
]
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "bc13f1a38a14",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v2/specialty-program/quotes/{quoteId}/underwriter-messages": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Send message to underwriter.",
"description": "The Reason available options:
\r\n __•__ Price
\r\n __•__ Waiver of Subrogation (WOS)
\r\n __•__ Form/Coverage Request (not WOS)
\r\n __•__ Dividend
\r\n __•__ Deductible
\r\n __•__ Class Code Verification
\r\n __•__ Other
",
"operationId": "post-api-v2-specialty-program-quotes-quoteid-underwriter-messages",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MessageToUnderwriterModelV2"
},
"example": {
"Message": "string",
"Reason": "string"
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "7b39a729fd28",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9f85c25dc0c2",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "1761c69bc533",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "457b9bbb8645",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"isOk": {
"type": "boolean"
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"responseId": {
"type": "string"
},
"timeStamp": {
"type": "string",
"format": "date-time"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"httpStatusCode": {
"type": "integer",
"format": "int32"
},
"messageCode": {
"type": "string"
},
"isOk": {
"type": "boolean"
},
"detail": {
"type": "string"
}
}
}
},
"maxMessageIndex": {
"type": "integer",
"format": "int32"
},
"_v": {
"type": "string"
}
}
},
"example": {
"isOk": true,
"httpStatusCode": 200,
"responseId": "bf30862e05fe",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"messages": [
{
"httpStatusCode": 200,
"messageCode": "SUCCESS",
"isOk": true,
"detail": "Your message has been successfully sent to the underwriter!"
}
],
"maxMessageIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/policies/{policyId}/officer-information": {
"get": {
"tags": [
"Workers Comp"
],
"summary": "Get policy officer information",
"description": "Provides all officers available to be included on this policy",
"operationId": "get-api-v1-policies-policyid-officer-information",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ac603588f340",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "72231a9ff810",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfficerInformationModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"OfficerType": "string",
"State": "string",
"LimitInformation": {
"ExcludedOfficerLimit": 0,
"ValidationMessage": "string"
},
"EndorsementInformation": {
"ValidationMessage": "string",
"Endorsements": [
{
"FormType": "string",
"FormSubType": "string",
"Id": "string",
"Description": "string",
"MinOwnershipPercentage": 0,
"MaxOwnershipPercentage": 0,
"OwnershipPctValidationMessage": "string",
"MinAnnualCompensation": 0,
"MaxAnnualCompensation": 0,
"AnnualCompensationValidationMessage": "string"
}
]
}
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Search basic policy information",
"description": "Returns basic policy information on requested policy number.
\r\n Retrieves policy number based on parameter used to search
\r\n User can search for a policy number using one of the following parameters:
\r\n • Master Account ID
\r\n • FEIN
\r\n • Policy ID
\r\n • Quote Number
\r\n Only one (1) parameter can be used to search
\r\n Only the first ten (10) results will return; if there are more than (10) records associated with the given search parameter, they will not all return.",
"operationId": "get-api-v1-specialty-program-policies",
"parameters": [
{
"name": "MasterAccountId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PolicyId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Fein",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Quote",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "91ce88732efb",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "9c6a92517adf",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PolicySearchResponseIReadOnlyCollectionBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"PolicyNumber": "string",
"BusinessName": "string",
"EffectiveDate": "string",
"PolicyStatus": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "83e71d6de708",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/nonrenewal": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Set Policy As Non-Renewal.",
"description": "This endpoint allows users to set policy as non-renewal.",
"operationId": "post-api-v1-specialty-program-policies-policyid-nonrenewal",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/SetPolicyAsNonRenewalRequest"
},
"example": {
"NonRenewalReason": 11,
"Description": "Customer has requested to not renew this policy."
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetPolicyAsNonRenewalRequest"
},
"example": {
"NonRenewalReason": 11,
"Description": "Customer has requested to not renew this policy."
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SetPolicyAsNonRenewalRequest"
},
"example": {
"NonRenewalReason": 11,
"Description": "Customer has requested to not renew this policy."
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SetPolicyAsNonRenewalRequest"
},
"example": {
"NonRenewalReason": 11,
"Description": "Customer has requested to not renew this policy."
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "54b20e1fc85d",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "142d42b70da4",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "e39a8cdf51d2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/nonrenewal/reversal": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "This endpoint allows users to reverse a non-renewal that was previously set on a policy.",
"description": "This endpoint allows users to reverse a non-renewal that was previously set on a policy.",
"operationId": "post-api-v1-specialty-program-policies-policyid-nonrenewal-reversal",
"parameters": [
{
"name": "policyId",
"in": "path",
"description": "",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "300589d83328",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "b84421ed49ee",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/policies/{policyId}/officer-information": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Get policy officer information",
"description": "Provides all officers available to be included on this policy",
"operationId": "get-api-v1-specialty-program-policies-policyid-officer-information",
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "8c037cc82eeb",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "fb2b56c4912f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfficerInformationModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"OfficerType": "string",
"State": "string",
"LimitInformation": {
"ExcludedOfficerLimit": 0,
"ValidationMessage": "string"
},
"EndorsementInformation": {
"ValidationMessage": "string",
"Endorsements": [
{
"FormType": "string",
"FormSubType": "string",
"Id": "string",
"Description": "string",
"MinOwnershipPercentage": 0,
"MaxOwnershipPercentage": 0,
"OwnershipPctValidationMessage": "string",
"MinAnnualCompensation": 0,
"MaxAnnualCompensation": 0,
"AnnualCompensationValidationMessage": "string"
}
]
}
}
}
}
}
}
}
}
},
"/api/v1/specialty-program/price-tiering/state/{stateAbbreviation}/classCode/{classCode}/zipCode/{zipCode}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all available pricing tiers for a given state, class code, and zip code.",
"description": "Retrieves all available pricing tiers for the provided state, class code, and zip code.",
"operationId": "get-api-v1-specialty-program-price-tiering-state-stateabbreviation-classcode",
"parameters": [
{
"name": "stateAbbreviation",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "classCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "zipCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "1915fca8b5e8",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "3f9b624991b9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PriceTieringResponseModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"ClassCode": "string",
"FirmName": "string",
"FirmId": 0,
"TierId": 0,
"TierName": "string"
}
]
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/small-deductible": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Retrieves all available small deductible options for a specified specialty program quote.",
"description": "This provides all available small deductible options per quote.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-small-deductible",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "4a9eb59c4c3f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "18dfccf962d1",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SmallDeductibleResponseModelIEnumerableBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": [
{
"DedId": 0,
"GovState": "string",
"DedAccLimit": 0,
"DedPct": 0,
"HazardGrp": "string"
}
]
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorBaseResponse"
}
}
}
}
}
}
},
"/api/v1/specialty-program/price-tiering/state/{state}/firm/{firmId}": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Provides a breakdown of pricing tier options by state and firm.",
"description": "This endpoint provides a breakdown of pricing tier options by state and firm.",
"operationId": "get-api-v1-specialty-program-price-tiering-state-state-firm-firmid",
"parameters": [
{
"name": "state",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "firmId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "d4496b5c8a48",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "f5737cd93841",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PricingTierResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"FirmId": 1,
"TierName": "Standard",
"TierId": 0,
"State": "AL"
},
{
"FirmId": 1,
"TierName": "Standard-1",
"TierId": 7,
"State": "AL"
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/specific-waivers": {
"post": {
"tags": [
"Workers Comp"
],
"summary": "Creates new specific waivers",
"description": "Allows users to create new specific waivers",
"operationId": "post-api-v1-quotes-quoteid-specific-waivers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ef3528589700",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "942d436acb26",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WaiverReadModelIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"IndexId": 123,
"EndDate": null,
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "ee96d374c375",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp"
],
"summary": "Updates a specific waiver",
"description": "Allows users to update an existing specific waiver",
"operationId": "put-api-v1-quotes-quoteid-specific-waivers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "e2cea72177d9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "25262f8b47d2",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WaiverReadModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "8e549c372e12",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/quotes/{quoteId}/specific-waivers/{indexId}": {
"delete": {
"tags": [
"Workers Comp"
],
"summary": "Deletes a specific waiver",
"description": "This endpoint is to delete specific waivers no longer needed.",
"operationId": "delete-api-v1-quotes-quoteid-specific-waivers-indexid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "indexId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "856558d86b73",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "dc079e05cda7",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "a0c43844bd9e",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/specific-waivers": {
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Creates new specific waivers",
"description": "Allows users to create new specific waivers",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-specific-waivers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverWriteModel"
}
},
"example": [
{
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
]
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "856f85c11821",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "40a57cc76aec",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WaiverReadModelIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"IndexId": 123,
"EndDate": null,
"StartDate": "2026-08-13",
"Name": "Waiver 123",
"Address": "2001 Park Manor Blvd",
"City": "Pittsburgh",
"State": "AL",
"Zip": "15205",
"ClassCode": "8810",
"GovState": "AL",
"JobDescription": "General construction labor",
"Payroll": 65000
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "14dd497c63a9",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Updates a specific waiver",
"description": "Allows users to update an existing specific waiver",
"operationId": "put-api-v1-specialty-program-quotes-quoteid-specific-waivers",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateWaiverModel"
},
"example": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "f6522ce62f7f",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "04dcf7dfc0ee",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WaiverReadModelBaseResponse"
},
"example": {
"StatusCode": "100 = Continue",
"Message": "string",
"AdditionalMessages": [
"string"
],
"Errors": {},
"Data": {
"StartDate": "string",
"Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Zip": "string",
"ClassCode": "string",
"GovState": "string",
"JobDescription": "string",
"Payroll": 0,
"IndexId": 0,
"EndDate": "string"
}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "8afc6b6069cd",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/specific-waivers/{indexId}": {
"delete": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Deletes a specific waiver",
"description": "This endpoint is to delete specific waivers no longer needed.",
"operationId": "delete-api-v1-specialty-program-quotes-quoteid-specific-waivers-indexid",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
{
"name": "indexId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "063a09fbd312",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "8026e54f0db8",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"400": {
"description": "Validation error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestErrorIApiResponse"
},
"example": {
"responseId": "9395833e39b9",
"timeStamp": "2026-08-13T11:08:12.0000000+00:00",
"httpStatusCode": 400,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ValidationErr",
"Title": "Validation Error",
"Detail": "Validation detail message",
"httpStatusCode": 400,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/modifiers/available_schedulemodifier": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Get available state category rationales",
"description": "If a scheduled modifier is added to a quote, user can provide additional information to explain the reason for adding this modifier. This endpoint provides the options for the additional information required. It is not required, and the rationale will default if no user selected rationale is included.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-modifiers-available_schedulemodi",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "9695e1c85a62",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "c3ebfad42897",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateCategoryRationaleIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "CA",
"Categories": [
{
"CategoryTypeId": 1,
"Category": "Employees",
"Minimum": -10,
"Maximum": 10,
"Rationales": [
{
"RationalName": "Turnover rate",
"RationaleTypeId": 17
},
{
"RationalName": "Wage scales",
"RationaleTypeId": 11
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "5e48c9e7d613",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
},
"/api/v1/specialty-program/quotes/{quoteId}/modifiers/schedulemodifier": {
"get": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Get available schedule modifiers",
"description": "Provides all scheduled modifier rationales added to a quote.",
"operationId": "get-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "279641357baa",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "82812db43c0f",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "NY",
"Categories": [
{
"CategoryTypeId": 1,
"CategoryName": "Employees",
"Amount": 1,
"Rationales": [
{
"RationaleTypeId": 20,
"RationaleName": "Training at hire and ongoing"
},
{
"RationaleTypeId": 27,
"RationaleName": "Supervised workforce"
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "2e9c9d94e5d9",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"post": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Get available modifier schedules",
"description": "If a scheduled modifier is added to a quote the rationale for this modifier is defaulted at time of adding to the quote. This endpoint allows users to update the rationale included on the quote for the scheduled modifier.",
"operationId": "post-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "ad80083a63da",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "28c2ed1c456c",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
},
"example": {
"StatusCode": 200,
"Exception": null,
"Message": "The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date.",
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "cde95b355cd6",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
},
"put": {
"tags": [
"Workers Comp-Specialty Programs"
],
"summary": "Update schedule modifier rationale information",
"description": "This endpoint allows users to edit information entered for the schedule modifier rationale",
"operationId": "put-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier",
"parameters": [
{
"name": "quoteId",
"in": "path",
"required": true,
"schema": {
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/RationalePostModel"
},
"example": {
"State": "string",
"CategoryTypeId": 0,
"Amount": 0,
"RationaleTypeId": 0
}
}
}
},
"responses": {
"401": {
"description": "Bad or expired token. To resolve this error, generate a new or refreshed token.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorIApiResponse"
},
"example": {
"responseId": "bab2eac34bfd",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 401,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-NOTAUTHORIZED",
"Title": "Bearer token is not authorized",
"httpStatusCode": 401,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"403": {
"description": "The authenticated user or client does not have required permissions to complete this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenErrorIApiResponse"
},
"example": {
"responseId": "948fdeca7937",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 403,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-FORBIDDEN",
"Title": "The token provided does not have permissions for the requested action",
"httpStatusCode": 403,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
},
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse"
},
"example": {
"Data": [
{
"State": "NY",
"Categories": [
{
"CategoryTypeId": 1,
"CategoryName": "Employees",
"Amount": 1,
"Rationales": [
{
"RationaleTypeId": 20,
"RationaleName": "Training at hire and ongoing"
},
{
"RationaleTypeId": 27,
"RationaleName": "Supervised workforce"
}
]
}
]
}
],
"StatusCode": 200,
"Exception": null,
"Message": null,
"AdditionalMessages": [],
"Errors": {}
}
}
}
},
"404": {
"description": "Not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundErrorIApiResponse"
},
"example": {
"responseId": "aac712a39212",
"timeStamp": "2026-08-13T11:08:11.0000000+00:00",
"httpStatusCode": 404,
"isOk": false,
"errors": [
{
"MessageCode": "ERR-ItemNotFound",
"Title": "Item was not found",
"httpStatusCode": 404,
"isOk": false
}
],
"maxErrorIndex": 0,
"_v": "AD"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccountInformation": {
"type": "object",
"properties": {
"QuoteId": {
"type": "integer",
"description": "QuoteId",
"format": "int32"
},
"MasterAccountId": {
"type": "integer",
"description": "MasterAccountId",
"format": "int32"
},
"GoverningState": {
"type": "string",
"description": "GoverningState",
"nullable": true
},
"Status": {
"type": "string",
"description": "Status",
"nullable": true
},
"AccountUrl": {
"type": "string",
"description": "AccountUrl",
"nullable": true
},
"Carrier": {
"type": "string",
"description": "Carrier",
"nullable": true
}
},
"additionalProperties": false,
"description": "AccountInformation"
},
"AccountType": {
"enum": [
"1 = Checking",
"2 = Savings"
],
"type": "integer",
"format": "int32"
},
"AdditionalCoverage": {
"type": "object",
"properties": {
"Coverage": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Limit": {
"type": "string",
"nullable": true
},
"Period": {
"type": "string",
"nullable": true
},
"AnnualPayroll": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AdditionalInfoPostModelV2": {
"type": "object",
"properties": {
"Officers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Officer"
},
"description": "Included / Excluded Officers on quote. If none, send null",
"nullable": true
},
"AdditionalInsureds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insured"
},
"description": "If none, send null",
"nullable": true
},
"AdditionalPrimaryInsuredLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInsuredLocation"
},
"description": "Any Additional Locations associated with the quote's primary insured. If none, send null\nThe quote must have exposure in location's state to be added.",
"nullable": true
},
"ThirdPartyNotices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThirdPartyNoticePostDto"
},
"description": "Any Additional third party notices.",
"nullable": true
}
},
"additionalProperties": false
},
"AdditionalInfoReturnModel": {
"type": "object",
"properties": {
"Officers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OfficerReturnModel"
},
"description": "Officers",
"nullable": true
},
"AdditionalInsureds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsuredReturnModel"
},
"description": "AdditionalInsureds",
"nullable": true
},
"AdditionalPrimaryInsuredLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalLocationReturnModel"
},
"description": "AdditionalPrimaryInsuredLocations",
"nullable": true
},
"ThirdPartyNotices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ThirdPartyNoticeGetDto"
},
"description": "Third party notices",
"nullable": true
}
},
"additionalProperties": false,
"description": "AdditionalInfoReturnModel"
},
"AdditionalInfoReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/AdditionalInfoReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"AdditionalInsured": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32"
},
"NamedInsuredId": {
"type": "integer",
"format": "int32"
},
"Name": {
"type": "string",
"nullable": true
},
"Dba": {
"type": "string",
"nullable": true
},
"Fein": {
"type": "string",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"format": "int32"
},
"UnemploymentNumber": {
"type": "string",
"nullable": true
},
"Line1": {
"type": "string",
"nullable": true
},
"Line2": {
"type": "string",
"nullable": true
},
"City": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Zip": {
"type": "string",
"nullable": true
},
"EmployeeCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"AdditionalInsuredLocation": {
"required": [
"State"
],
"type": "object",
"properties": {
"Address1": {
"type": "string",
"description": "Address1",
"nullable": true
},
"Address2": {
"maxLength": 40,
"type": "string",
"description": "Address2",
"nullable": true
},
"City": {
"type": "string",
"description": "city",
"nullable": true
},
"State": {
"maxLength": 2,
"minLength": 1,
"type": "string",
"description": "Quote must have exposure in location's state to be added"
},
"Zip": {
"type": "string",
"description": "zip",
"nullable": true
},
"TotalEmployeeNumber": {
"type": "integer",
"description": "Total employee number in this location; \nThis is a required field if in the state of CA",
"format": "int32",
"nullable": true
},
"NoSpecificLocation": {
"type": "boolean",
"description": "This is allowed for all states except AZ, IA, IN, KY, MO, MT, and TX. The state field is still required when this field is set to TRUE."
}
},
"additionalProperties": false
},
"AdditionalLocationReturnModel": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Id associated with Additional Location - Is unique when combined w/ Address1",
"format": "int32"
},
"Address1": {
"type": "string",
"description": "Address1",
"nullable": true
},
"Address2": {
"type": "string",
"description": "Address2",
"nullable": true
},
"City": {
"type": "string",
"description": "City",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Zip": {
"type": "string",
"description": "Zip",
"nullable": true
},
"TotalEmployeeNumber": {
"type": "integer",
"description": "",
"format": "int32",
"nullable": true
},
"NoSpecificLocation": {
"type": "boolean",
"description": "If there is no specific address the user will now be able to set the state and no other information for the additional address"
}
},
"additionalProperties": false,
"description": "AdditionalLocationReturnModel"
},
"Address": {
"required": [
"City",
"Line1",
"State",
"Zip"
],
"type": "object",
"properties": {
"Line1": {
"minLength": 1,
"type": "string",
"description": "Line1"
},
"City": {
"minLength": 1,
"type": "string",
"description": "city"
},
"State": {
"minLength": 1,
"type": "string",
"description": "2 letter state"
},
"Zip": {
"minLength": 1,
"type": "string",
"description": "5 digit zip"
},
"Line2": {
"type": "string",
"description": "address line 1",
"nullable": true
},
"Country": {
"$ref": "#/components/schemas/CountryCodes"
},
"CountryName": {
"type": "string",
"description": "country name",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"AddressApiModel": {
"required": [
"City",
"Line1",
"State",
"Zip"
],
"type": "object",
"properties": {
"Line1": {
"minLength": 1,
"type": "string",
"description": "Line1"
},
"Line2": {
"type": "string",
"description": "Line2",
"nullable": true
},
"City": {
"minLength": 1,
"type": "string",
"description": "City"
},
"State": {
"minLength": 1,
"type": "string",
"description": "State"
},
"Zip": {
"minLength": 1,
"type": "string",
"description": "Zip"
}
},
"additionalProperties": false,
"description": ""
},
"AddressPutApiModel": {
"type": "object",
"properties": {
"Line1": {
"type": "string",
"description": "Line1",
"nullable": true
},
"Line2": {
"type": "string",
"description": "Line2",
"nullable": true
},
"City": {
"type": "string",
"description": "City",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Zip": {
"type": "string",
"description": "Zip",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"AgentContact": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Id is the agent contact id",
"nullable": true
},
"FullName": {
"type": "string",
"description": "agent full name , First name + last name",
"nullable": true
},
"Email": {
"type": "string",
"description": "agent email address",
"nullable": true
},
"AgentId": {
"type": "integer",
"description": "The agentId is the agency Id NOT agent contact id.",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"AgentContactBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/AgentContact"
}
},
"additionalProperties": false,
"description": ""
},
"AgentInfoReturnModel": {
"type": "object",
"properties": {
"AgentId": {
"type": "integer",
"description": "Agent Id",
"format": "int32"
},
"AgentName": {
"type": "string",
"description": "Agent Name",
"nullable": true
}
},
"additionalProperties": false,
"description": "Return model for agent names"
},
"AgentInfoReturnModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentInfoReturnModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"AgentPayrollCompaniesResponse": {
"type": "object",
"properties": {
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32"
},
"PayrollCompanyName": {
"type": "string",
"description": "PayrollCompanyName",
"nullable": true
}
},
"additionalProperties": false,
"description": "Model containing Payo Payroll Companies for a given agent"
},
"AgentPayrollCompaniesResponseIListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPayrollCompaniesResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"Answer": {
"type": "object",
"properties": {
"QuestionId": {
"type": "integer",
"description": "QuestionId",
"format": "int32"
},
"AnswerValue": {
"type": "string",
"description": "For the bool question type, the answer must be 'Yes' or 'No'; For dropdown questions, the answer must be one of the values in the dictionary of options provided",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ApiMessage": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageCode": {
"type": "string",
"nullable": true
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Title": {
"type": "string",
"nullable": true
},
"Detail": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"ApiMessageType": {
"enum": [
"0 = Info",
"1 = Error"
],
"type": "integer",
"format": "int32"
},
"ApiPageRequest": {
"type": "object",
"properties": {
"Skip": {
"type": "integer",
"format": "int32"
},
"Take": {
"type": "integer",
"format": "int32"
},
"Count": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ApiPageResponse": {
"type": "object",
"properties": {
"First": {
"type": "string",
"nullable": true
},
"Previous": {
"type": "string",
"nullable": true
},
"Current": {
"type": "string",
"nullable": true
},
"Next": {
"type": "string",
"nullable": true
},
"Last": {
"type": "string",
"nullable": true
},
"PageSize": {
"type": "integer",
"format": "int32",
"nullable": true
},
"Count": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ApiPaging": {
"type": "object",
"properties": {
"Request": {
"$ref": "#/components/schemas/ApiPageRequest"
},
"Response": {
"$ref": "#/components/schemas/ApiPageResponse"
}
},
"additionalProperties": false
},
"BadRequestError": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
},
"MessageCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Title": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Detail": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"BadRequestErrorBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/BadRequestError"
}
},
"additionalProperties": false,
"description": ""
},
"BadRequestErrorIApiResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"CorrelationID": {
"type": "string",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Paging": {
"$ref": "#/components/schemas/ApiPaging"
},
"MaxMsgIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MaxErrIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"IsOk": {
"type": "boolean"
},
"ApiResponseVersion": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Data": {
"$ref": "#/components/schemas/BadRequestError"
}
},
"additionalProperties": false
},
"BalanceSummaryResponse": {
"type": "object",
"properties": {
"QuoteId": {
"type": "integer",
"description": "quote id",
"format": "int32"
},
"PolicyId": {
"type": "integer",
"description": "policy id",
"format": "int32"
},
"CurrentDueAmount": {
"type": "number",
"description": "current amount due amount",
"format": "double"
},
"RemainingDueAmount": {
"type": "number",
"description": "ramaining due amoung",
"format": "double"
},
"CanMakePayment": {
"type": "boolean",
"description": "can use make a payment on this account"
}
},
"additionalProperties": false,
"description": ""
},
"BalanceSummaryResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/BalanceSummaryResponse"
}
},
"additionalProperties": false,
"description": ""
},
"BaseAddressModel": {
"required": [
"City",
"Line1",
"State",
"Zip"
],
"type": "object",
"properties": {
"Line1": {
"minLength": 1,
"type": "string",
"description": "Line1"
},
"Line2": {
"type": "string",
"description": "Line2",
"nullable": true
},
"City": {
"minLength": 1,
"type": "string",
"description": "city"
},
"State": {
"minLength": 1,
"type": "string",
"description": "2 letter state"
},
"Zip": {
"minLength": 1,
"type": "string",
"description": "5 digit zip"
}
},
"additionalProperties": false,
"description": ""
},
"BaseClassCodeModel": {
"type": "object",
"properties": {
"HttpStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"StatusCode": {
"type": "string",
"description": "StatusCode",
"nullable": true
},
"Service": {
"type": "string",
"description": "Service",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"IndexId": {
"type": "integer",
"description": "IndexId",
"format": "int32"
},
"OriginalClassCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"OriginalDesc": {
"type": "string",
"nullable": true,
"readOnly": true
},
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "ClassDescriptionCode",
"nullable": true
},
"LocState": {
"type": "string",
"description": "LocState",
"nullable": true
},
"Payroll": {
"type": "string",
"description": "Payroll",
"nullable": true
},
"FullTimeEmployees": {
"type": "integer",
"description": "FullTimeEmployees",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "PartTimeEmployees",
"format": "int32"
},
"IsDeleted": {
"type": "boolean",
"description": "IsDeleted"
},
"ClassRate": {
"type": "number",
"description": "Class Rate",
"format": "double"
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Premium": {
"type": "integer",
"description": "Premium",
"format": "int32"
},
"Exposure": {
"type": "integer",
"description": "Exposure",
"format": "int32"
},
"IsSplitRate": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false,
"description": ""
},
"BaseClassCodeModelListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseClassCodeModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"BaseContactResponse": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": true
},
"Phone": {
"type": "string",
"nullable": true
},
"Email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BasePaymentAmount": {
"type": "object",
"properties": {
"Currency": {
"type": "string",
"description": "currency",
"nullable": true
},
"Total": {
"type": "number",
"description": "total amount",
"format": "double"
}
},
"additionalProperties": false,
"description": "BasePaymentAmount"
},
"BaseQuoteOperation": {
"required": [
"op"
],
"type": "object",
"properties": {
"OperationType": {
"$ref": "#/components/schemas/OperationType"
},
"path": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"op": {
"minLength": 1,
"type": "string",
"description": "add
remove
replace
move
copy
test
invalid"
}
},
"additionalProperties": false
},
"BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"BillTypeResponse": {
"type": "object",
"properties": {
"BillTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "bill types-- I for Agent and D for direct",
"nullable": true
},
"EndQuotingNewBusinessDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"BillTypeResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/BillTypeResponse"
}
},
"additionalProperties": false,
"description": ""
},
"Billing": {
"enum": [
"0 = A",
"1 = I"
],
"type": "integer",
"format": "int32"
},
"BindResponse": {
"type": "object",
"properties": {
"QuoteId": {
"type": "integer",
"description": "Quote associated with the Policy",
"format": "int32"
},
"Policy": {
"type": "string",
"description": "Policy Number generated when quote is bound",
"nullable": true
},
"PolicyId": {
"type": "integer",
"description": "Policy Id generated when quote is bound",
"format": "int32"
},
"EffectiveDate": {
"type": "string",
"description": "Effective date of the new Policy",
"nullable": true
},
"AnnualPremium": {
"type": "string",
"description": "Annual premium of the Policy (does not include taxes or fees)",
"nullable": true
}
},
"additionalProperties": false,
"description": "BindResponse"
},
"BindResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/BindResponse"
}
},
"additionalProperties": false,
"description": ""
},
"BooleanBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "boolean",
"description": "Data"
}
},
"additionalProperties": false,
"description": ""
},
"ByteArrayBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "string",
"description": "Data",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"CancelInformation": {
"type": "object",
"properties": {
"CancelDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"CancelReason": {
"type": "string",
"nullable": true
},
"ShortRate": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CategoryRationale": {
"type": "object",
"properties": {
"CategoryTypeId": {
"type": "integer",
"format": "int32"
},
"Category": {
"type": "string",
"nullable": true
},
"Minimum": {
"type": "number",
"format": "double",
"nullable": true
},
"Maximum": {
"type": "number",
"format": "double",
"nullable": true
},
"Rationales": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Rationale"
},
"nullable": true
}
},
"additionalProperties": false
},
"ClassApiReturnModel": {
"type": "object",
"properties": {
"HttpStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"StatusCode": {
"type": "string",
"description": "StatusCode",
"nullable": true
},
"Service": {
"type": "string",
"description": "Service",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"IndexId": {
"type": "integer",
"description": "IndexId",
"format": "int32"
},
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "ClassDescriptionCode",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Payroll": {
"type": "string",
"description": "Payroll",
"nullable": true
},
"FullTimeEmployees": {
"type": "integer",
"description": "FullTimeEmployees",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "PartTimeEmployees",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"ClassApiReturnModelV2": {
"type": "object",
"properties": {
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
}
},
"additionalProperties": false
},
"ClassCodeEligibilityResponse": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "ClassDescriptionCode",
"nullable": true
},
"ClassDescription": {
"type": "string",
"description": "ClassDescription",
"nullable": true
},
"Eligibility": {
"type": "string",
"description": "Eligibility",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate",
"nullable": true
}
},
"additionalProperties": false,
"description": "ClassCodeEligibilityResponse"
},
"ClassCodeEligibilityResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeEligibilityResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassCodeInformation": {
"type": "object",
"properties": {
"DescriptionCode": {
"type": "string",
"description": "description code: i.e. 00",
"nullable": true
},
"NaicsDescription": {
"type": "string",
"description": "class code Description",
"nullable": true
},
"NaicsCode": {
"type": "string",
"description": "NaicsCode",
"nullable": true
},
"SicCode": {
"type": "string",
"description": "SicCode",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassCodeList": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "NCCI Class Code. Must be 4 numeric characters for all states except 'DE' and 'PA' in which it must be 3 numeric characters",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "Max 2 numeric characters if provided; defalulted if not",
"nullable": true
},
"LocState": {
"type": "string",
"description": "Required if ClassCode is provided. Max 2 characters. annot be: \"AK\", \"ND\", \"OH\", \"WA\", \"WY\"",
"nullable": true
},
"Payroll": {
"type": "string",
"description": "Required if ClassCode is provided",
"nullable": true
},
"FullTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can create/update quote without both",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can create/update quote without both",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"ClassCodePostModel": {
"type": "object",
"properties": {
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeList"
},
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"nullable": true
}
},
"additionalProperties": false
},
"ClassCodeQuestion": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionInformation"
},
"description": "Questions",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassCodeWithFirm": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "2 letter state",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "class code",
"nullable": true
},
"Information": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeInformation"
},
"description": "",
"nullable": true
},
"AvailableFirms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmWithRate"
},
"description": "Firms ids that this class code can be used with",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassInformationResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "2 letter state",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "class code",
"nullable": true
},
"ClassCodeDescriptionCode": {
"type": "string",
"description": "class code description code",
"nullable": true
},
"ClassCodeDescription": {
"type": "string",
"description": "class code description",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassInformationResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassInformationResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ClassPostModel": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "Max 2 numeric characters if provided",
"nullable": true
},
"State": {
"type": "string",
"description": "Required if ClassCode is provided. Max 2 characters. Cannot be: \"AK\", \"ND\", \"OH\", \"WA\", \"WY\"",
"nullable": true
},
"Payroll": {
"type": "integer",
"description": "Required if ClassCode is provided",
"format": "int32"
},
"FullTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"ClassPutModel": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"description": "If not provided, a new class code will be added.",
"format": "int32"
},
"ClassCode": {
"type": "string",
"description": "NCCI Class Code. Must be 4 numeric characters for all states except 'DE' and 'PA' in which it must be 3 numeric characters",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "Max 2 numeric characters if provided",
"nullable": true
},
"State": {
"type": "string",
"description": "Required if ClassCode is provided. Max 2 characters. Cannot be: \"AK\", \"ND\", \"OH\", \"WA\", \"WY\"",
"nullable": true
},
"Payroll": {
"type": "string",
"description": "Required if ClassCode is provided",
"nullable": true
},
"FullTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
}
},
"additionalProperties": false,
"description": "ClassPutModel"
},
"ClassPutModelV2": {
"type": "object",
"properties": {
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassPutModel"
},
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set.",
"nullable": true
}
},
"additionalProperties": false
},
"ClassSpecialtyPostModel": {
"required": [
"ClassCode",
"FullTimeEmployees",
"PartTimeEmployees",
"Payroll"
],
"type": "object",
"properties": {
"ClassCode": {
"minLength": 1,
"type": "string",
"description": "ClassCode"
},
"ClassDescriptionCode": {
"type": "string",
"description": "Max 2 numeric characters if provided",
"nullable": true
},
"State": {
"type": "string",
"description": "Required if ClassCode is provided. Max 2 characters. Cannot be: \"AK\", \"ND\", \"OH\", \"WA\", \"WY\"",
"nullable": true
},
"Payroll": {
"maximum": 79228162514264337593543950335,
"minimum": 1.0,
"type": "integer",
"description": "Required if ClassCode is provided",
"format": "int32"
},
"FullTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
},
"PartTimeEmployees": {
"type": "integer",
"description": "Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"ContactApiModel": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email",
"format": "email",
"nullable": true
},
"Phone": {
"pattern": "((\\(\\d{3}\\)?)|(\\d{3}))([\\s-./]?)(\\d{3})([\\s-./]?)(\\d{4})",
"type": "string",
"description": "Phone",
"nullable": true
},
"AgentContactId": {
"type": "integer",
"description": "AgentContactId",
"format": "int32",
"nullable": true
},
"AgentContactName": {
"type": "string",
"description": "AgentContactName",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ContactApiModelPost": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email",
"format": "email",
"nullable": true
},
"Phone": {
"pattern": "((\\(\\d{3}\\)?)|(\\d{3}))([\\s-./]?)(\\d{3})([\\s-./]?)(\\d{4})",
"type": "string",
"description": "Phone",
"nullable": true
},
"AgentContactId": {
"type": "integer",
"description": "AgentContactId",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ContactApiModelSpecialtyPost": {
"required": [
"FirstName",
"LastName"
],
"type": "object",
"properties": {
"FirstName": {
"minLength": 1,
"type": "string",
"description": "FirstName"
},
"LastName": {
"minLength": 1,
"type": "string",
"description": "LastName"
},
"Email": {
"type": "string",
"description": "Email",
"format": "email",
"nullable": true
},
"Phone": {
"pattern": "((\\(\\d{3}\\)?)|(\\d{3}))([\\s-./]?)(\\d{3})([\\s-./]?)(\\d{4})",
"type": "string",
"description": "Phone",
"nullable": true
},
"AgentContactId": {
"type": "integer",
"description": "AgentContactId",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ContactResponse": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Email": {
"type": "string",
"description": "Email",
"nullable": true
},
"Phone": {
"type": "string",
"description": "Phone",
"nullable": true
},
"AgentContactId": {
"type": "integer",
"description": "AgentContactId",
"format": "int32",
"nullable": true
},
"AgentContactName": {
"type": "string",
"description": "AgentContactName",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"CountryCodes": {
"enum": [
"225 = US"
],
"type": "integer",
"description": "us = 225",
"format": "int32"
},
"CreditCard": {
"type": "object",
"properties": {
"CreditCardNumber": {
"type": "string",
"description": "CreditCardNumber",
"nullable": true
},
"CardType": {
"$ref": "#/components/schemas/CreditCardType"
},
"CVV": {
"type": "string",
"description": "Cvv",
"nullable": true
},
"ExpirationMonth": {
"type": "integer",
"description": "ExpirationMonth",
"format": "int32"
},
"ExpirationYear": {
"type": "integer",
"description": "ExpirationYear",
"format": "int32"
}
},
"additionalProperties": false,
"description": "CreditCard"
},
"CreditCardType": {
"enum": [
"0 = Visa",
"1 = Mastercard",
"2 = Discover",
"3 = Amex",
"4 = DinersClub",
"5 = Valid",
"6 = JCB",
"-1 = Invalid"
],
"type": "integer",
"description": "CreditCardType",
"format": "int32"
},
"CrossSellGetReturnModel": {
"type": "object",
"properties": {
"DeepLink": {
"type": "string",
"description": "deep link",
"nullable": true
},
"BopQuoteNumber": {
"type": "integer",
"description": "BOP quote number",
"format": "int32"
},
"AnnualPremium": {
"type": "integer",
"description": "AnnualPremium",
"format": "int32"
},
"GeneralLiabilityLimits": {
"type": "string",
"description": "GeneralLiabilityLimits",
"nullable": true
},
"MedicalPayments": {
"type": "integer",
"description": "MedicalPayments",
"format": "int32"
},
"DamagestoPremisesLiabilityLimit": {
"type": "integer",
"description": "DamagestoPremisesLiabilityLimit",
"format": "int32"
},
"BusinessPersonalProperty": {
"type": "integer",
"description": "BusinessPersonalProperty",
"format": "int32"
},
"PropertyDeductible": {
"type": "string",
"description": "PropertyDeductible",
"nullable": true
},
"ExpansionEndorsement": {
"type": "string",
"description": "ExpansionEndorsement",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"CrossSellGetReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/CrossSellGetReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"CurrentPartnerModel": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "",
"nullable": true
},
"LastName": {
"type": "string",
"description": "",
"nullable": true
},
"Id": {
"type": "integer",
"description": "",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"DeleteLocationModel": {
"required": [
"AddressLine1"
],
"type": "object",
"properties": {
"LocationId": {
"maximum": 2147483647.0,
"minimum": 1.0,
"type": "integer",
"format": "int32"
},
"AddressLine1": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DeleteStopGapCoverageResponse": {
"type": "object",
"properties": {
"CoverageId": {
"type": "integer",
"format": "int32"
},
"Locations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressApiModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"DeleteStopGapCoverageResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/DeleteStopGapCoverageResponse"
}
},
"additionalProperties": false,
"description": ""
},
"DropdownOption": {
"type": "object",
"properties": {
"Key": {
"type": "string",
"description": "Key",
"nullable": true
},
"Text": {
"type": "string",
"description": "Text",
"nullable": true
}
},
"additionalProperties": false,
"description": "DropdownOption"
},
"ECheck": {
"type": "object",
"properties": {
"AccountNumber": {
"type": "string",
"description": "account number",
"nullable": true
},
"RoutingNumber": {
"type": "string",
"description": "bank routing number",
"nullable": true
},
"FinancialInstitution": {
"type": "string",
"description": "bank or financial instituation name",
"nullable": true
},
"AccountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false,
"description": ""
},
"EarnedPremium": {
"type": "object",
"properties": {
"State": {
"type": "string",
"nullable": true
},
"DateEarned": {
"type": "string",
"format": "date-time"
},
"Description": {
"type": "string",
"nullable": true
},
"EarnedAmount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"EligibilityDetail": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"description": "Type",
"nullable": true
},
"Eligibility": {
"type": "string",
"description": "Eligibility",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"EligibilityResponse_2": {
"type": "object",
"properties": {
"Eligibility": {
"type": "string",
"description": "Eligibility",
"nullable": true
},
"Details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EligibilityDetail"
},
"description": "Details",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"EligibilityStatus": {
"enum": [
"0 = Incomplete",
"1 = BindEligible",
"2 = Refer",
"3 = Decline"
],
"type": "integer",
"description": "",
"format": "int32"
},
"Endorsement": {
"type": "object",
"properties": {
"FormType": {
"type": "string",
"description": "FormType",
"nullable": true
},
"FormSubType": {
"type": "string",
"description": "FormSubType",
"nullable": true
},
"Id": {
"type": "string",
"description": "Id",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"MinOwnershipPercentage": {
"type": "number",
"description": "MinOwnershipPercentage",
"format": "double"
},
"MaxOwnershipPercentage": {
"type": "number",
"description": "MaxOwnershipPercentage",
"format": "double"
},
"OwnershipPctValidationMessage": {
"type": "string",
"description": "OwnershipPctValidationMessage",
"nullable": true
},
"MinAnnualCompensation": {
"type": "integer",
"format": "int32"
},
"MaxAnnualCompensation": {
"type": "integer",
"format": "int32"
},
"AnnualCompensationValidationMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"EndorsementEligibilityResponseVer2": {
"type": "object",
"properties": {
"EndorsementType": {
"type": "array",
"items": {
"type": "string"
},
"description": "EndorsementType",
"nullable": true
},
"IneligibilityReason": {
"type": "array",
"items": {
"type": "string"
},
"description": "IneligibilityReason",
"nullable": true
},
"CurrentPartners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrentPartnerModel"
},
"description": "CurrentPartners",
"nullable": true
},
"SubChangeReasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubChangeReasonModel"
},
"description": "SubChangeReasons",
"nullable": true
}
},
"additionalProperties": false,
"description": "Endorsement Eligibility Response Version 2"
},
"EndorsementEligibilityResponseVer2BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/EndorsementEligibilityResponseVer2"
}
},
"additionalProperties": false,
"description": ""
},
"EndorsementHistoryResponse": {
"type": "object",
"properties": {
"Summary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryEndmt"
},
"nullable": true
},
"Written": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WrittenPremium"
},
"nullable": true
},
"Earned": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EarnedPremium"
},
"nullable": true
}
},
"additionalProperties": false
},
"EndorsementHistoryResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/EndorsementHistoryResponse"
}
},
"additionalProperties": false,
"description": ""
},
"EndorsementInformation": {
"type": "object",
"properties": {
"ValidationMessage": {
"type": "string",
"description": "ValidationMessage",
"nullable": true
},
"Endorsements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Endorsement"
},
"description": "Endorsements",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"EndorsementResponseResult": {
"type": "object",
"additionalProperties": false
},
"ExcludingModifier": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Id",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"Value": {
"type": "string",
"description": "Value",
"nullable": true
}
},
"additionalProperties": false,
"description": "ExcludingModifier"
},
"FailedDependencyError": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Detail": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
},
"MessageCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Title": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"FailedDependencyErrorBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/FailedDependencyError"
}
},
"additionalProperties": false,
"description": ""
},
"FeinPostModel": {
"required": [
"Fein"
],
"type": "object",
"properties": {
"Fein": {
"minLength": 1,
"type": "string",
"description": "FEIN has to be 9 digit and is required"
},
"QuoteId": {
"type": "integer",
"description": "QuoteId is not required",
"format": "int32"
}
},
"additionalProperties": false,
"description": ""
},
"FilePostModel": {
"required": [
"FileData"
],
"type": "object",
"properties": {
"WindowsFileType": {
"type": "string",
"description": "WindowsFileType",
"nullable": true
},
"FileData": {
"type": "string",
"description": "FileData",
"format": "byte"
},
"DisplayName": {
"type": "string",
"description": "DisplayName",
"nullable": true
}
},
"additionalProperties": false,
"description": "FilePostModel"
},
"FirmWithName": {
"type": "object",
"properties": {
"FirmId": {
"type": "integer",
"description": "Firm Id",
"format": "int32"
},
"FirmName": {
"type": "string",
"description": "Firm Name",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"FirmWithRate": {
"type": "object",
"properties": {
"FirmId": {
"type": "integer",
"format": "int32"
},
"BaseRate": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"ForbiddenError": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Detail": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
},
"MessageCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Title": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"ForbiddenErrorIApiResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"CorrelationID": {
"type": "string",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Paging": {
"$ref": "#/components/schemas/ApiPaging"
},
"MaxMsgIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MaxErrIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"IsOk": {
"type": "boolean"
},
"ApiResponseVersion": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Data": {
"$ref": "#/components/schemas/ForbiddenError"
}
},
"additionalProperties": false
},
"ForeignVoluntaryCoverageReadModel": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"format": "int32"
},
"GovState": {
"type": "string",
"nullable": true
},
"Employee": {
"type": "string",
"nullable": true
},
"Location": {
"type": "string",
"nullable": true
},
"WcLaw": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ForeignVoluntaryCoverageReadModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ForeignVoluntaryCoverageWriteModel": {
"required": [
"Employee",
"GovState",
"Location",
"WcLaw"
],
"type": "object",
"properties": {
"GovState": {
"minLength": 1,
"type": "string"
},
"Employee": {
"minLength": 1,
"type": "string"
},
"Location": {
"minLength": 1,
"type": "string"
},
"WcLaw": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"FormDataField": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"description": "IndexId",
"format": "int32"
},
"Label": {
"type": "string",
"description": "Label",
"nullable": true
},
"Required": {
"type": "boolean",
"description": "Required"
},
"CanEnterFreeText": {
"type": "boolean",
"description": "CanEnterFreeText"
},
"CurrentValue": {
"type": "string",
"description": "",
"nullable": true
},
"PresetValues": {
"type": "array",
"items": {
"type": "string"
},
"description": "PresetValues",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"FormDataFieldRequest": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"description": "IndexId",
"format": "int32"
},
"Values": {
"type": "string",
"description": "PresetValues",
"nullable": true
}
},
"additionalProperties": false,
"description": "FormDataField"
},
"FullQuoteReturnModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date. \nOnly for Specialty Program.",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"FirmId": {
"type": "string",
"nullable": true
},
"ExperienceModifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Only for WC.\nPlease use Modifiers section instead of this section.",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Only for Specialty Program.",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "Please use this new section instead of the Experience Modifier section.",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
},
"AdditionalInformation": {
"$ref": "#/components/schemas/AdditionalInfoReturnModel"
},
"QuoteStatus": {
"type": "string",
"description": "QuoteStatus",
"nullable": true
},
"ClosedDate": {
"type": "string",
"description": "Closed Date",
"format": "date-time"
},
"ForeignVoluntaryCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModel"
},
"nullable": true
},
"SpecificWaivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "FullQuoteReturnModel"
},
"FullQuoteReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/FullQuoteReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"GetClassCodeWithFirmResponse": {
"type": "object",
"properties": {
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeWithFirm"
},
"nullable": true
},
"Firms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FirmWithName"
},
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"GetClassCodeWithFirmResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/GetClassCodeWithFirmResponse"
}
},
"additionalProperties": false,
"description": ""
},
"GetDividendModel": {
"type": "object",
"properties": {
"DividendName": {
"type": "string",
"nullable": true
},
"DividendId": {
"type": "integer",
"format": "int32"
},
"DividendSubTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetDividendModelBase": {
"type": "object",
"properties": {
"DividendName": {
"type": "string",
"nullable": true
},
"DividendId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GetEligibilityResponse": {
"type": "object",
"properties": {
"Eligibility": {
"type": "string",
"description": "Eligibility",
"nullable": true
},
"Details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EligibilityDetail"
},
"description": "Details",
"nullable": true
},
"QuoteStatus": {
"type": "string",
"description": "Quote status, could be BindEligible, refer, ...",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"GetEligibilityResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/GetEligibilityResponse"
}
},
"additionalProperties": false,
"description": ""
},
"GetFirmResponseDto": {
"type": "object",
"properties": {
"FirmId": {
"type": "integer",
"format": "int32"
},
"FirmName": {
"type": "string",
"nullable": true
},
"FirmNameShort": {
"type": "string",
"nullable": true
},
"AuthorizedState": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GetFirmResponseDtoIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetFirmResponseDto"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"GetQuoteSpecialtyReturnModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
},
"ForeignVoluntaryCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModel"
},
"nullable": true
},
"SpecificWaivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"nullable": true
},
"AdditionalInformation": {
"$ref": "#/components/schemas/AdditionalInfoReturnModel"
},
"Dividends": {
"$ref": "#/components/schemas/GetDividendModelBase"
},
"QuoteStatus": {
"type": "string",
"description": "Quote Status",
"nullable": true
},
"ClosedDate": {
"type": "string",
"description": "Closed Date",
"format": "date-time"
}
},
"additionalProperties": false
},
"GetQuoteSpecialtyReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/GetQuoteSpecialtyReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"GetQuoteSpecialtyReturnModelV2": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date. \nOnly for Specialty Program.",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"FirmId": {
"type": "string",
"nullable": true
},
"ExperienceModifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Only for WC.\nPlease use Modifiers section instead of this section.",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Only for Specialty Program.",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "Please use this new section instead of the Experience Modifier section.",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
},
"AdditionalInformation": {
"$ref": "#/components/schemas/AdditionalInfoReturnModel"
},
"QuoteStatus": {
"type": "string",
"description": "QuoteStatus",
"nullable": true
},
"ClosedDate": {
"type": "string",
"description": "Closed Date",
"format": "date-time"
},
"ForeignVoluntaryCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModel"
},
"nullable": true
},
"SpecificWaivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"nullable": true
},
"Dividends": {
"$ref": "#/components/schemas/GetDividendModelBase"
}
},
"additionalProperties": false
},
"GetQuoteSpecialtyReturnModelV2BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/GetQuoteSpecialtyReturnModelV2"
}
},
"additionalProperties": false,
"description": ""
},
"GetSicNaicsResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "2 letter state",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "class code",
"nullable": true
},
"Eligibility": {
"type": "string",
"description": "eligibility: refer, decline, bindeligible",
"nullable": true
},
"Information": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeInformation"
},
"description": "",
"nullable": true
},
"AllStatesInformation": {
"type": "string",
"description": "when state is not provided all states are being send as a csv file",
"format": "byte",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"GetSicNaicsResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetSicNaicsResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"GetSpecialtyQuoteAvailableDividendsResponseModel": {
"type": "object",
"properties": {
"SingleState": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDividendModel"
},
"nullable": true
},
"MultiState": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDividendModel"
},
"nullable": true
},
"NationalGroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetDividendModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetSpecialtyQuoteAvailableDividendsResponseModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/GetSpecialtyQuoteAvailableDividendsResponseModel"
}
},
"additionalProperties": false,
"description": ""
},
"GetUnderwritingMessage": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"format": "int32"
},
"User": {
"type": "string",
"description": "Name",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AgentEntry": {
"type": "boolean"
},
"Sent": {
"type": "string",
"description": "Date Sent",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Underwriter Message"
},
"GetUnderwritingMessageListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetUnderwritingMessage"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"HttpStatusCode": {
"enum": [
"100 = Continue",
"101 = SwitchingProtocols",
"102 = Processing",
"103 = EarlyHints",
"200 = OK",
"201 = Created",
"202 = Accepted",
"203 = NonAuthoritativeInformation",
"204 = NoContent",
"205 = ResetContent",
"206 = PartialContent",
"207 = MultiStatus",
"208 = AlreadyReported",
"226 = IMUsed",
"300 = MultipleChoices",
"300 = Ambiguous",
"301 = MovedPermanently",
"301 = Moved",
"302 = Found",
"302 = Redirect",
"303 = SeeOther",
"303 = RedirectMethod",
"304 = NotModified",
"305 = UseProxy",
"306 = Unused",
"307 = TemporaryRedirect",
"307 = RedirectKeepVerb",
"308 = PermanentRedirect",
"400 = BadRequest",
"401 = Unauthorized",
"402 = PaymentRequired",
"403 = Forbidden",
"404 = NotFound",
"405 = MethodNotAllowed",
"406 = NotAcceptable",
"407 = ProxyAuthenticationRequired",
"408 = RequestTimeout",
"409 = Conflict",
"410 = Gone",
"411 = LengthRequired",
"412 = PreconditionFailed",
"413 = RequestEntityTooLarge",
"414 = RequestUriTooLong",
"415 = UnsupportedMediaType",
"416 = RequestedRangeNotSatisfiable",
"417 = ExpectationFailed",
"421 = MisdirectedRequest",
"422 = UnprocessableEntity",
"422 = UnprocessableContent",
"423 = Locked",
"424 = FailedDependency",
"426 = UpgradeRequired",
"428 = PreconditionRequired",
"429 = TooManyRequests",
"431 = RequestHeaderFieldsTooLarge",
"451 = UnavailableForLegalReasons",
"500 = InternalServerError",
"501 = NotImplemented",
"502 = BadGateway",
"503 = ServiceUnavailable",
"504 = GatewayTimeout",
"505 = HttpVersionNotSupported",
"506 = VariantAlsoNegotiates",
"507 = InsufficientStorage",
"508 = LoopDetected",
"510 = NotExtended",
"511 = NetworkAuthenticationRequired"
],
"type": "integer",
"format": "int32"
},
"HusbandAndWifeBase": {
"type": "object",
"properties": {
"Spouse1": {
"type": "string",
"description": "The spouse1 and spouse2 names are only required for single state quotes in CA if the legal entity entered is Married Joint Sole Proprietorship",
"nullable": true
},
"Spouse2": {
"type": "string",
"description": "The spouse1 and spouse2 names are only required for single state quotes in CA if the legal entity entered is Married Joint Sole Proprietorship",
"nullable": true
}
},
"additionalProperties": false
},
"IncludingExcluding": {
"enum": [
"0 = I",
"1 = E"
],
"type": "integer",
"description": "",
"format": "int32"
},
"Insured": {
"required": [
"AdditionalLocations",
"Name",
"State",
"TaxId"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "Name of Additional insured; cannot be a DBA's name - use DbaName property"
},
"TaxId": {
"maxLength": 12,
"minLength": 1,
"type": "string",
"description": "TaxId"
},
"State": {
"maxLength": 2,
"minLength": 1,
"type": "string",
"description": "For states that require the insured to register for and provide a state issued Unemployment Number. If such state, enter the state where the number is registered."
},
"LegalEntity": {
"maximum": 2147483647.0,
"minimum": 1.0,
"type": "integer",
"description": "Use same options to set this as when the quote was created. Look up available Legal Entities if unknown.",
"format": "int32"
},
"UnemploymentId": {
"type": "string",
"description": "If the Insured State is in HI, ME, MN, or RI, an UnemploymentId is required.\nIn HI, it must be exactly 10 characters\nIn ME and RI, it must be exactly 10 digits\nIn MN, it must be between 8-12 digits",
"nullable": true
},
"DbaName": {
"maxLength": 100,
"type": "string",
"description": "DbaName",
"nullable": true
},
"AdditionalLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInsuredLocation"
},
"description": "Any additional locations associated with the Additional Insured.\nThe quote must have exposure in location's state to be added.\nOne location is required per insured. If an insured is deleted, all it's linked locations will be deleted as well."
}
},
"additionalProperties": false,
"description": ""
},
"InsuredReturnModel": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Unique Id associated with Isnured",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Name",
"nullable": true
},
"TaxId": {
"type": "string",
"description": "TaxId",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"DbaName": {
"type": "string",
"description": "DbaName",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AdditionalLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalLocationReturnModel"
},
"description": "AdditionalLocations",
"nullable": true
}
},
"additionalProperties": false,
"description": "InsuredReturnModel"
},
"Invoice": {
"type": "object",
"properties": {
"PremiumAmount": {
"type": "number",
"description": "PremiumAmount",
"format": "double"
},
"Taxes": {
"type": "number",
"description": "Taxes",
"format": "double"
},
"Fees": {
"type": "number",
"description": "Fees",
"format": "double"
},
"TotalBillAmount": {
"type": "number",
"description": "Total of PremiumAmount, Taxes and Fees for invoice",
"format": "double",
"readOnly": true
},
"BillDate": {
"type": "string",
"description": "BillDate",
"format": "date-time"
},
"DueDate": {
"type": "string",
"description": "DueDate",
"format": "date-time"
},
"IsDownPayment": {
"type": "boolean",
"description": "IsDownPayment"
}
},
"additionalProperties": false,
"description": "Invoice"
},
"LegalEntityResponse": {
"type": "object",
"properties": {
"LegalEntityId": {
"type": "integer",
"description": "Int associated with a Legal Entity's description. Save this value.",
"format": "int32"
},
"EntityDescription": {
"type": "string",
"description": "Description of Legal Entity for display",
"nullable": true
}
},
"additionalProperties": false,
"description": "LegalEntityResponse"
},
"LegalEntityResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntityResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"Limit": {
"type": "object",
"properties": {
"LiabilityLimits": {
"$ref": "#/components/schemas/PolicyLiabilityLimitDetails"
}
},
"additionalProperties": false
},
"LimitInformation": {
"type": "object",
"properties": {
"ExcludedOfficerLimit": {
"type": "integer",
"description": "ExcludedOfficerLimit",
"format": "int32"
},
"ValidationMessage": {
"type": "string",
"description": "ValidationMessage",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"LogException": {
"type": "object",
"properties": {
"ExceptionId": {
"type": "string",
"format": "uuid"
},
"Module": {
"type": "string",
"nullable": true
},
"Class": {
"type": "string",
"nullable": true
},
"TargetSite": {
"type": "string",
"nullable": true
},
"HttpWebEventCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatusValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatusCode": {
"type": "string",
"nullable": true
},
"HttpHtmlMessage": {
"type": "string",
"nullable": true
},
"Properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"InnerException": {
"$ref": "#/components/schemas/LogException"
},
"Message": {
"type": "string",
"nullable": true
},
"Source": {
"type": "string",
"nullable": true
},
"StackTrace": {
"type": "string",
"nullable": true
},
"HelpLink": {
"type": "string",
"nullable": true
},
"Method": {
"type": "string",
"nullable": true
},
"Data": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"ErrorCode": {
"type": "string",
"nullable": true
},
"ExceptionType": {
"type": "string",
"nullable": true
},
"BaseException": {
"$ref": "#/components/schemas/LogException"
}
},
"additionalProperties": false
},
"MessageToUnderwriterModel": {
"required": [
"Message"
],
"type": "object",
"properties": {
"Message": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
"additionalProperties": false
},
"MessageToUnderwriterModelV2": {
"required": [
"Message",
"Reason"
],
"type": "object",
"properties": {
"Message": {
"minLength": 1,
"type": "string"
},
"Reason": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"Modifier": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Id",
"nullable": true
},
"Value": {
"type": "string",
"description": "Value",
"nullable": true
},
"ModifierUiInformation": {
"$ref": "#/components/schemas/ModifierUiInformation"
},
"ExcludingModifier": {
"$ref": "#/components/schemas/ExcludingModifier"
},
"State": {
"type": "string",
"description": "State",
"nullable": true
}
},
"additionalProperties": false,
"description": "Modifier"
},
"ModifierPatchModel": {
"type": "object",
"properties": {
"LoadEligibility": {
"type": "boolean",
"description": "LoadEligibility"
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"description": "StateModifiers",
"nullable": true
}
},
"additionalProperties": false,
"description": "ModifierPatchModel"
},
"ModifierScheduleRationale": {
"type": "object",
"properties": {
"RationaleTypeId": {
"type": "integer",
"description": "Rationale Type Id",
"format": "int32"
},
"RationaleName": {
"type": "string",
"description": "Rationale Name",
"nullable": true
}
},
"additionalProperties": false
},
"ModifierScheduleResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModifierScheduleResponseDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ModifierScheduleResponseDetail": {
"type": "object",
"properties": {
"CategoryTypeId": {
"type": "integer",
"description": "Category Type Id",
"format": "int32"
},
"CategoryName": {
"type": "string",
"description": "Category Name",
"nullable": true
},
"Amount": {
"type": "number",
"description": "Amount",
"format": "double"
},
"IsSystemDefault": {
"type": "boolean"
},
"Rationales": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModifierScheduleRationale"
},
"nullable": true
}
},
"additionalProperties": false
},
"ModifierScheduleResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModifierScheduleResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"ModifierUiInformation": {
"type": "object",
"properties": {
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"RegexFormatting": {
"type": "string",
"description": "RegexFormatting",
"nullable": true
},
"ModifierType": {
"type": "string",
"description": "ModifierType",
"nullable": true
},
"OnlyAvailableValues": {
"type": "array",
"items": {
"type": "number",
"format": "double",
"nullable": true
},
"description": "OnlyAvailableValues",
"nullable": true
},
"MinValue": {
"type": "number",
"description": "MinValue",
"format": "double",
"nullable": true
},
"MaxValue": {
"type": "number",
"description": "MaxValue",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "ModifierUiInformation"
},
"ModifiersPatchResponse": {
"type": "object",
"properties": {
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
}
},
"additionalProperties": false,
"description": "ModifiersPatchResponse"
},
"ModifiersPatchResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/ModifiersPatchResponse"
}
},
"additionalProperties": false,
"description": ""
},
"NaturalLanguageResponse": {
"type": "object",
"properties": {
"ProductLine": {
"type": "string",
"description": "ProductLine",
"nullable": true
},
"SearchResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResult"
},
"description": "SearchResults",
"nullable": true
}
},
"additionalProperties": false,
"description": "NaturalLanguageResponse"
},
"NaturalLanguageResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NaturalLanguageResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"NetRateResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescription": {
"type": "string",
"description": "ClassDescription",
"nullable": true
},
"NetRate": {
"type": "number",
"description": "NetRate",
"format": "double"
}
},
"additionalProperties": false,
"description": "NetRateResponse"
},
"NetRateResponseListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NetRateResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"NonrenewCodeModel": {
"type": "object",
"properties": {
"NonrenewReasonCode": {
"type": "integer",
"description": "NonrenewReasonCode",
"format": "int32"
},
"NonrenewReasonDesc": {
"type": "string",
"description": "NonrenewReasonDesc",
"nullable": true
},
"StateExclusion": {
"type": "array",
"items": {
"type": "string"
},
"description": "StateExclusion",
"nullable": true
}
},
"additionalProperties": false,
"description": "NonrenewCodeModel"
},
"NonrenewCodeModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NonrenewCodeModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"NotFoundError": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Detail": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
},
"MessageCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Title": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"NotFoundErrorBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/NotFoundError"
}
},
"additionalProperties": false,
"description": ""
},
"NotFoundErrorIApiResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"CorrelationID": {
"type": "string",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Paging": {
"$ref": "#/components/schemas/ApiPaging"
},
"MaxMsgIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MaxErrIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"IsOk": {
"type": "boolean"
},
"ApiResponseVersion": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Data": {
"$ref": "#/components/schemas/NotFoundError"
}
},
"additionalProperties": false
},
"Officer": {
"required": [
"EndorsementId",
"FormType",
"Name",
"State",
"Type"
],
"type": "object",
"properties": {
"Name": {
"maxLength": 30,
"minLength": 1,
"type": "string",
"description": "name"
},
"EndorsementId": {
"maxLength": 12,
"minLength": 1,
"type": "string",
"description": "Get available endorsements from extras/endorsements endpoint. If none, officers cannot be added. Endorsement state and Officer state must be the same."
},
"Type": {
"$ref": "#/components/schemas/OfficerTypes"
},
"State": {
"maxLength": 2,
"minLength": 1,
"type": "string",
"description": "state"
},
"OfficeHeld": {
"maxLength": 30,
"type": "string",
"description": "OfficeHeld",
"nullable": true
},
"OwnershipPercent": {
"maximum": 100.0,
"minimum": 0.0,
"type": "number",
"description": "OwnershipPercent",
"format": "double"
},
"FormType": {
"$ref": "#/components/schemas/IncludingExcluding"
},
"DateOfBirth": {
"type": "string",
"description": "DateOfBirth",
"format": "date",
"nullable": true
},
"AnnualCompensation": {
"maximum": 2147483647.0,
"minimum": 0.0,
"type": "integer",
"description": "Only required if the state is NE and the legal entity is Nonprofit Corporation. It is not saved in other situations.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"OfficerInformationModel": {
"type": "object",
"properties": {
"OfficerType": {
"type": "string",
"description": "OfficerType",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"LimitInformation": {
"$ref": "#/components/schemas/LimitInformation"
},
"EndorsementInformation": {
"$ref": "#/components/schemas/EndorsementInformation"
}
},
"additionalProperties": false,
"description": ""
},
"OfficerInformationModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/OfficerInformationModel"
}
},
"additionalProperties": false,
"description": ""
},
"OfficerInformationModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OfficerInformationModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"OfficerReturnModel": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Unique Id associated with Officer",
"format": "int32"
},
"Name": {
"type": "string",
"description": "Name",
"nullable": true
},
"EndorsementId": {
"type": "string",
"description": "EndorsementId",
"nullable": true
},
"Type": {
"type": "string",
"description": "Type",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"OwnershipPercent": {
"type": "number",
"description": "OwnershipPercent",
"format": "double"
},
"FormType": {
"type": "string",
"description": "FormType",
"nullable": true
},
"DateOfBirth": {
"type": "string",
"description": "DateOfBirth",
"nullable": true
},
"OfficeHeld": {
"type": "string",
"description": "OfficeHeld",
"nullable": true
},
"AnnualCompensation": {
"type": "integer",
"description": "",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "OfficerReturnModel"
},
"OfficerTypes": {
"enum": [
"1 = Officers",
"2 = Partners",
"3 = Other",
"4 = SoleProprietor",
"5 = Member"
],
"type": "integer",
"description": "",
"format": "int32"
},
"Operation": {
"type": "object",
"properties": {
"OperationType": {
"$ref": "#/components/schemas/OperationType"
},
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
}
},
"additionalProperties": false
},
"OperationType": {
"enum": [
"0 = Add",
"1 = Remove",
"2 = Replace",
"3 = Move",
"4 = Copy",
"5 = Test",
"6 = Invalid"
],
"type": "integer",
"format": "int32"
},
"OptionalAddressApiModel": {
"type": "object",
"properties": {
"Line1": {
"type": "string",
"description": "Line1",
"nullable": true
},
"Line2": {
"type": "string",
"description": "Line2",
"nullable": true
},
"City": {
"type": "string",
"description": "City",
"nullable": true
},
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Zip": {
"type": "string",
"description": "Zip",
"nullable": true
}
},
"additionalProperties": false
},
"PatchQuotePatnerRequest": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Organization": {
"type": "string",
"description": "Organization",
"nullable": true
}
},
"additionalProperties": false,
"description": "PatchQuotePatnerRequest"
},
"PatchQuoteSpecialtyReturnModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"nullable": true
}
},
"additionalProperties": false
},
"PatchQuoteSpecialtyReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PatchQuoteSpecialtyReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"PatchQuoteSpecialtyReturnModelV2": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date. \nOnly for Specialty Program.",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"FirmId": {
"type": "string",
"nullable": true
},
"ExperienceModifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Only for WC.\nPlease use Modifiers section instead of this section.",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Only for Specialty Program.",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "Please use this new section instead of the Experience Modifier section.",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
},
"AdditionalInformation": {
"$ref": "#/components/schemas/AdditionalInfoReturnModel"
},
"QuoteStatus": {
"type": "string",
"description": "QuoteStatus",
"nullable": true
},
"ClosedDate": {
"type": "string",
"description": "Closed Date",
"format": "date-time"
},
"ForeignVoluntaryCoverage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ForeignVoluntaryCoverageReadModel"
},
"nullable": true
},
"SpecificWaivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"PatchQuoteSpecialtyReturnModelV2BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PatchQuoteSpecialtyReturnModelV2"
}
},
"additionalProperties": false,
"description": ""
},
"PayerInfoRequest": {
"required": [
"EmailAddress"
],
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "payer's first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "payer's last name",
"nullable": true
},
"Address": {
"$ref": "#/components/schemas/Address"
},
"EmailAddress": {
"minLength": 1,
"type": "string",
"description": "payer's emial"
},
"Phone": {
"type": "string",
"description": "payer's phone",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PaymentPlan": {
"required": [
"PaymentPlanType"
],
"type": "object",
"properties": {
"PaymentPlanType": {
"minLength": 1,
"type": "string",
"description": "PaymentPlanType. Available options: None PAYO PSR"
},
"InsuredName": {
"type": "string",
"description": "Insured's Name",
"nullable": true
},
"InsuredEmail": {
"type": "string",
"description": "Insured's Email",
"nullable": true
},
"AgentName": {
"type": "string",
"description": "Agent Name",
"nullable": true
},
"AgentEmail": {
"type": "string",
"description": "Agent Email",
"nullable": true
},
"AccountManagerCSRName": {
"type": "string",
"description": "Account Manager/CSR Name",
"nullable": true
},
"AccountManagerCSREmail": {
"type": "string",
"description": "Account Manager/CSR Email",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "Payroll Company Id",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "PaymentPlan"
},
"PaymentPlanPostModel": {
"required": [
"BillingType",
"NumberPayments",
"PaymentPlan",
"PaymentPlanId"
],
"type": "object",
"properties": {
"DepositPercent": {
"type": "number",
"description": "The deposit percent is a required if the payment plan selected requires more than 1 payment be made.\n\nWe do allow 0 if you wish to include for those payment plans that do not require a deposit.",
"format": "double"
},
"NumberPayments": {
"type": "integer",
"description": "NumberPayments",
"format": "int32"
},
"PaymentPlanId": {
"type": "integer",
"description": "PaymentPlanId",
"format": "int32"
},
"IsDirectDebit": {
"type": "boolean",
"description": "isDirectDebit is required if the payment plan selected is marked as Direct Debit in the description."
},
"PaymentPlan": {
"$ref": "#/components/schemas/PaymentPlan"
},
"BillingType": {
"minLength": 1,
"type": "string",
"description": "Options: \"Direct\" (billed to insured), \"Agency\" (billed to agency)."
}
},
"additionalProperties": false,
"description": "PaymentPlanPostModel"
},
"PaymentPlanResponse": {
"type": "object",
"properties": {
"IsCurrentPaymentPlan": {
"type": "boolean",
"description": "If a payment plan has been saved to a quote, this will be set to true for that plan"
},
"PaymentPlan": {
"$ref": "#/components/schemas/PaymentPlanType"
},
"PaymentPlanDescription": {
"type": "string",
"description": "PaymentPlanDescription",
"nullable": true
},
"PaymentPlanId": {
"type": "integer",
"description": "PaymentPlanId",
"format": "int32"
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"NumberPayments": {
"type": "integer",
"description": "NumberPayments",
"format": "int32"
},
"TotalCost": {
"type": "number",
"description": "Includes total premium, total state taxes and total billing fees",
"format": "double"
},
"TotalPremium": {
"type": "number",
"description": "total premium",
"format": "double"
},
"TotalStateTaxes": {
"type": "number",
"description": "total state taxes",
"format": "double"
},
"TotalBillingFees": {
"type": "number",
"description": "total fees",
"format": "double"
},
"DepositPercent": {
"type": "number",
"description": "Percent of total premium paid with down payment",
"format": "double"
},
"DownPayment": {
"type": "number",
"description": "down payment",
"format": "double"
},
"IsDirectDebit": {
"type": "boolean",
"description": "true if it is direct debit"
},
"Message": {
"type": "string",
"description": "Contains a disclaimer if the IsDirectDebit field is true",
"nullable": true
},
"Invoices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Invoice"
},
"description": "Invoice information for the saved installment schedule",
"nullable": true
}
},
"additionalProperties": false,
"description": "PaymentPlanResponse"
},
"PaymentPlanResponseV2": {
"type": "object",
"properties": {
"Direct": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentPlanResponse"
},
"description": "Direct Payment Plans (Includes PAYO)",
"nullable": true
},
"Agency": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentPlanResponse"
},
"description": "Agency Payment Plans",
"nullable": true
}
},
"additionalProperties": false,
"description": "Return Model used in V2 (GET) PaymentPlan Endpoint"
},
"PaymentPlanResponseV2BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PaymentPlanResponseV2"
}
},
"additionalProperties": false,
"description": ""
},
"PaymentPlanType": {
"enum": [
"0 = None",
"1 = Null",
"2 = PAYO",
"3 = PSR"
],
"type": "integer",
"description": "PaymenPlanType Enum",
"format": "int32"
},
"PaymentPostModel": {
"required": [
"PayerInfo",
"PaymentSystemInfo",
"QuoteId",
"SendEmail"
],
"type": "object",
"properties": {
"QuoteId": {
"type": "integer",
"description": "QuoteId",
"format": "int32"
},
"SendEmail": {
"type": "boolean",
"description": "set to true if you want to send a confirmation email"
},
"PayerInfo": {
"$ref": "#/components/schemas/PayerInfoRequest"
},
"ECheck": {
"$ref": "#/components/schemas/ECheck"
},
"CreditCard": {
"$ref": "#/components/schemas/CreditCard"
},
"PaymentSystemInfo": {
"$ref": "#/components/schemas/PaymentSystemInfo"
}
},
"additionalProperties": false,
"description": ""
},
"PaymentResponse": {
"type": "object",
"properties": {
"AmountProccessed": {
"type": "number",
"description": "the amount user made payment",
"format": "double"
},
"RemainingPolicyPayment": {
"type": "number",
"description": "total of all the future payments",
"format": "double"
},
"TransactionId": {
"type": "string",
"description": "PaymentsApi is sending a transaction id for tracking",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PaymentResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PaymentResponse"
}
},
"additionalProperties": false,
"description": ""
},
"PaymentSystemInfo": {
"required": [
"Amount",
"PaymentDescription"
],
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "id , user does not provide it",
"format": "int32"
},
"Name": {
"type": "string",
"description": "name could be policy numnber",
"nullable": true
},
"LOB": {
"type": "string",
"description": "WC",
"nullable": true
},
"Type": {
"type": "string",
"description": "Type could be \"Policy\"",
"nullable": true
},
"PayrollMonth": {
"type": "string",
"description": "payroll month",
"nullable": true
},
"Amount": {
"$ref": "#/components/schemas/BasePaymentAmount"
},
"TaxAmount": {
"$ref": "#/components/schemas/BasePaymentAmount"
},
"FeeAmount": {
"$ref": "#/components/schemas/BasePaymentAmount"
},
"PaymentDescription": {
"minLength": 1,
"type": "string",
"description": "PaymentDescription"
}
},
"additionalProperties": false,
"description": ""
},
"PolicyAdditionalLocation": {
"type": "object",
"properties": {
"LocationNumber": {
"type": "integer",
"format": "int32"
},
"Line1": {
"type": "string",
"nullable": true
},
"Line2": {
"type": "string",
"nullable": true
},
"City": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Zip": {
"type": "string",
"nullable": true
},
"EmployeeCount": {
"type": "integer",
"format": "int32"
},
"NameInsured": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PolicyClassCode": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"nullable": true
},
"DescriptionCode": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Payroll": {
"type": "integer",
"format": "int32"
},
"FTEmployees": {
"type": "number",
"format": "double"
},
"PTEmployees": {
"type": "number",
"format": "double"
},
"Rate": {
"type": "number",
"format": "double"
},
"Premium": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PolicyDividentDetailsResponse": {
"type": "object",
"properties": {
"PlanDescription": {
"type": "string",
"nullable": true
},
"ApprovedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"DivCalcDone": {
"type": "string",
"format": "date-time",
"nullable": true
},
"DividendAmount": {
"type": "integer",
"format": "int32"
},
"DivWrittenPremium": {
"type": "integer",
"format": "int32"
},
"NetIncurred": {
"type": "integer",
"format": "int32"
},
"States": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"ApprovedBy": {
"type": "string",
"nullable": true
},
"DisqualifyNotes": {
"type": "string",
"nullable": true
},
"DividentPercentage": {
"type": "number",
"format": "double"
},
"DivLossRatio": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"PolicyDividentDetailsResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PolicyDividentDetailsResponse"
}
},
"additionalProperties": false,
"description": ""
},
"PolicyDocument": {
"type": "object",
"properties": {
"DocumentName": {
"type": "string",
"description": "DocumentName - it comes from a dictionray , it is based on the file type",
"nullable": true
},
"FileType": {
"type": "string",
"description": "FileType",
"nullable": true
},
"DocumentType": {
"type": "string",
"description": "DocumentType",
"nullable": true
},
"LibraryIndex": {
"type": "integer",
"description": "LibraryIndex",
"format": "int32"
},
"DateReceived": {
"type": "string",
"description": "LibraryIndex",
"nullable": true
},
"EndmtNum": {
"type": "integer",
"description": "EndmtNum for sorting documents.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "PolicyDocument"
},
"PolicyDocumentIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyDocument"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PolicyEndorsementBulkResponse": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"nullable": true
},
"Endorsements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EndorsementResponseResult"
},
"nullable": true
},
"Reason": {
"type": "string",
"description": "Reason",
"nullable": true
}
},
"additionalProperties": false,
"description": "PolicyEndorsementResponse"
},
"PolicyEndorsementBulkResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyEndorsementBulkResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PolicyEndorsementV3": {
"type": "object",
"properties": {
"Type": {
"type": "string",
"description": "Type",
"nullable": true
},
"Reason": {
"type": "string",
"description": "Reason",
"nullable": true
}
},
"additionalProperties": false,
"description": "PolicyEndorsement"
},
"PolicyInformationResponse": {
"type": "object",
"properties": {
"MasterAccountId": {
"type": "integer",
"format": "int32"
},
"Policy": {
"type": "string",
"nullable": true
},
"PolicyId": {
"type": "integer",
"format": "int32"
},
"Quote": {
"type": "string",
"nullable": true
},
"Premium": {
"type": "string",
"nullable": true
},
"DBA": {
"type": "string",
"nullable": true
},
"BusinessName": {
"type": "string",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/BaseAddressModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/BaseAddressModel"
},
"Fein": {
"type": "string",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"format": "date-time"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"InsuredContact": {
"$ref": "#/components/schemas/BaseContactResponse"
},
"LegalEntity": {
"type": "string",
"nullable": true
},
"PolicyStatus": {
"type": "string",
"nullable": true
},
"StateTaxes": {
"type": "integer",
"format": "int32"
},
"EstimatedAnnual": {
"type": "integer",
"format": "int32"
},
"EarnedPremium": {
"type": "string",
"nullable": true
},
"RatingZip": {
"type": "string",
"nullable": true
},
"CancelInformation": {
"$ref": "#/components/schemas/CancelInformation"
},
"CompanyWebsite": {
"type": "string",
"nullable": true
},
"CarrierName": {
"type": "string",
"nullable": true
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyClassCode"
},
"nullable": true
},
"Officers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyOfficer"
},
"nullable": true
},
"StopGapCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StopGapCoverage"
},
"nullable": true
},
"Partners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyPartner"
},
"nullable": true
},
"Limits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Limit"
},
"nullable": true
},
"AdditionalInsureds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInsured"
},
"nullable": true
},
"PrimaryInsuredAdditionalLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrimaryInsuredAdditionalLocation"
},
"nullable": true
},
"AdditionalLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyAdditionalLocation"
},
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"SpecificWaivers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"nullable": true
},
"NonRenewalDate": {
"type": "string",
"nullable": true
},
"NonRenewalReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PolicyInformationResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PolicyInformationResponse"
}
},
"additionalProperties": false,
"description": ""
},
"PolicyLiabilityLimitDetails": {
"type": "object",
"properties": {
"LimitPerAccident": {
"type": "integer",
"format": "int32"
},
"BodilyInjuryFromDiseasePolicyLimit": {
"type": "integer",
"format": "int32"
},
"BodilyInjuryFromDiseasePerEmployeeLimit": {
"type": "integer",
"format": "int32"
},
"LiabilityLimits": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PolicyOfficer": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"nullable": true
},
"EndorsementId": {
"type": "string",
"nullable": true
},
"Type": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"OwnershipPercent": {
"type": "number",
"format": "double"
},
"FormType": {
"type": "string",
"nullable": true
},
"OfficerDOB": {
"type": "string",
"format": "date-time"
},
"OfficeHeld": {
"type": "string",
"nullable": true
},
"AnnualCompensation": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PolicyPartner": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"Organization": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PolicyRenewalClassCode": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassCodeDescription": {
"type": "string",
"description": "ClassCodeDescription",
"nullable": true
},
"ExposureLimit": {
"type": "string",
"description": "ExposureLimit",
"nullable": true
},
"Rate": {
"type": "number",
"description": "Rate",
"format": "double"
}
},
"additionalProperties": false,
"description": "PolicyRenewalClassCode"
},
"PolicyRenewalResponse": {
"type": "object",
"properties": {
"RenewalPolicyNumber": {
"type": "string",
"description": "RenewalPolicyNumber",
"nullable": true
},
"TotalEstimatedAnnualPremium": {
"type": "number",
"description": "TotalEstimatedAnnualPremium",
"format": "double"
},
"TotalStateAssessment": {
"type": "number",
"description": "TotalStateAssessment",
"format": "double"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyRenewalClassCode"
},
"description": "ClassCodes",
"nullable": true
}
},
"additionalProperties": false,
"description": "PolicyRenewalResponse"
},
"PolicyRenewalResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PolicyRenewalResponse"
}
},
"additionalProperties": false,
"description": ""
},
"PolicySearchResponse": {
"type": "object",
"properties": {
"PolicyNumber": {
"type": "string",
"nullable": true
},
"BusinessName": {
"type": "string",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"format": "date-time"
},
"PolicyStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PolicySearchResponseIReadOnlyCollectionBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicySearchResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PostCompensationRequest": {
"required": [
"EndorsementNumber",
"FormDataFields"
],
"type": "object",
"properties": {
"EndorsementNumber": {
"minLength": 1,
"type": "string",
"description": "EndorsementNumber"
},
"FormDataFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormDataFieldRequest"
},
"description": "FormDataFields"
}
},
"additionalProperties": false,
"description": "PostCompensationRequest"
},
"PostDirectDebitRequest": {
"required": [
"AccountNumber",
"AccountType",
"Email",
"NameOnAccount",
"RoutingNumber"
],
"type": "object",
"properties": {
"NameOnAccount": {
"minLength": 1,
"type": "string"
},
"AccountNumber": {
"minLength": 1,
"pattern": "^[0-9+\\-]{4,18}$",
"type": "string"
},
"RoutingNumber": {
"maxLength": 9,
"minLength": 9,
"type": "string"
},
"Email": {
"minLength": 1,
"type": "string",
"format": "email"
},
"AccountType": {
"$ref": "#/components/schemas/AccountType"
}
},
"additionalProperties": false
},
"PostDirectDebitResponse": {
"required": [
"AccountNumber",
"AccountType",
"Email",
"NameOnAccount",
"RoutingNumber"
],
"type": "object",
"properties": {
"NameOnAccount": {
"minLength": 1,
"type": "string"
},
"AccountNumber": {
"minLength": 1,
"pattern": "^[0-9+\\-]{4,18}$",
"type": "string"
},
"RoutingNumber": {
"maxLength": 9,
"minLength": 9,
"type": "string"
},
"Email": {
"minLength": 1,
"type": "string",
"format": "email"
},
"AccountType": {
"$ref": "#/components/schemas/AccountType"
},
"BankName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PostDirectDebitResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PostDirectDebitResponse"
}
},
"additionalProperties": false,
"description": ""
},
"PostDividendsModel": {
"required": [
"DividendId",
"DividendSubTypeId"
],
"type": "object",
"properties": {
"DividendId": {
"type": "integer",
"format": "int32"
},
"DividendSubTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PostDividendsResponseModel": {
"type": "object",
"properties": {
"DividendId": {
"type": "integer",
"format": "int32"
},
"DividendSubTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PostDividendsResponseModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/PostDividendsResponseModel"
}
},
"additionalProperties": false,
"description": ""
},
"PostPolicyEndorsementModelV3": {
"required": [
"AgentContactId"
],
"type": "object",
"properties": {
"AgentContactId": {
"type": "integer",
"description": "AgentContactId",
"format": "int32"
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"format": "date-time"
},
"PolicyEndorsements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyEndorsementV3"
},
"description": "EndorsementModel PolicyEndorsements",
"nullable": true
}
},
"additionalProperties": false
},
"PostQuotePartnerRequest": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Organization": {
"type": "string",
"description": "Organization",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PremiumDetails": {
"type": "object",
"properties": {
"PriceIndication": {
"type": "integer",
"description": "PriceIndication",
"format": "int32"
},
"StateTaxes": {
"type": "integer",
"description": "StateTaxes",
"format": "int32"
},
"LimitPerAccident": {
"type": "integer",
"description": "LimitPerAccident",
"format": "int32"
},
"BodilyInjuryFromDiseasePolicyLimit": {
"type": "integer",
"description": "BodilyInjuryFromDiseasePolicyLimit",
"format": "int32"
},
"BodilyInjuryFromDiseasePerEmployeeLimit": {
"type": "integer",
"description": "BodilyInjuryFromDiseasePerEmployeeLimit",
"format": "int32"
},
"LiabilityLimits": {
"type": "string",
"description": "LiabilityLimits",
"nullable": true
}
},
"additionalProperties": false,
"description": "PremiumDetails"
},
"PriceTieringResponseModel": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"nullable": true
},
"FirmName": {
"type": "string",
"nullable": true
},
"FirmId": {
"type": "integer",
"format": "int32"
},
"TierId": {
"type": "integer",
"format": "int32"
},
"TierName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PriceTieringResponseModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceTieringResponseModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PricingTierPostModel": {
"required": [
"State",
"TierId"
],
"type": "object",
"properties": {
"TierId": {
"type": "integer",
"format": "int32"
},
"State": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"PricingTierResponse": {
"type": "object",
"properties": {
"TierId": {
"type": "integer",
"format": "int32"
},
"State": {
"type": "string",
"nullable": true
},
"FirmId": {
"type": "integer",
"format": "int32"
},
"TierName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PricingTierResponseBase": {
"type": "object",
"properties": {
"TierId": {
"type": "integer",
"format": "int32"
},
"State": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"PricingTierResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"PrimaryInsuredAdditionalLocation": {
"type": "object",
"properties": {
"LocationNumber": {
"type": "integer",
"format": "int32"
},
"Line1": {
"type": "string",
"nullable": true
},
"Line2": {
"type": "string",
"nullable": true
},
"City": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Zip": {
"type": "string",
"nullable": true
},
"EmployeeCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PutQuotePatnerRequest": {
"type": "object",
"properties": {
"PartnerId": {
"type": "integer",
"description": "PartnerId",
"format": "int32"
},
"FirstName": {
"type": "string",
"description": "FirstName",
"nullable": true
},
"LastName": {
"type": "string",
"description": "LastName",
"nullable": true
},
"Organization": {
"type": "string",
"description": "Organization",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuestionInformation": {
"type": "object",
"properties": {
"QuestionId": {
"type": "integer",
"description": "QuestionId",
"format": "int32"
},
"QuestionType": {
"type": "string",
"description": "QuestionType",
"nullable": true
},
"Question": {
"type": "string",
"description": "Question",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "QuestionInformation"
},
"QuestionResponse": {
"type": "object",
"properties": {
"QuestionId": {
"type": "integer",
"description": "Id associated with question that will be used when saving the question's answer",
"format": "int32"
},
"Question": {
"type": "string",
"description": "Text to display to user",
"nullable": true
},
"QuestionType": {
"type": "string",
"description": "Types include: bool, text, dropdown",
"nullable": true
},
"DropdownOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringStringKeyValuePair"
},
"description": "If QuotestionType is 'dropdown' this list will contain the available options. The Answer will always be the VALUE in the key/value pair.",
"nullable": true
},
"ParentQuestionId": {
"type": "integer",
"description": "If the question associated with the ParentQuestionId has been answered with the ParentAnswerToShow value, display this question. Otherwise it does not have to be answered.",
"format": "int32"
},
"ParentAnswerToShow": {
"type": "string",
"description": "If this value is answerd to the ParentQuestionId's question, display this question.",
"nullable": true
},
"Answer": {
"type": "string",
"description": "Answer saved by user. Null if not yet answered",
"nullable": true
},
"IsDuplicateQuestion": {
"type": "boolean"
}
},
"additionalProperties": false,
"description": "QuestionResponse"
},
"QuestionResponse_2": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"description": "Id associated with question that will be used when saving the question's answer",
"format": "int32"
},
"Question": {
"type": "string",
"description": "Text to display to user",
"nullable": true
},
"QuestionType": {
"type": "string",
"description": "Types include: bool, text, dropdown",
"nullable": true
},
"DropdownOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DropdownOption"
},
"description": "If QuotestionType is 'dropdown' this list will contain the available options. The Answer will always be the VALUE in the key/value pair.",
"nullable": true
},
"ParentQuestionId": {
"type": "integer",
"description": "If the question associated with the ParentQuestionId has been answered with the ParentAnswerToShow value, display this question. Otherwise it does not have to be answered.",
"format": "int32"
},
"ParentAnswerToShow": {
"type": "string",
"description": "If this value is answerd to the ParentQuestionId's question, display this question.",
"nullable": true
},
"Answer": {
"type": "string",
"description": "Answer saved by user. Null if not yet answered",
"nullable": true
}
},
"additionalProperties": false,
"description": "QuestionResponse_2"
},
"QuestionResponse_2ListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"Questions": {
"required": [
"ClassCodeList"
],
"type": "object",
"properties": {
"ClassCodeList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionsClassCode"
},
"description": "Required to get Question Sets"
}
},
"additionalProperties": false,
"description": ""
},
"QuestionsClassCode": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"LocState": {
"type": "string",
"description": "LocState",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuestionsResponse": {
"type": "object",
"properties": {
"HttpStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"StatusCode": {
"type": "string",
"description": "StatusCode",
"nullable": true
},
"Service": {
"type": "string",
"description": "Service",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse"
},
"description": "All questions that must be answered to be able to bind the associated quote",
"nullable": true
},
"MasterEligibilityStatus": {
"$ref": "#/components/schemas/EligibilityStatus"
}
},
"additionalProperties": false,
"description": "QuestionsResponse"
},
"QuoteApiModel": {
"required": [
"PrimaryAddress"
],
"type": "object",
"properties": {
"MasterAccountId": {
"type": "integer",
"description": "Master Account Id. \n\nIf provided: adds the new quote under an existing master account if the account exists and the authenticated agent has access to it\nIf not provided: creates a new master account along with the quote under the authenticated agent",
"format": "int32",
"nullable": true
},
"BillType": {
"$ref": "#/components/schemas/Billing"
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.\nOnly for Specialty Program.",
"format": "date-time",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Applicant's FEIN. If provided, accepted format is exactly 9 numeric characters ex. 123456789. Required before bind for WC quotes",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/OptionalAddressApiModel"
},
"BusinessName": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModelPost"
},
"NatureOfBusiness": {
"type": "string",
"description": "Description of Applicant's operations. Required to bind.",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "Legal Entity associated with quote's governing state. Required to bind.",
"format": "int32",
"nullable": true
},
"YearsInBusiness": {
"maximum": 99.0,
"minimum": 0.0,
"type": "integer",
"description": "The number of years the insured has been in business. Required to bind.",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "The premium of the customer's current in-force policy.",
"format": "int32"
},
"IsNonProfit": {
"type": "boolean",
"description": "Identifies if the insured operates as a Not-for-profit business.",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "Applicant's business website",
"nullable": true
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassPostModel"
},
"description": "List of class codes in their appropriate state formats (PA and DE should be 3-digit or 4-digit, all other states should be 4-digit)",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "Required to bind if any location is in California - ie ClassCode state or Primary Address State.\n\nRequired if the primary address is in CA and a CA class code is included on a quote.",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "If the PrimaryAddress State is in HI, ME, MN, or RI, an UnemploymentId is required.\nIn HI, it must be exactly 10 characters\nIn ME and RI, it must be exactly 10 digits\nIn MN, it must be between 8-12 digits",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"LiabilityLimits": {
"type": "string",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id.\nOnly for Specialty Program.",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap.\nOnly for Specialty Program.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
}
},
"additionalProperties": false,
"description": ""
},
"QuoteApiReturnModel": {
"type": "object",
"properties": {
"HttpStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"StatusCode": {
"type": "string",
"description": "StatusCode",
"nullable": true
},
"Service": {
"type": "string",
"description": "Service",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModel"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"LiabilityLimits": {
"type": "string",
"description": "LiabilityLimits",
"nullable": true
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32"
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbantAgent": {
"type": "boolean",
"description": "IsIncumbantAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"EstimatedAnnualPremium": {
"type": "integer",
"description": "EstimatedAnnualPremium",
"format": "int32"
},
"GoverningState": {
"type": "string",
"description": "GoverningState",
"nullable": true
},
"MasterAccountId": {
"type": "integer",
"description": "MasterAccountId",
"format": "int32"
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/GetEligibilityResponse"
},
"DigitalClientWorkflow": {
"type": "string",
"description": "DigitalClientWorkflow\nOnly WC",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.\nOnly for Specialty Program.",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id.\nOnly for Specialty Program.",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap.\nOnly for Specialty Program.",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "StateModifiers\nOnly for Specialty Program.",
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "QuoteApiReturnModel"
},
"QuoteApiReturnModelIApiResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"CorrelationID": {
"type": "string",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Paging": {
"$ref": "#/components/schemas/ApiPaging"
},
"MaxMsgIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MaxErrIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"IsOk": {
"type": "boolean"
},
"ApiResponseVersion": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Data": {
"$ref": "#/components/schemas/QuoteApiReturnModel"
}
},
"additionalProperties": false
},
"QuoteInformation": {
"type": "object",
"properties": {
"QuoteId": {
"type": "integer",
"description": "QuoteId",
"format": "int32"
},
"Product": {
"type": "string",
"description": "Product",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"Premium": {
"type": "number",
"description": "Premium",
"format": "double"
}
},
"additionalProperties": false,
"description": "QuoteInformation"
},
"QuotePartnersResponse": {
"type": "object",
"properties": {
"PartnerId": {
"type": "integer",
"description": "PartnerId",
"format": "int32"
},
"FirstName": {
"type": "string",
"description": "partner first name",
"nullable": true
},
"LastName": {
"type": "string",
"description": "partner last name",
"nullable": true
},
"Organization": {
"type": "string",
"description": "Organization",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuotePartnersResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/QuotePartnersResponse"
}
},
"additionalProperties": false,
"description": ""
},
"QuotePartnersResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuotePartnersResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuotePostModel": {
"type": "object",
"properties": {
"Quote": {
"$ref": "#/components/schemas/QuoteApiModel"
},
"LoadQuestions": {
"type": "boolean",
"description": "LoadQuestions",
"nullable": true
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
},
"description": "Questions",
"nullable": true
},
"ExperienceModifier": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"LoadRateSummary": {
"type": "boolean",
"description": "LoadRateSummary"
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierPostModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "QuotePostModel"
},
"QuotePutModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "The desired date of policy coverage start. Must be in date format: mm/dd/yyyy",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Applicant's FEIN. If provided, accepted format is exactly 9 numeric characters ex. 123456789. Required to bind for WC quotes",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressPutApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassPutModel"
},
"description": "ClassCodes",
"nullable": true
},
"BusinessName": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModel"
},
"NatureOfBusiness": {
"type": "string",
"description": "Required to bind.",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"YearsInBusiness": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"ExpiredPremium": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "Required to bind.",
"nullable": true
},
"IsIncumbantAgent": {
"type": "boolean",
"description": "Required to bind.",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "The customer's company website",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "Required to bind if any location is in California - ie ClassCode state or Primary Address State. If null or white space provided and rating zip value already saved or defaulted, it will not be overwritten.",
"nullable": true
},
"LiabilityLimits": {
"type": "string",
"description": "Save option from AvailableLiabiiltyLimits if default not wanted. If null, white space, or unavailable option, default value will remain.",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "DigitalClientWorkflow\nOnly for WC",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.\nOnly for Specialty Program.",
"format": "date-time",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id.\nOnly for Specialty Program.",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap.\nOnly for Specialty Program.",
"nullable": true
},
"MasterAccountId": {
"type": "integer",
"description": "Master Account Id. \n\nIf provided: adds the new quote under an existing master account if the account exists and the authenticated agent has access to it\nIf not provided: creates a new master account along with the quote under the authenticated agent\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"BillType": {
"$ref": "#/components/schemas/Billing"
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"description": "Modifiers\nOnly for Specialty Program.",
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierPostModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuoteReturnModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date. \nOnly for Specialty Program.",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"FirmId": {
"type": "string",
"nullable": true
},
"ExperienceModifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Only for WC.\nPlease use Modifiers section instead of this section.",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Only for Specialty Program.",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "Please use this new section instead of the Experience Modifier section.",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "QuoteReturnModel"
},
"QuoteReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/QuoteReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"QuoteSpecialtyApiModel": {
"required": [
"Fein",
"PrimaryAddress"
],
"type": "object",
"properties": {
"MasterAccountId": {
"type": "integer",
"description": "Master Account Id. \n\nIf provided: adds the new quote under an existing master account if the account exists and the authenticated agent has access to it\nIf not provided: creates a new master account along with the quote under the authenticated agent",
"format": "int32",
"nullable": true
},
"BillType": {
"$ref": "#/components/schemas/Billing"
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate must be today or greater, it cannot be in the past.",
"format": "date-time",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.",
"format": "date-time",
"nullable": true
},
"Fein": {
"minLength": 1,
"type": "string",
"description": "Applicant's FEIN. Accepted format is exactly 9 numeric characters ex. 123456789. Required before bind for WC quotes"
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/OptionalAddressApiModel"
},
"BusinessName": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModelSpecialtyPost"
},
"NatureOfBusiness": {
"type": "string",
"description": "Description of Applicant's operations. Required to bind.",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "Legal Entity associated with quote's governing state. Required to bind.",
"format": "int32",
"nullable": true
},
"YearsInBusiness": {
"maximum": 99.0,
"minimum": 0.0,
"type": "integer",
"description": "The number of years the insured has been in business. Required to bind.",
"format": "int32"
},
"ExpiredPremium": {
"maximum": 2147483647.0,
"minimum": 0.0,
"type": "integer",
"description": "The premium of the customer's current in-force policy.",
"format": "int32"
},
"IsNonProfit": {
"type": "boolean",
"description": "Identifies if the insured operates as a Not-for-profit business.",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "Required to bind.",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "Applicant's business website",
"nullable": true
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassSpecialtyPostModel"
},
"description": "List of class codes in their appropriate state formats (PA and DE should be 3-digit or 4-digit, all other states should be 4-digit)",
"nullable": true
},
"RatingZip": {
"maxLength": 5,
"minLength": 5,
"type": "string",
"description": "Required to bind if any location is in California - ie ClassCode state or Primary Address State. If Primary Address State is CA, and no RatingZip is provided, the Rating Zip is defaulted to the Primary Address Zip",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "If the PrimaryAddress State is in HI, ME, MN, or RI, an UnemploymentId is required.\nIn HI, it must be exactly 10 characters\nIn ME and RI, it must be exactly 10 digits\nIn MN, it must be between 8-12 digits",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"LiabilityLimits": {
"type": "string",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"QuoteSpecialtyPostModel": {
"type": "object",
"properties": {
"Quote": {
"$ref": "#/components/schemas/QuoteSpecialtyApiModel"
},
"LoadQuestions": {
"type": "boolean",
"description": "LoadQuestions",
"nullable": true
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
},
"description": "Questions",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"description": "List of modifiers including: Experience, Schedule, Drug Free and Safety Credit.",
"nullable": true
},
"LoadRateSummary": {
"type": "boolean"
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierPostModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "QuoteSpecialtyPostModel"
},
"QuoteSpecialtyPostModelV2": {
"type": "object",
"properties": {
"Quote": {
"$ref": "#/components/schemas/QuoteApiModel"
},
"LoadQuestions": {
"type": "boolean",
"description": "LoadQuestions",
"nullable": true
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Answer"
},
"description": "Questions",
"nullable": true
},
"ExperienceModifier": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"LoadRateSummary": {
"type": "boolean",
"description": "LoadRateSummary"
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierPostModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"QuoteSpecialtyPutModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "The desired date of policy coverage start. Must be in date format: mm/dd/yyyy",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Applicant's FEIN. If provided, accepted format is exactly 9 numeric characters ex. 123456789. Required to bind for WC quotes",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressPutApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassPutModel"
},
"description": "ClassCodes",
"nullable": true
},
"BusinessName": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"maxLength": 90,
"minLength": 0,
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModel"
},
"NatureOfBusiness": {
"type": "string",
"description": "Required to bind.",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"YearsInBusiness": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"ExpiredPremium": {
"type": "integer",
"description": "Required to bind.",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "Required to bind.",
"nullable": true
},
"IsIncumbantAgent": {
"type": "boolean",
"description": "Required to bind.",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "The customer's company website",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "Required to bind if any location is in California - ie ClassCode state or Primary Address State. If null or white space provided and rating zip value already saved or defaulted, it will not be overwritten.",
"nullable": true
},
"LiabilityLimits": {
"type": "string",
"description": "Save option from AvailableLiabiiltyLimits if default not wanted. If null, white space, or unavailable option, default value will remain.",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "DigitalClientWorkflow\nOnly for WC",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.\nOnly for Specialty Program.",
"format": "date-time",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id.\nOnly for Specialty Program.",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap.\nOnly for Specialty Program.",
"nullable": true
},
"MasterAccountId": {
"type": "integer",
"description": "Master Account Id. \n\nIf provided: adds the new quote under an existing master account if the account exists and the authenticated agent has access to it\nIf not provided: creates a new master account along with the quote under the authenticated agent\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"BillType": {
"$ref": "#/components/schemas/Billing"
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierPatchModel"
},
"description": "Modifiers\nOnly for Specialty Program.",
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierPostModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"QuoteSpecialtyReturnModel": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "QuoteReturnModel"
},
"QuoteSpecialtyReturnModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/QuoteSpecialtyReturnModel"
}
},
"additionalProperties": false,
"description": ""
},
"QuoteSpecialtyReturnModelV2": {
"type": "object",
"properties": {
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "Expiration Date. \nOnly for Specialty Program.",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactResponse"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32",
"nullable": true
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbentAgent": {
"type": "boolean",
"description": "IsIncumbentAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId",
"format": "int32",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"AccountInformation": {
"$ref": "#/components/schemas/AccountInformation"
},
"PremiumDetails": {
"$ref": "#/components/schemas/PremiumDetails"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/EligibilityResponse_2"
},
"Questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResponse_2"
},
"description": "Questions",
"nullable": true
},
"FirmId": {
"type": "string",
"nullable": true
},
"ExperienceModifier": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Only for WC.\nPlease use Modifiers section instead of this section.",
"nullable": true
},
"DigitalClientWorkflow": {
"type": "string",
"description": "Only for WC.",
"nullable": true
},
"SpousesNames": {
"$ref": "#/components/schemas/HusbandAndWifeBase"
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Only for Specialty Program.",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "Please use this new section instead of the Experience Modifier section.",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
}
},
"additionalProperties": false
},
"QuoteSpecialtyReturnModelV2BaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/QuoteSpecialtyReturnModelV2"
}
},
"additionalProperties": false,
"description": ""
},
"Rationale": {
"type": "object",
"properties": {
"RationalName": {
"type": "string",
"nullable": true
},
"RationaleTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"RationalePostModel": {
"required": [
"Amount",
"CategoryTypeId",
"RationaleTypeId",
"State"
],
"type": "object",
"properties": {
"State": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "2 Character State Abreviation"
},
"CategoryTypeId": {
"type": "integer",
"description": "Category Type Id",
"format": "int32"
},
"Amount": {
"type": "integer",
"description": "Amount",
"format": "int32"
},
"RationaleTypeId": {
"type": "integer",
"description": "Rationale Type Id",
"format": "int32"
}
},
"additionalProperties": false
},
"ReinstatePolicyRequest": {
"required": [
"ReinstatementDate",
"ReinstatementReason"
],
"type": "object",
"properties": {
"ReinstatementReason": {
"minLength": 1,
"type": "string"
},
"ReinstatementDate": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"SearchResult": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDecription": {
"type": "string",
"description": "ClassDecription",
"nullable": true
},
"ClassDecriptionCode": {
"type": "string",
"description": "ClassDecriptionCode",
"nullable": true
},
"MatchProbability": {
"type": "number",
"description": "MatchProbability",
"format": "double"
}
},
"additionalProperties": false,
"description": "SearchResult"
},
"SetPolicyAsNonRenewalRequest": {
"required": [
"NonRenewalReason"
],
"type": "object",
"properties": {
"NonRenewalReason": {
"type": "integer",
"description": "The reason code for non-renewal.\nAccepted values are 1–12.\nIf reason code 11 is provided then Description is required.",
"format": "int32"
},
"Description": {
"type": "string",
"description": "Additional description for non-renewal. Required when NonRenewalReason is 11 ('Other').",
"nullable": true
}
},
"additionalProperties": false
},
"ShortModifier": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "Id",
"nullable": true
},
"Value": {
"type": "string",
"description": "Value",
"nullable": true
},
"ModifierUiInformation": {
"$ref": "#/components/schemas/ModifierUiInformation"
},
"ExcludingModifier": {
"$ref": "#/components/schemas/ExcludingModifier"
},
"State": {
"type": "string",
"description": "State",
"nullable": true
}
},
"additionalProperties": false,
"description": "Simplified Specialty Modifer"
},
"SmallDeductibleResponseModel": {
"type": "object",
"properties": {
"DedId": {
"type": "integer",
"format": "int32"
},
"GovState": {
"type": "string",
"nullable": true
},
"DedAccLimit": {
"type": "integer",
"format": "int32"
},
"DedPct": {
"type": "number",
"format": "double"
},
"HazardGrp": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SmallDeductibleResponseModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SmallDeductibleResponseModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"SpecialtyQuoteApiReturnModel": {
"type": "object",
"properties": {
"HttpStatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"StatusCode": {
"type": "string",
"description": "StatusCode",
"nullable": true
},
"Service": {
"type": "string",
"description": "Service",
"nullable": true
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"EffectiveDate": {
"type": "string",
"description": "EffectiveDate",
"nullable": true
},
"Fein": {
"type": "string",
"description": "Fein",
"nullable": true
},
"PrimaryAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"MailingAddress": {
"$ref": "#/components/schemas/AddressApiModel"
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassApiReturnModel"
},
"description": "ClassCodes",
"nullable": true
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"DBA": {
"type": "string",
"description": "DBA",
"nullable": true
},
"ContactInformation": {
"$ref": "#/components/schemas/ContactApiModel"
},
"NatureOfBusiness": {
"type": "string",
"description": "NatureOfBusiness",
"nullable": true
},
"LegalEntity": {
"type": "integer",
"description": "LegalEntity",
"format": "int32"
},
"LiabilityLimits": {
"type": "string",
"description": "LiabilityLimits",
"nullable": true
},
"YearsInBusiness": {
"type": "integer",
"description": "YearsInBusiness",
"format": "int32"
},
"ExpiredPremium": {
"type": "integer",
"description": "ExpiredPremium",
"format": "int32"
},
"IsNonProfit": {
"type": "boolean",
"description": "IsNonProfit",
"nullable": true
},
"IsIncumbantAgent": {
"type": "boolean",
"description": "IsIncumbantAgent",
"nullable": true
},
"CompanyWebsiteAddress": {
"type": "string",
"description": "CompanyWebsiteAddress",
"nullable": true
},
"EstimatedAnnualPremium": {
"type": "integer",
"description": "EstimatedAnnualPremium",
"format": "int32"
},
"GoverningState": {
"type": "string",
"description": "GoverningState",
"nullable": true
},
"MasterAccountId": {
"type": "integer",
"description": "MasterAccountId",
"format": "int32"
},
"RatingZip": {
"type": "string",
"description": "RatingZip",
"nullable": true
},
"UnemploymentId": {
"type": "string",
"description": "UnemploymentId",
"nullable": true
},
"Eligibility": {
"$ref": "#/components/schemas/GetEligibilityResponse"
},
"DigitalClientWorkflow": {
"type": "string",
"description": "DigitalClientWorkflow\nOnly WC",
"nullable": true
},
"RatingSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SummaryItemBase"
},
"nullable": true
},
"ExpirationDate": {
"type": "string",
"description": "ExpirationDate can be any date after today and within the next 12 months.\nOnly for Specialty Program.",
"nullable": true
},
"FirmId": {
"type": "string",
"description": "Firm Id.\nOnly for Specialty Program.",
"nullable": true
},
"AdditionalCoverages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalCoverage"
},
"description": "Additional Coverages like Stop Gap.\nOnly for Specialty Program.",
"nullable": true
},
"PayrollCompanyId": {
"type": "integer",
"description": "PayrollCompanyId\nOnly for Specialty Program.",
"format": "int32",
"nullable": true
},
"StateModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifierShortResponse"
},
"description": "StateModifiers\nOnly for Specialty Program.",
"nullable": true
},
"PricingTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricingTierResponseBase"
},
"nullable": true
}
},
"additionalProperties": false
},
"SpecialtySubmitToUnderwriterModel": {
"type": "object",
"properties": {
"NoteToUnderwriter": {
"type": "string",
"description": "Additional information an Underwriter might need.",
"nullable": true
},
"AgentNeedByDate": {
"type": "string",
"description": "Date by which the underwriter should complete the request for the submitting agent. Must be after today's date and neither Saturday nor Sunday.",
"format": "date",
"nullable": true
}
},
"additionalProperties": false
},
"StateCategoryRationale": {
"type": "object",
"properties": {
"State": {
"type": "string",
"nullable": true
},
"Categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryRationale"
},
"nullable": true
}
},
"additionalProperties": false
},
"StateCategoryRationaleIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateCategoryRationale"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StateClassCodeModel": {
"type": "object",
"properties": {
"ClassCode": {
"type": "string",
"description": "ClassCode",
"nullable": true
},
"ClassDescriptionCode": {
"type": "string",
"description": "ClassDescriptionCode",
"nullable": true
},
"ClassDescription": {
"type": "string",
"description": "ClassDescription",
"nullable": true
}
},
"additionalProperties": false,
"description": "StateClassCodeModel"
},
"StateClassCodesResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"ClassCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateClassCodeModel"
},
"description": "ClassCodes",
"nullable": true
}
},
"additionalProperties": false,
"description": "StateClassCodesResponse"
},
"StateClassCodesResponseListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateClassCodesResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StateModifierPatchModel": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Modifiers": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Modifiers ---- key = modifierId ; value = modifier value",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StateModifierShortResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShortModifier"
},
"description": "Modifiers",
"nullable": true
}
},
"additionalProperties": false
},
"StateModifiersResponse": {
"type": "object",
"properties": {
"State": {
"type": "string",
"description": "State",
"nullable": true
},
"Modifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Modifier"
},
"description": "Modifiers",
"nullable": true
}
},
"additionalProperties": false,
"description": "StateModifiersResponse"
},
"StateModifiersResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StateModifiersResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StopGapCoverage": {
"type": "object",
"properties": {
"CoverageName": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Limit": {
"type": "string",
"nullable": true
},
"Period": {
"type": "string",
"nullable": true
},
"AnnualPayroll": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"StringBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "string",
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StringIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"type": "string"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StringListBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"type": "string"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"StringStringKeyValuePair": {
"type": "object",
"properties": {
"Key": {
"type": "string",
"nullable": true
},
"Value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SubChangeReasonModel": {
"type": "object",
"properties": {
"EndmtSubType": {
"type": "string",
"nullable": true
},
"EndmtChangeReason": {
"type": "string",
"nullable": true
},
"EndmtChangeReasonId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"SubmitToUnderwriterModel": {
"required": [
"NoteToUnderwriter"
],
"type": "object",
"properties": {
"NoteToUnderwriter": {
"minLength": 1,
"type": "string",
"description": "Additional information an Underwriter might need."
},
"AgentNeedByDate": {
"type": "string",
"description": "Date by which the underwriter should complete the request for the submitting agent. Must be after today's date and neither Saturday nor Sunday.",
"format": "date",
"nullable": true
}
},
"additionalProperties": false
},
"SubmitToUnderwriterResponseModel": {
"type": "object",
"properties": {
"MasterAccountId": {
"type": "integer",
"description": "MasterAccountId",
"format": "int32"
},
"SubmittedDate": {
"type": "string",
"description": "SubmittedDate",
"nullable": true
},
"BusinessName": {
"type": "string",
"description": "BusinessName",
"nullable": true
},
"QuoteInformation": {
"$ref": "#/components/schemas/QuoteInformation"
}
},
"additionalProperties": false,
"description": "SubmitToUnderwriterResponseModel"
},
"SubmitToUnderwriterResponseModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/SubmitToUnderwriterResponseModel"
}
},
"additionalProperties": false,
"description": ""
},
"SummaryEndmt": {
"type": "object",
"properties": {
"EndorsementNumber": {
"type": "integer",
"format": "int32"
},
"EffectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"Type": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"CommitedBy": {
"type": "string",
"nullable": true
},
"DateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"SummaryItemBase": {
"type": "object",
"properties": {
"GovState": {
"type": "string",
"nullable": true
},
"ModelType": {
"type": "string",
"nullable": true
},
"ItemType": {
"type": "string",
"nullable": true
},
"ClassCode": {
"type": "string",
"nullable": true
},
"Description": {
"type": "string",
"nullable": true
},
"Premium": {
"type": "number",
"format": "double"
},
"Year": {
"type": "integer",
"format": "int32"
},
"Rate": {
"type": "number",
"format": "double"
},
"Exposure": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TermsOfAgreementModel": {
"required": [
"IsAcknowledged"
],
"type": "object",
"properties": {
"IsAcknowledged": {
"minLength": 1,
"type": "string",
"description": "Accepted values: Yes, No, True, False"
}
},
"additionalProperties": false
},
"ThirdPartyNoticeDeleteModelV1": {
"type": "object",
"properties": {
"Indexes": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"ThirdPartyNoticeGetDto": {
"type": "object",
"properties": {
"IndexId": {
"type": "integer",
"format": "int32"
},
"FirstName": {
"type": "string",
"nullable": true
},
"LastName": {
"type": "string",
"nullable": true
},
"Address1": {
"type": "string",
"nullable": true
},
"Address2": {
"type": "string",
"nullable": true
},
"City": {
"type": "string",
"nullable": true
},
"State": {
"type": "string",
"nullable": true
},
"Zip": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ThirdPartyNoticePostDto": {
"required": [
"Address1",
"City",
"FirstName",
"LastName",
"State",
"Zip"
],
"type": "object",
"properties": {
"FirstName": {
"minLength": 1,
"type": "string"
},
"LastName": {
"minLength": 1,
"type": "string"
},
"Address1": {
"minLength": 1,
"type": "string"
},
"Address2": {
"type": "string",
"nullable": true
},
"City": {
"minLength": 1,
"type": "string"
},
"State": {
"maxLength": 2,
"minLength": 0,
"type": "string"
},
"Zip": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"UnauthorizedError": {
"type": "object",
"properties": {
"Id": {
"type": "integer",
"format": "int32",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"MessageType": {
"$ref": "#/components/schemas/ApiMessageType"
},
"Detail": {
"type": "string",
"nullable": true
},
"Internal": {
"type": "string",
"nullable": true
},
"Reference": {
"type": "string",
"nullable": true
},
"Exception": {
"$ref": "#/components/schemas/LogException"
},
"IsOk": {
"type": "boolean"
},
"NeedsSanitization": {
"type": "boolean",
"readOnly": true
},
"MessageCode": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Title": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"UnauthorizedErrorIApiResponse": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"nullable": true
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"CorrelationID": {
"type": "string",
"nullable": true
},
"HttpStatus": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiMessage"
},
"nullable": true
},
"Paging": {
"$ref": "#/components/schemas/ApiPaging"
},
"MaxMsgIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"MaxErrIndex": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"IsOk": {
"type": "boolean"
},
"ApiResponseVersion": {
"type": "string",
"nullable": true,
"readOnly": true
},
"Data": {
"$ref": "#/components/schemas/UnauthorizedError"
}
},
"additionalProperties": false
},
"UpdateWaiverModel": {
"required": [
"Address",
"City",
"ClassCode",
"GovState",
"IndexId",
"JobDescription",
"Name",
"Payroll",
"StartDate",
"State",
"Zip"
],
"type": "object",
"properties": {
"StartDate": {
"minLength": 1,
"type": "string"
},
"Name": {
"minLength": 1,
"type": "string"
},
"Address": {
"minLength": 1,
"type": "string"
},
"City": {
"minLength": 1,
"type": "string"
},
"State": {
"minLength": 1,
"type": "string"
},
"Zip": {
"minLength": 1,
"type": "string"
},
"ClassCode": {
"minLength": 1,
"type": "string"
},
"GovState": {
"minLength": 1,
"type": "string",
"description": "Class code state"
},
"JobDescription": {
"minLength": 1,
"type": "string"
},
"Payroll": {
"type": "integer",
"description": "Class code payroll",
"format": "int32"
},
"IndexId": {
"maximum": 2147483647.0,
"minimum": 1.0,
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"UploadFileResponse": {
"type": "object",
"properties": {
"LibraryId": {
"type": "integer",
"description": "LibraryId",
"format": "int32"
}
},
"additionalProperties": false,
"description": "UploadFileResponse"
},
"UploadFileResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/UploadFileResponse"
}
},
"additionalProperties": false,
"description": ""
},
"UwQuestionsResponse": {
"type": "object",
"properties": {
"GeneralQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionInformation"
},
"description": "",
"nullable": true
},
"AllQuestionsBinary": {
"type": "string",
"description": "",
"format": "byte",
"nullable": true
},
"ClassCodeQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClassCodeQuestion"
},
"description": "",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"UwQuestionsResponseBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/UwQuestionsResponse"
}
},
"additionalProperties": false,
"description": ""
},
"VoluntaryCompensationResponse": {
"type": "object",
"properties": {
"EndorsementNumber": {
"type": "string",
"description": "EndorsementNumber",
"nullable": true
},
"Description": {
"type": "string",
"description": "Description",
"nullable": true
},
"FormDataFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FormDataField"
},
"description": "FormDataFields",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"VoluntaryCompensationResponseIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VoluntaryCompensationResponse"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"WaiverReadModel": {
"required": [
"Address",
"City",
"ClassCode",
"GovState",
"JobDescription",
"Name",
"Payroll",
"StartDate",
"State",
"Zip"
],
"type": "object",
"properties": {
"StartDate": {
"minLength": 1,
"type": "string"
},
"Name": {
"minLength": 1,
"type": "string"
},
"Address": {
"minLength": 1,
"type": "string"
},
"City": {
"minLength": 1,
"type": "string"
},
"State": {
"minLength": 1,
"type": "string"
},
"Zip": {
"minLength": 1,
"type": "string"
},
"ClassCode": {
"minLength": 1,
"type": "string"
},
"GovState": {
"minLength": 1,
"type": "string",
"description": "Class code state"
},
"JobDescription": {
"minLength": 1,
"type": "string"
},
"Payroll": {
"type": "integer",
"description": "Class code payroll",
"format": "int32"
},
"IndexId": {
"type": "integer",
"format": "int32"
},
"EndDate": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WaiverReadModelBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"$ref": "#/components/schemas/WaiverReadModel"
}
},
"additionalProperties": false,
"description": ""
},
"WaiverReadModelIEnumerableBaseResponse": {
"type": "object",
"properties": {
"StatusCode": {
"$ref": "#/components/schemas/HttpStatusCode"
},
"Message": {
"type": "string",
"description": "Message",
"nullable": true
},
"AdditionalMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "AdditionalMessages",
"nullable": true
},
"Errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"description": "Errors",
"nullable": true
},
"Data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaiverReadModel"
},
"description": "Data",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"WaiverWriteModel": {
"required": [
"Address",
"City",
"ClassCode",
"GovState",
"JobDescription",
"Name",
"Payroll",
"StartDate",
"State",
"Zip"
],
"type": "object",
"properties": {
"StartDate": {
"minLength": 1,
"type": "string"
},
"Name": {
"minLength": 1,
"type": "string"
},
"Address": {
"minLength": 1,
"type": "string"
},
"City": {
"minLength": 1,
"type": "string"
},
"State": {
"minLength": 1,
"type": "string"
},
"Zip": {
"minLength": 1,
"type": "string"
},
"ClassCode": {
"minLength": 1,
"type": "string"
},
"GovState": {
"minLength": 1,
"type": "string",
"description": "Class code state"
},
"JobDescription": {
"minLength": 1,
"type": "string"
},
"Payroll": {
"type": "integer",
"description": "Class code payroll",
"format": "int32"
}
},
"additionalProperties": false
},
"WrittenPremium": {
"type": "object",
"properties": {
"State": {
"type": "string",
"nullable": true
},
"Date": {
"type": "string",
"format": "date-time"
},
"Description": {
"type": "string",
"nullable": true
},
"WrittenAmount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"apiKeyHeader": {
"type": "apiKey",
"name": "subscriber_id",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "subscription-key",
"in": "query"
}
}
},
"security": [
{
"apiKeyHeader": []
},
{
"apiKeyQuery": []
}
],
"tags": [
{
"name": "Workers Comp"
},
{
"name": "Workers Comp-Specialty Programs"
}
]
}