openapi: 3.2.0 info: title: Digital WC Workers Comp 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 security: - apiKeyHeader: [] - apiKeyQuery: [] tags: - name: Workers Comp paths: /api/v1/affirmation: get: tags: - Workers Comp summary: Retrieves the affirmation statement that will need to be displayed to agents… description: 'Retrieves the affirmation statement that will need to be displayed to agents prior to binding the quote to a policy This can be called in conjunction with the V2 Bind endpoint; the actual submission of affirmation will occur in the V2 Quote Bind endpoint. __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… 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… 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… 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… 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. description: 'Retrieves eligibility status of a specified class code in the state specified by the URI parameter __state.__ 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… description: 'Retrieves a list of all class codes in a state along with all description and eligibility information. 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. description: 'Retrieves a list of all class codes in a state. 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 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. description: 'Retrieves class code information based on the NAICS or SIC code sent 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. Character limits: • NAICS code can be up to 6 numeric characters • 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: 'Retrieves all AmTrust class code information, including eligibility, description codes, descriptions, and NAICS and SIC codes. 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. If state is passed, the response will come back as a JSON object. 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. description: 'Allows user to search for a class code using natural language parameters in the path and query string. 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… 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… 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… description: 'This endpoint removes the voluntary compensation coverage endorsement from the quote ID specified; Endorsement ID is optional. 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… description: 'Retrieves the BOP quote number and premium information initiated by the Create Cross Sell Quote. __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… 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. description: 'Retrieves the current eligibility and status of the quote specified by quoteId. __Quote Statuses that will return are below:__ __•__ __Not Submitted__ – means quote has not been submitted to the underwriter; default status on quote creation and journey __•__ __Submitted__ – means the quote is submitted to an underwriter, and awaiting review __•__ __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 __•__ __UnderwriterDeclined__ – means the underwriter has declined this risk, and quote cannot be bound; the quote is now blocked for editing __•__ __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 __•__ __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 Eligibility is broken down into the parameters below: __•__ __Class Code: Bind Eligible, Refer, Declined__ __•__ __Questions: Bind Eligible, Refer, Declined__ (will default to Refer on initial quote creation, as questions have not been answered yet) __•__ __Territory: Bind Eligible, Refer, Declined__ __•__ __Modifiers: Bind Eligible, Refer, Declined__ __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… 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… description: 'Retrieves agent information associated with an email address passed in the query string. __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… 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… 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. description: 'Updates the quote to include modifiers. __•__ Modifier IDs are case sensitive. For example: “EmPct”, “ComContribPct”, etc… __•__ 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… 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… 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… 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. description: 'Removes saved California partner information from the quote. The query string parameter __partnerId__ is optional: __•__ If the parameter partner ID is not included in the URI, then all partners currently saved to the quote will be removed __•__ 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. description: 'This information is required, in order to bind, if the quote is in CA, and is one of the legal entities listed below: __•__ General Partnership __•__ Limited Liability Partnership __•__ Limited Partnership __•__ Tenants in Common __Note 1:__ If the legal entity is __Tenants in Common__, no partners are required, but if one is added, a second is required. __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. description: 'This endpoint will return the partner names and organization on the specified quote. The URI parameter __partnerId__ is optional: __•__ If __partnerId__ is not included in the URI, then all partners currently saved to the quote will return __•__ 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. description: 'This endpoint will update the partner names or organizations on the specified quote The Partner ID is optional: __•__ 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. __•__ 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. __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… description: 'This endpoint will update the partner name or organization on the specified quote, associated with the specific partner ID passed. __Note 1:__ To update name: Only the field being updated is required (first OR last name), but both can be sent. __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. description: 'This endpoint is used to make a payment on the policy. The Balance Summary endpoint can be used to retrieve the current balance on the policy. Payment sent must be equal to the current amount due. __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. description: 'Retrieve the current balance on a policy. __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… 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. 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… 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… 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. Available file types can be retrieved via the List of All Available Policy Documents endpoint: (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… 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…' description: 'Returns basic policy information on requested policy number. Retrieves policy number based on parameter used to search User can search for a policy number using one of the following parameters: • Master Account ID • FEIN • Policy ID • Quote Number Only one (1) parameter can be used to search 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… 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… 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. description: 'Posts answers to one or more questions with question ID and answer. __Questions must be answered before binding.__ __*__ 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. description: 'Updates information on an existing quote. __Please Note:__ entire existing quote body must be included, and any desired additonal/updated information should be 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. description: 'If quote has been approved by an Underwriter, the only parameter that may be sent is Effective Date; all other parameters will be locked If quote has been declined by an Underwriter or due to class code/question answers, quote will be completely locked for editing 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' 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. The GET Quote Eligibility (v1/quotes/{quoteId}/eligibility) endpoint can be used to view current status of the quote. 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. description: 'If a quote is in the state of Nebraska and is a non-profit corporation the annual compensation for the officer is required. If the annual compensation is equal or less than 1,000 the Officer will be saved. If the annual compensation is equal or greater than 1,001 the officer will not be saved. **NOTE:** ''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. description: 'The quote must be in either BindEligible or Approved status before bind will be successful The (GET) All Agent Contacts endpoint can and should be utilized to allow submitting agent to select his/her name, in order to pas contact ID through URI 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… 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… 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. 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… 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. __Please note:__ __•__ If a class code is not returned in this endpoint, it means that only the general questions will need to be answered for it. __•__ The state and effective date are optional: __•__ 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 __•__ 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. description: 'Create a quote. __•__ 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… 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. description: 'The full list of potential endorsements based on the policy are • ''insured-name-update'' • ''insured-mailing-address-update'' • ''insured-fein-change'' • ''partners-update'' • ''insured-primary-address-update'' • ''additional-insureds-update'' • ''exposure-update'' • ''officers-update'' • ''legal-entity-update'' • ''agent-other-request'' • ''blanket-waiver-change'' • ''specific-waivers-change'' Primary Address Change endorsement fields Required fields Line1 City State ZipCode UpdateMailingAddress Optional Fields Line2 UpdateBillingAddress - This is needed if UpdateMailingAddress is TRUE EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT. Additional Insureds Update endorsement fields Required fields AddressLine1 City State ZipCode Optional Fields Id AddressLine2 EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT. Exposure Update endorsement fields Required fields State ClassCode DescriptionCode FullTimeEmployees PartTimeEmployees Payroll Optional Fields Notes, DisplayName, WindowsFileType and FileData - Those are required only if the payroll changes by more than 40%, including a 40% decrease. officers Update endorsement fields Required fields OfficerName Type State FormType EndorsementId OwnershipPercentage Optional Fields Id - Is required only for update Legal Entity Update endorsement fields Required fields LegalEntityCode Optional Fields Notes DisplayName, WindowsFileType, FileData - All three fields should be entered together Inspection contact information fields Required fields FirstName LastName Phone Optional Fields Email Agent Other endorsement fields Required fields Notes Optional Fields DisplayName, WindowsFileType, FileData - All three fields should be entered together EmployeeCount - This is only required in the states of FL, KY, ME, TN, UT, and MT. Blanket Waiver Change endorsement fields Required fields RemoveWaiver - True = remove waiver, False = add waiver Specific Waivers Change endorsement fields Required fields Id StartDate EndDate State FirstName LastName Line1 Line2 City State Zip JobDescription Payroll ClassCode 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… 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. 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… 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… 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/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… description: 'Replaces the entire collection of current class codes on a quote with the class code collection supplied in the request body. To add one or more class codes: include all current class codes including the class code(s) you wish to add. 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. 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. 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 __If existing class codes are excluded from request, they will be removed from the quote__ Multiple of the same class code and description code are not allowed in a single state quote 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. description: '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. Multiples of the same class code and description code are not allowed in a single state quote 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/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: __•__ Price __•__ Waiver of Subrogation (WOS) __•__ Form/Coverage Request (not WOS) __•__ Dividend __•__ Deductible __•__ Class Code Verification __•__ 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/v1/quotes/{quoteId}/additionalInformation/insureds/{insuerdId}: delete: tags: - Workers Comp summary: Removes a specified insured from the quote specified by the URI parameter… 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/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/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/policies/{policy}/endorsement-history: get: tags: - Workers Comp summary: 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/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/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 components: schemas: 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 CurrentPartnerModel: type: object properties: FirstName: type: - string - 'null' description: '' LastName: type: - string - 'null' description: '' Id: type: integer description: '' format: int32 additionalProperties: false description: '' Billing: enum: - 0 = A - 1 = I type: integer format: int32 PolicyPartner: type: object properties: FirstName: type: - string - 'null' LastName: type: - string - 'null' Organization: type: - string - 'null' additionalProperties: false ForbiddenErrorIApiResponse: type: object properties: ID: type: - string - 'null' Timestamp: type: string format: date-time CorrelationID: type: - string - 'null' HttpStatus: $ref: '#/components/schemas/HttpStatusCode' Messages: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' Errors: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' 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 - 'null' readOnly: true Data: $ref: '#/components/schemas/ForbiddenError' additionalProperties: false 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 AgentInfoReturnModel: type: object properties: AgentId: type: integer description: Agent Id format: int32 AgentName: type: - string - 'null' description: Agent Name additionalProperties: false description: Return model for agent names LogException: type: object properties: ExceptionId: type: string format: uuid Module: type: - string - 'null' Class: type: - string - 'null' TargetSite: type: - string - 'null' HttpWebEventCode: type: - integer - 'null' format: int32 HttpStatusValue: type: - integer - 'null' format: int32 HttpStatusCode: type: - string - 'null' HttpHtmlMessage: type: - string - 'null' Properties: type: - object - 'null' additionalProperties: type: - string - 'null' InnerException: $ref: '#/components/schemas/LogException' Message: type: - string - 'null' Source: type: - string - 'null' StackTrace: type: - string - 'null' HelpLink: type: - string - 'null' Method: type: - string - 'null' Data: type: - object - 'null' additionalProperties: type: - string - 'null' ErrorCode: type: - string - 'null' ExceptionType: type: - string - 'null' BaseException: $ref: '#/components/schemas/LogException' additionalProperties: false ClassInformationResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/ClassInformationResponse' description: Data additionalProperties: false description: '' ContactApiModelPost: type: object properties: FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Email: type: - string - 'null' description: Email format: email Phone: pattern: ((\(\d{3}\)?)|(\d{3}))([\s-./]?)(\d{3})([\s-./]?)(\d{4}) type: - string - 'null' description: Phone AgentContactId: type: - integer - 'null' description: AgentContactId format: int32 additionalProperties: false description: '' EndorsementResponseResult: type: object additionalProperties: false DropdownOption: type: object properties: Key: type: - string - 'null' description: Key Text: type: - string - 'null' description: Text additionalProperties: false description: DropdownOption NetRateResponseListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/NetRateResponse' description: Data additionalProperties: false description: '' ClassCodeInformation: type: object properties: DescriptionCode: type: - string - 'null' description: 'description code: i.e. 00' NaicsDescription: type: - string - 'null' description: class code Description NaicsCode: type: - string - 'null' description: NaicsCode SicCode: type: - string - 'null' description: SicCode additionalProperties: false description: '' StateModifierShortResponse: type: object properties: State: type: - string - 'null' description: State Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/ShortModifier' description: Modifiers additionalProperties: false LimitInformation: type: object properties: ExcludedOfficerLimit: type: integer description: ExcludedOfficerLimit format: int32 ValidationMessage: type: - string - 'null' description: ValidationMessage additionalProperties: false description: '' StateCategoryRationaleIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/StateCategoryRationale' description: Data additionalProperties: false description: '' AdditionalInsuredLocation: required: - State type: object properties: Address1: type: - string - 'null' description: Address1 Address2: maxLength: 40 type: - string - 'null' description: Address2 City: type: - string - 'null' description: city State: maxLength: 2 minLength: 1 type: string description: Quote must have exposure in location's state to be added Zip: type: - string - 'null' description: zip TotalEmployeeNumber: type: - integer - 'null' description: "Total employee number in this location; \nThis is a required field if in the state of CA" format: int32 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 PaymentPlanResponseV2BaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PaymentPlanResponseV2' additionalProperties: false description: '' OfficerInformationModel: type: object properties: OfficerType: type: - string - 'null' description: OfficerType State: type: - string - 'null' description: State LimitInformation: $ref: '#/components/schemas/LimitInformation' EndorsementInformation: $ref: '#/components/schemas/EndorsementInformation' additionalProperties: false description: '' NotFoundErrorIApiResponse: type: object properties: ID: type: - string - 'null' Timestamp: type: string format: date-time CorrelationID: type: - string - 'null' HttpStatus: $ref: '#/components/schemas/HttpStatusCode' Messages: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' Errors: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' 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 - 'null' readOnly: true Data: $ref: '#/components/schemas/NotFoundError' additionalProperties: false ECheck: type: object properties: AccountNumber: type: - string - 'null' description: account number RoutingNumber: type: - string - 'null' description: bank routing number FinancialInstitution: type: - string - 'null' description: bank or financial instituation name AccountType: $ref: '#/components/schemas/AccountType' additionalProperties: false description: '' ShortModifier: type: object properties: Id: type: - string - 'null' description: Id Value: type: - string - 'null' description: Value ModifierUiInformation: $ref: '#/components/schemas/ModifierUiInformation' ExcludingModifier: $ref: '#/components/schemas/ExcludingModifier' State: type: - string - 'null' description: State additionalProperties: false description: Simplified Specialty Modifer UnauthorizedErrorIApiResponse: type: object properties: ID: type: - string - 'null' Timestamp: type: string format: date-time CorrelationID: type: - string - 'null' HttpStatus: $ref: '#/components/schemas/HttpStatusCode' Messages: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' Errors: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' 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 - 'null' readOnly: true Data: $ref: '#/components/schemas/UnauthorizedError' 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 - 'null' additionalProperties: false BaseQuoteOperation: required: - op type: object properties: OperationType: $ref: '#/components/schemas/OperationType' path: type: - string - 'null' from: type: - string - 'null' value: {} op: minLength: 1 type: string description: add
remove
replace
move
copy
test
invalid 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 - 'null' City: minLength: 1 type: string State: maxLength: 2 minLength: 0 type: string Zip: minLength: 1 type: string additionalProperties: false EligibilityStatus: enum: - 0 = Incomplete - 1 = BindEligible - 2 = Refer - 3 = Decline type: integer description: '' format: int32 ThirdPartyNoticeDeleteModelV1: type: object properties: Indexes: type: - array - 'null' items: type: integer format: int32 additionalProperties: false FilePostModel: required: - FileData type: object properties: WindowsFileType: type: - string - 'null' description: WindowsFileType FileData: type: string description: FileData format: byte DisplayName: type: - string - 'null' description: DisplayName additionalProperties: false description: FilePostModel OfficerInformationModelIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/OfficerInformationModel' description: Data additionalProperties: false description: '' 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 - 'null' description: address line 1 Country: $ref: '#/components/schemas/CountryCodes' CountryName: type: - string - 'null' description: country name additionalProperties: false description: '' ApiMessage: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageCode: type: - string - 'null' MessageType: $ref: '#/components/schemas/ApiMessageType' Title: type: - string - 'null' Detail: type: - string - 'null' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true additionalProperties: false ModifierScheduleRationale: type: object properties: RationaleTypeId: type: integer description: Rationale Type Id format: int32 RationaleName: type: - string - 'null' description: Rationale Name additionalProperties: false Endorsement: type: object properties: FormType: type: - string - 'null' description: FormType FormSubType: type: - string - 'null' description: FormSubType Id: type: - string - 'null' description: Id Description: type: - string - 'null' description: Description MinOwnershipPercentage: type: number description: MinOwnershipPercentage format: double MaxOwnershipPercentage: type: number description: MaxOwnershipPercentage format: double OwnershipPctValidationMessage: type: - string - 'null' description: OwnershipPctValidationMessage MinAnnualCompensation: type: integer format: int32 MaxAnnualCompensation: type: integer format: int32 AnnualCompensationValidationMessage: type: - string - 'null' additionalProperties: false description: '' FailedDependencyErrorBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/FailedDependencyError' additionalProperties: false description: '' 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 PolicyRenewalResponse: type: object properties: RenewalPolicyNumber: type: - string - 'null' description: RenewalPolicyNumber TotalEstimatedAnnualPremium: type: number description: TotalEstimatedAnnualPremium format: double TotalStateAssessment: type: number description: TotalStateAssessment format: double ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/PolicyRenewalClassCode' description: ClassCodes additionalProperties: false description: PolicyRenewalResponse ModifierScheduleResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/ModifierScheduleResponse' description: Data additionalProperties: false description: '' SearchResult: type: object properties: ClassCode: type: - string - 'null' description: ClassCode ClassDecription: type: - string - 'null' description: ClassDecription ClassDecriptionCode: type: - string - 'null' description: ClassDecriptionCode MatchProbability: type: number description: MatchProbability format: double additionalProperties: false description: SearchResult DeleteLocationModel: required: - AddressLine1 type: object properties: LocationId: maximum: 2147483647.0 minimum: 1.0 type: integer format: int32 AddressLine1: minLength: 1 type: string additionalProperties: false ClassPutModel: type: object properties: IndexId: type: integer description: If not provided, a new class code will be added. format: int32 ClassCode: type: - string - 'null' description: NCCI Class Code. Must be 4 numeric characters for all states except 'DE' and 'PA' in which it must be 3 numeric characters ClassDescriptionCode: type: - string - 'null' description: Max 2 numeric characters if provided State: type: - string - 'null' description: 'Required if ClassCode is provided. Max 2 characters. Cannot be: "AK", "ND", "OH", "WA", "WY"' Payroll: type: - string - 'null' description: Required if ClassCode is provided 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 EndorsementInformation: type: object properties: ValidationMessage: type: - string - 'null' description: ValidationMessage Endorsements: type: - array - 'null' items: $ref: '#/components/schemas/Endorsement' description: Endorsements additionalProperties: false description: '' FormDataField: type: object properties: IndexId: type: integer description: IndexId format: int32 Label: type: - string - 'null' description: Label Required: type: boolean description: Required CanEnterFreeText: type: boolean description: CanEnterFreeText CurrentValue: type: - string - 'null' description: '' PresetValues: type: - array - 'null' items: type: string description: PresetValues additionalProperties: false description: '' QuotePostModel: type: object properties: Quote: $ref: '#/components/schemas/QuoteApiModel' LoadQuestions: type: - boolean - 'null' description: LoadQuestions Questions: type: - array - 'null' items: $ref: '#/components/schemas/Answer' description: Questions ExperienceModifier: $ref: '#/components/schemas/StateModifierPatchModel' StateModifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierPatchModel' DigitalClientWorkflow: type: - string - 'null' description: Only for WC. LoadRateSummary: type: boolean description: LoadRateSummary PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierPostModel' additionalProperties: false description: QuotePostModel HusbandAndWifeBase: type: object properties: Spouse1: type: - string - 'null' 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 Spouse2: type: - string - 'null' 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 additionalProperties: false QuoteReturnModel: type: object properties: EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: "Expiration Date. \nOnly for Specialty Program." Fein: type: - string - 'null' description: Fein PrimaryAddress: $ref: '#/components/schemas/AddressApiModel' MailingAddress: $ref: '#/components/schemas/AddressApiModel' BusinessName: type: - string - 'null' description: BusinessName DBA: type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactResponse' NatureOfBusiness: type: - string - 'null' description: NatureOfBusiness LegalEntity: type: integer description: LegalEntity format: int32 YearsInBusiness: type: integer description: YearsInBusiness format: int32 ExpiredPremium: type: - integer - 'null' description: ExpiredPremium format: int32 IsNonProfit: type: - boolean - 'null' description: IsNonProfit IsIncumbentAgent: type: - boolean - 'null' description: IsIncumbentAgent CompanyWebsiteAddress: type: - string - 'null' description: CompanyWebsiteAddress RatingZip: type: - string - 'null' description: RatingZip PayrollCompanyId: type: - integer - 'null' description: PayrollCompanyId format: int32 UnemploymentId: type: - string - 'null' description: UnemploymentId AccountInformation: $ref: '#/components/schemas/AccountInformation' PremiumDetails: $ref: '#/components/schemas/PremiumDetails' ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassApiReturnModel' description: ClassCodes Eligibility: $ref: '#/components/schemas/EligibilityResponse_2' Questions: type: - array - 'null' items: $ref: '#/components/schemas/QuestionResponse_2' description: Questions FirmId: type: - string - 'null' ExperienceModifier: type: - array - 'null' items: $ref: '#/components/schemas/StateModifiersResponse' description: 'Only for WC. Please use Modifiers section instead of this section.' DigitalClientWorkflow: type: - string - 'null' description: Only for WC. SpousesNames: $ref: '#/components/schemas/HusbandAndWifeBase' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: Only for Specialty Program. Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' description: Please use this new section instead of the Experience Modifier section. RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierResponseBase' additionalProperties: false description: QuoteReturnModel PaymentPlanResponseV2: type: object properties: Direct: type: - array - 'null' items: $ref: '#/components/schemas/PaymentPlanResponse' description: Direct Payment Plans (Includes PAYO) Agency: type: - array - 'null' items: $ref: '#/components/schemas/PaymentPlanResponse' description: Agency Payment Plans additionalProperties: false description: Return Model used in V2 (GET) PaymentPlan Endpoint QuestionResponse_2ListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/QuestionResponse_2' description: Data additionalProperties: false description: '' 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 SummaryItemBase: type: object properties: GovState: type: - string - 'null' ModelType: type: - string - 'null' ItemType: type: - string - 'null' ClassCode: type: - string - 'null' Description: type: - string - 'null' Premium: type: number format: double Year: type: integer format: int32 Rate: type: number format: double Exposure: type: integer format: int32 additionalProperties: false PaymentPlanType: enum: - 0 = None - 1 = Null - 2 = PAYO - 3 = PSR type: integer description: PaymenPlanType Enum format: int32 NetRateResponse: type: object properties: State: type: - string - 'null' description: State ClassCode: type: - string - 'null' description: ClassCode ClassDescription: type: - string - 'null' description: ClassDescription NetRate: type: number description: NetRate format: double additionalProperties: false description: NetRateResponse LegalEntityResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/LegalEntityResponse' description: Data additionalProperties: false description: '' 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 - 'null' description: PaymentPlanDescription PaymentPlanId: type: integer description: PaymentPlanId format: int32 PayrollCompanyId: type: - integer - 'null' description: PayrollCompanyId format: int32 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 - 'null' description: Contains a disclaimer if the IsDirectDebit field is true Invoices: type: - array - 'null' items: $ref: '#/components/schemas/Invoice' description: Invoice information for the saved installment schedule additionalProperties: false description: PaymentPlanResponse ThirdPartyNoticeGetDto: type: object properties: IndexId: type: integer format: int32 FirstName: type: - string - 'null' LastName: type: - string - 'null' Address1: type: - string - 'null' Address2: type: - string - 'null' City: type: - string - 'null' State: type: - string - 'null' Zip: type: - string - 'null' additionalProperties: false BaseContactResponse: type: object properties: Name: type: - string - 'null' Phone: type: - string - 'null' Email: type: - string - 'null' additionalProperties: false PatchQuotePatnerRequest: type: object properties: FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Organization: type: - string - 'null' description: Organization additionalProperties: false description: PatchQuotePatnerRequest PaymentPlan: required: - PaymentPlanType type: object properties: PaymentPlanType: minLength: 1 type: string description: 'PaymentPlanType. Available options: None PAYO PSR' InsuredName: type: - string - 'null' description: Insured's Name InsuredEmail: type: - string - 'null' description: Insured's Email AgentName: type: - string - 'null' description: Agent Name AgentEmail: type: - string - 'null' description: Agent Email AccountManagerCSRName: type: - string - 'null' description: Account Manager/CSR Name AccountManagerCSREmail: type: - string - 'null' description: Account Manager/CSR Email PayrollCompanyId: type: - integer - 'null' description: Payroll Company Id format: int32 additionalProperties: false description: PaymentPlan 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: '' InsuredReturnModel: type: object properties: Id: type: integer description: Unique Id associated with Isnured format: int32 Name: type: - string - 'null' description: Name TaxId: type: - string - 'null' description: TaxId State: type: - string - 'null' description: State LegalEntity: type: integer description: LegalEntity format: int32 DbaName: type: - string - 'null' description: DbaName UnemploymentId: type: - string - 'null' description: UnemploymentId AdditionalLocations: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalLocationReturnModel' description: AdditionalLocations additionalProperties: false description: InsuredReturnModel VoluntaryCompensationResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/VoluntaryCompensationResponse' description: Data additionalProperties: false description: '' StateModifiersResponse: type: object properties: State: type: - string - 'null' description: State Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/Modifier' description: Modifiers additionalProperties: false description: StateModifiersResponse UploadFileResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/UploadFileResponse' additionalProperties: false description: '' FailedDependencyError: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageType: $ref: '#/components/schemas/ApiMessageType' Detail: type: - string - 'null' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true MessageCode: type: - string - 'null' readOnly: true Title: type: - string - 'null' readOnly: true additionalProperties: false PaymentSystemInfo: required: - Amount - PaymentDescription type: object properties: Id: type: integer description: id , user does not provide it format: int32 Name: type: - string - 'null' description: name could be policy numnber LOB: type: - string - 'null' description: WC Type: type: - string - 'null' description: Type could be "Policy" PayrollMonth: type: - string - 'null' description: payroll month 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: '' 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 - 'null' description: LiabilityLimits additionalProperties: false description: PremiumDetails CrossSellGetReturnModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/CrossSellGetReturnModel' additionalProperties: false description: '' BindResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/BindResponse' additionalProperties: false description: '' AgentContact: type: object properties: Id: type: - string - 'null' description: Id is the agent contact id FullName: type: - string - 'null' description: agent full name , First name + last name Email: type: - string - 'null' description: agent email address AgentId: type: integer description: The agentId is the agency Id NOT agent contact id. format: int32 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 - 'null' additionalProperties: false Answer: type: object properties: QuestionId: type: integer description: QuestionId format: int32 AnswerValue: type: - string - 'null' 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 additionalProperties: false description: '' UwQuestionsResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/UwQuestionsResponse' additionalProperties: false description: '' QuotePartnersResponse: type: object properties: PartnerId: type: integer description: PartnerId format: int32 FirstName: type: - string - 'null' description: partner first name LastName: type: - string - 'null' description: partner last name Organization: type: - string - 'null' description: Organization additionalProperties: false description: '' ModifierPatchModel: type: object properties: LoadEligibility: type: boolean description: LoadEligibility StateModifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierPatchModel' description: StateModifiers additionalProperties: false description: ModifierPatchModel PolicyAdditionalLocation: type: object properties: LocationNumber: type: integer format: int32 Line1: type: - string - 'null' Line2: type: - string - 'null' City: type: - string - 'null' State: type: - string - 'null' Zip: type: - string - 'null' EmployeeCount: type: integer format: int32 NameInsured: type: - string - 'null' additionalProperties: false PolicyDividentDetailsResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PolicyDividentDetailsResponse' additionalProperties: false description: '' ApiPageResponse: type: object properties: First: type: - string - 'null' Previous: type: - string - 'null' Current: type: - string - 'null' Next: type: - string - 'null' Last: type: - string - 'null' PageSize: type: - integer - 'null' format: int32 Count: type: - integer - 'null' format: int32 additionalProperties: false AccountInformation: type: object properties: QuoteId: type: integer description: QuoteId format: int32 MasterAccountId: type: integer description: MasterAccountId format: int32 GoverningState: type: - string - 'null' description: GoverningState Status: type: - string - 'null' description: Status AccountUrl: type: - string - 'null' description: AccountUrl Carrier: type: - string - 'null' description: Carrier additionalProperties: false description: AccountInformation WaiverReadModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/WaiverReadModel' additionalProperties: false description: '' BadRequestErrorIApiResponse: type: object properties: ID: type: - string - 'null' Timestamp: type: string format: date-time CorrelationID: type: - string - 'null' HttpStatus: $ref: '#/components/schemas/HttpStatusCode' Messages: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' Errors: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' 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 - 'null' readOnly: true Data: $ref: '#/components/schemas/BadRequestError' additionalProperties: false StringIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: type: string description: Data additionalProperties: false description: '' AdditionalLocationReturnModel: type: object properties: Id: type: integer description: Id associated with Additional Location - Is unique when combined w/ Address1 format: int32 Address1: type: - string - 'null' description: Address1 Address2: type: - string - 'null' description: Address2 City: type: - string - 'null' description: City State: type: - string - 'null' description: State Zip: type: - string - 'null' description: Zip TotalEmployeeNumber: type: - integer - 'null' description: '' format: int32 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 ClassCodePostModel: type: object properties: ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeList' RatingZip: type: - string - 'null' description: ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set. additionalProperties: false PolicyOfficer: type: object properties: Name: type: - string - 'null' EndorsementId: type: - string - 'null' Type: type: - string - 'null' State: type: - string - 'null' OwnershipPercent: type: number format: double FormType: type: - string - 'null' OfficerDOB: type: string format: date-time OfficeHeld: type: - string - 'null' AnnualCompensation: type: integer format: int32 additionalProperties: false EndorsementEligibilityResponseVer2BaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/EndorsementEligibilityResponseVer2' additionalProperties: false description: '' AgentContactBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/AgentContact' additionalProperties: false description: '' TermsOfAgreementModel: required: - IsAcknowledged type: object properties: IsAcknowledged: minLength: 1 type: string description: 'Accepted values: Yes, No, True, False' additionalProperties: false StringStringKeyValuePair: type: object properties: Key: type: - string - 'null' Value: type: - string - 'null' 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 - 'null' description: OfficeHeld OwnershipPercent: maximum: 100.0 minimum: 0.0 type: number description: OwnershipPercent format: double FormType: $ref: '#/components/schemas/IncludingExcluding' DateOfBirth: type: - string - 'null' description: DateOfBirth format: date AnnualCompensation: maximum: 2147483647.0 minimum: 0.0 type: - integer - 'null' description: Only required if the state is NE and the legal entity is Nonprofit Corporation. It is not saved in other situations. format: int32 additionalProperties: false description: '' SubmitToUnderwriterResponseModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/SubmitToUnderwriterResponseModel' additionalProperties: false description: '' PayerInfoRequest: required: - EmailAddress type: object properties: FirstName: type: - string - 'null' description: payer's first name LastName: type: - string - 'null' description: payer's last name Address: $ref: '#/components/schemas/Address' EmailAddress: minLength: 1 type: string description: payer's emial Phone: type: - string - 'null' description: payer's phone additionalProperties: false description: '' QuotePartnersResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/QuotePartnersResponse' description: Data additionalProperties: false description: '' CrossSellGetReturnModel: type: object properties: DeepLink: type: - string - 'null' description: deep link BopQuoteNumber: type: integer description: BOP quote number format: int32 AnnualPremium: type: integer description: AnnualPremium format: int32 GeneralLiabilityLimits: type: - string - 'null' description: GeneralLiabilityLimits MedicalPayments: type: integer description: MedicalPayments format: int32 DamagestoPremisesLiabilityLimit: type: integer description: DamagestoPremisesLiabilityLimit format: int32 BusinessPersonalProperty: type: integer description: BusinessPersonalProperty format: int32 PropertyDeductible: type: - string - 'null' description: PropertyDeductible ExpansionEndorsement: type: - string - 'null' description: ExpansionEndorsement additionalProperties: false description: '' PolicyRenewalResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PolicyRenewalResponse' additionalProperties: false description: '' GetSicNaicsResponse: type: object properties: State: type: - string - 'null' description: 2 letter state ClassCode: type: - string - 'null' description: class code Eligibility: type: - string - 'null' description: 'eligibility: refer, decline, bindeligible' Information: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeInformation' description: '' AllStatesInformation: type: - string - 'null' description: when state is not provided all states are being send as a csv file format: byte ExpirationDate: type: - string - 'null' description: ExpirationDate format: date-time additionalProperties: false description: '' 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 - 'null' description: Text to display to user QuestionType: type: - string - 'null' description: 'Types include: bool, text, dropdown' DropdownOptions: type: - array - 'null' 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. 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 - 'null' description: If this value is answerd to the ParentQuestionId's question, display this question. Answer: type: - string - 'null' description: Answer saved by user. Null if not yet answered additionalProperties: false description: QuestionResponse_2 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 AdditionalInfoReturnModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/AdditionalInfoReturnModel' additionalProperties: false description: '' PolicyDocument: type: object properties: DocumentName: type: - string - 'null' description: DocumentName - it comes from a dictionray , it is based on the file type FileType: type: - string - 'null' description: FileType DocumentType: type: - string - 'null' description: DocumentType LibraryIndex: type: integer description: LibraryIndex format: int32 DateReceived: type: - string - 'null' description: LibraryIndex EndmtNum: type: - integer - 'null' description: EndmtNum for sorting documents. format: int32 additionalProperties: false description: PolicyDocument PolicySearchResponseIReadOnlyCollectionBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/PolicySearchResponse' description: Data additionalProperties: false description: '' NotFoundErrorBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/NotFoundError' additionalProperties: false description: '' FormDataFieldRequest: type: object properties: IndexId: type: integer description: IndexId format: int32 Values: type: - string - 'null' description: PresetValues additionalProperties: false description: FormDataField BindResponse: type: object properties: QuoteId: type: integer description: Quote associated with the Policy format: int32 Policy: type: - string - 'null' description: Policy Number generated when quote is bound PolicyId: type: integer description: Policy Id generated when quote is bound format: int32 EffectiveDate: type: - string - 'null' description: Effective date of the new Policy AnnualPremium: type: - string - 'null' description: Annual premium of the Policy (does not include taxes or fees) additionalProperties: false description: BindResponse AccountType: enum: - 1 = Checking - 2 = Savings type: integer format: int32 UnauthorizedError: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageType: $ref: '#/components/schemas/ApiMessageType' Detail: type: - string - 'null' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true MessageCode: type: - string - 'null' readOnly: true Title: type: - string - 'null' readOnly: true additionalProperties: false 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 - 'null' description: 'If the Insured State is in HI, ME, MN, or RI, an UnemploymentId is required. In HI, it must be exactly 10 characters In ME and RI, it must be exactly 10 digits In MN, it must be between 8-12 digits' DbaName: maxLength: 100 type: - string - 'null' description: DbaName AdditionalLocations: type: array items: $ref: '#/components/schemas/AdditionalInsuredLocation' description: 'Any additional locations associated with the Additional Insured. The quote must have exposure in location''s state to be added. One location is required per insured. If an insured is deleted, all it''s linked locations will be deleted as well.' additionalProperties: false description: '' PolicyEndorsementBulkResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/PolicyEndorsementBulkResponse' description: Data additionalProperties: false description: '' ForeignVoluntaryCoverageReadModel: type: object properties: IndexId: type: integer format: int32 GovState: type: - string - 'null' Employee: type: - string - 'null' Location: type: - string - 'null' WcLaw: type: - string - 'null' additionalProperties: false BaseAddressModel: required: - City - Line1 - State - Zip type: object properties: Line1: minLength: 1 type: string description: Line1 Line2: type: - string - 'null' description: Line2 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: '' PostDirectDebitResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PostDirectDebitResponse' additionalProperties: false description: '' StateClassCodesResponseListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/StateClassCodesResponse' description: Data additionalProperties: false description: '' AdditionalInsured: type: object properties: Id: type: integer format: int32 NamedInsuredId: type: integer format: int32 Name: type: - string - 'null' Dba: type: - string - 'null' Fein: type: - string - 'null' LegalEntity: type: integer format: int32 UnemploymentNumber: type: - string - 'null' Line1: type: - string - 'null' Line2: type: - string - 'null' City: type: - string - 'null' State: type: - string - 'null' Zip: type: - string - 'null' EmployeeCount: type: integer format: int32 additionalProperties: false PolicyDocumentIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/PolicyDocument' description: Data additionalProperties: false description: '' AdditionalCoverage: type: object properties: Coverage: type: - string - 'null' State: type: - string - 'null' Limit: type: - string - 'null' Period: type: - string - 'null' AnnualPayroll: type: - string - 'null' additionalProperties: false UploadFileResponse: type: object properties: LibraryId: type: integer description: LibraryId format: int32 additionalProperties: false description: UploadFileResponse ClassPutModelV2: type: object properties: ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassPutModel' RatingZip: type: - string - 'null' description: ratingZip is only required if the class code is in the state of CA and the ratingZip has not already been set. additionalProperties: false ClassCodeEligibilityResponse: type: object properties: ClassCode: type: - string - 'null' description: ClassCode ClassDescriptionCode: type: - string - 'null' description: ClassDescriptionCode ClassDescription: type: - string - 'null' description: ClassDescription Eligibility: type: - string - 'null' description: Eligibility EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: ExpirationDate additionalProperties: false description: ClassCodeEligibilityResponse PolicySearchResponse: type: object properties: PolicyNumber: type: - string - 'null' BusinessName: type: - string - 'null' EffectiveDate: type: string format: date-time PolicyStatus: type: - string - 'null' additionalProperties: false BasePaymentAmount: type: object properties: Currency: type: - string - 'null' description: currency Total: type: number description: total amount format: double additionalProperties: false description: BasePaymentAmount StopGapCoverage: type: object properties: CoverageName: type: - string - 'null' State: type: - string - 'null' Limit: type: - string - 'null' Period: type: - string - 'null' AnnualPayroll: type: - string - 'null' additionalProperties: false FullQuoteReturnModel: type: object properties: EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: "Expiration Date. \nOnly for Specialty Program." Fein: type: - string - 'null' description: Fein PrimaryAddress: $ref: '#/components/schemas/AddressApiModel' MailingAddress: $ref: '#/components/schemas/AddressApiModel' BusinessName: type: - string - 'null' description: BusinessName DBA: type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactResponse' NatureOfBusiness: type: - string - 'null' description: NatureOfBusiness LegalEntity: type: integer description: LegalEntity format: int32 YearsInBusiness: type: integer description: YearsInBusiness format: int32 ExpiredPremium: type: - integer - 'null' description: ExpiredPremium format: int32 IsNonProfit: type: - boolean - 'null' description: IsNonProfit IsIncumbentAgent: type: - boolean - 'null' description: IsIncumbentAgent CompanyWebsiteAddress: type: - string - 'null' description: CompanyWebsiteAddress RatingZip: type: - string - 'null' description: RatingZip PayrollCompanyId: type: - integer - 'null' description: PayrollCompanyId format: int32 UnemploymentId: type: - string - 'null' description: UnemploymentId AccountInformation: $ref: '#/components/schemas/AccountInformation' PremiumDetails: $ref: '#/components/schemas/PremiumDetails' ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassApiReturnModel' description: ClassCodes Eligibility: $ref: '#/components/schemas/EligibilityResponse_2' Questions: type: - array - 'null' items: $ref: '#/components/schemas/QuestionResponse_2' description: Questions FirmId: type: - string - 'null' ExperienceModifier: type: - array - 'null' items: $ref: '#/components/schemas/StateModifiersResponse' description: 'Only for WC. Please use Modifiers section instead of this section.' DigitalClientWorkflow: type: - string - 'null' description: Only for WC. SpousesNames: $ref: '#/components/schemas/HusbandAndWifeBase' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: Only for Specialty Program. Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' description: Please use this new section instead of the Experience Modifier section. RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierResponseBase' AdditionalInformation: $ref: '#/components/schemas/AdditionalInfoReturnModel' QuoteStatus: type: - string - 'null' description: QuoteStatus ClosedDate: type: string description: Closed Date format: date-time ForeignVoluntaryCoverage: type: - array - 'null' items: $ref: '#/components/schemas/ForeignVoluntaryCoverageReadModel' SpecificWaivers: type: - array - 'null' items: $ref: '#/components/schemas/WaiverReadModel' additionalProperties: false description: FullQuoteReturnModel StringListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: type: string description: Data additionalProperties: false description: '' AgentPayrollCompaniesResponseIListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/AgentPayrollCompaniesResponse' description: Data additionalProperties: false description: '' Modifier: type: object properties: Id: type: - string - 'null' description: Id Value: type: - string - 'null' description: Value ModifierUiInformation: $ref: '#/components/schemas/ModifierUiInformation' ExcludingModifier: $ref: '#/components/schemas/ExcludingModifier' State: type: - string - 'null' description: State additionalProperties: false description: Modifier OfficerInformationModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/OfficerInformationModel' additionalProperties: false description: '' GetEligibilityResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/GetEligibilityResponse' additionalProperties: false description: '' CreditCardType: enum: - 0 = Visa - 1 = Mastercard - 2 = Discover - 3 = Amex - 4 = DinersClub - 5 = Valid - 6 = JCB - -1 = Invalid type: integer description: CreditCardType format: int32 PricingTierResponseBase: type: object properties: TierId: type: integer format: int32 State: type: - string - 'null' additionalProperties: false PolicyEndorsementV3: type: object properties: Type: type: - string - 'null' description: Type Reason: type: - string - 'null' description: Reason additionalProperties: false description: PolicyEndorsement GetSicNaicsResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/GetSicNaicsResponse' description: Data additionalProperties: false description: '' OfficerTypes: enum: - 1 = Officers - 2 = Partners - 3 = Other - 4 = SoleProprietor - 5 = Member type: integer description: '' format: int32 EligibilityDetail: type: object properties: Type: type: - string - 'null' description: Type Eligibility: type: - string - 'null' description: Eligibility additionalProperties: false description: '' GetUnderwritingMessage: type: object properties: IndexId: type: integer format: int32 User: type: - string - 'null' description: Name Message: type: - string - 'null' description: Message AgentEntry: type: boolean Sent: type: string description: Date Sent format: date-time additionalProperties: false description: Underwriter Message AddressApiModel: required: - City - Line1 - State - Zip type: object properties: Line1: minLength: 1 type: string description: Line1 Line2: type: - string - 'null' description: Line2 City: minLength: 1 type: string description: City State: minLength: 1 type: string description: State Zip: minLength: 1 type: string description: Zip additionalProperties: false description: '' EarnedPremium: type: object properties: State: type: - string - 'null' DateEarned: type: string format: date-time Description: type: - string - 'null' EarnedAmount: type: integer format: int32 additionalProperties: false PolicyEndorsementBulkResponse: type: object properties: Type: type: - string - 'null' Endorsements: type: - array - 'null' items: $ref: '#/components/schemas/EndorsementResponseResult' Reason: type: - string - 'null' description: Reason additionalProperties: false description: PolicyEndorsementResponse VoluntaryCompensationResponse: type: object properties: EndorsementNumber: type: - string - 'null' description: EndorsementNumber Description: type: - string - 'null' description: Description FormDataFields: type: - array - 'null' items: $ref: '#/components/schemas/FormDataField' description: FormDataFields additionalProperties: false description: '' CreditCard: type: object properties: CreditCardNumber: type: - string - 'null' description: CreditCardNumber CardType: $ref: '#/components/schemas/CreditCardType' CVV: type: - string - 'null' description: Cvv ExpirationMonth: type: integer description: ExpirationMonth format: int32 ExpirationYear: type: integer description: ExpirationYear format: int32 additionalProperties: false description: CreditCard Questions: required: - ClassCodeList type: object properties: ClassCodeList: type: array items: $ref: '#/components/schemas/QuestionsClassCode' description: Required to get Question Sets additionalProperties: false description: '' ApiPaging: type: object properties: Request: $ref: '#/components/schemas/ApiPageRequest' Response: $ref: '#/components/schemas/ApiPageResponse' additionalProperties: false QuoteInformation: type: object properties: QuoteId: type: integer description: QuoteId format: int32 Product: type: - string - 'null' description: Product EffectiveDate: type: - string - 'null' description: EffectiveDate Premium: type: number description: Premium format: double additionalProperties: false description: QuoteInformation AgentPayrollCompaniesResponse: type: object properties: PayrollCompanyId: type: integer description: PayrollCompanyId format: int32 PayrollCompanyName: type: - string - 'null' description: PayrollCompanyName additionalProperties: false description: Model containing Payo Payroll Companies for a given agent SubChangeReasonModel: type: object properties: EndmtSubType: type: - string - 'null' EndmtChangeReason: type: - string - 'null' EndmtChangeReasonId: type: integer format: int32 additionalProperties: false ForbiddenError: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageType: $ref: '#/components/schemas/ApiMessageType' Detail: type: - string - 'null' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true MessageCode: type: - string - 'null' readOnly: true Title: type: - string - 'null' readOnly: true additionalProperties: false PolicyRenewalClassCode: type: object properties: State: type: - string - 'null' description: State ClassCode: type: - string - 'null' description: ClassCode ClassCodeDescription: type: - string - 'null' description: ClassCodeDescription ExposureLimit: type: - string - 'null' description: ExposureLimit Rate: type: number description: Rate format: double additionalProperties: false description: PolicyRenewalClassCode StateModifierPatchModel: type: object properties: State: type: - string - 'null' description: State Modifiers: type: - object - 'null' additionalProperties: type: - string - 'null' description: Modifiers ---- key = modifierId ; value = modifier value additionalProperties: false description: '' QuoteApiReturnModelIApiResponse: type: object properties: ID: type: - string - 'null' Timestamp: type: string format: date-time CorrelationID: type: - string - 'null' HttpStatus: $ref: '#/components/schemas/HttpStatusCode' Messages: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' Errors: type: - array - 'null' items: $ref: '#/components/schemas/ApiMessage' 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 - 'null' readOnly: true Data: $ref: '#/components/schemas/QuoteApiReturnModel' additionalProperties: false 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. We 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 SubmitToUnderwriterResponseModel: type: object properties: MasterAccountId: type: integer description: MasterAccountId format: int32 SubmittedDate: type: - string - 'null' description: SubmittedDate BusinessName: type: - string - 'null' description: BusinessName QuoteInformation: $ref: '#/components/schemas/QuoteInformation' additionalProperties: false description: SubmitToUnderwriterResponseModel AdditionalInfoPostModelV2: type: object properties: Officers: type: - array - 'null' items: $ref: '#/components/schemas/Officer' description: Included / Excluded Officers on quote. If none, send null AdditionalInsureds: type: - array - 'null' items: $ref: '#/components/schemas/Insured' description: If none, send null AdditionalPrimaryInsuredLocations: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInsuredLocation' description: 'Any Additional Locations associated with the quote''s primary insured. If none, send null The quote must have exposure in location''s state to be added.' ThirdPartyNotices: type: - array - 'null' items: $ref: '#/components/schemas/ThirdPartyNoticePostDto' description: Any Additional third party notices. additionalProperties: false AdditionalInfoReturnModel: type: object properties: Officers: type: - array - 'null' items: $ref: '#/components/schemas/OfficerReturnModel' description: Officers AdditionalInsureds: type: - array - 'null' items: $ref: '#/components/schemas/InsuredReturnModel' description: AdditionalInsureds AdditionalPrimaryInsuredLocations: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalLocationReturnModel' description: AdditionalPrimaryInsuredLocations ThirdPartyNotices: type: - array - 'null' items: $ref: '#/components/schemas/ThirdPartyNoticeGetDto' description: Third party notices additionalProperties: false description: AdditionalInfoReturnModel QuotePutModel: type: object properties: EffectiveDate: type: - string - 'null' description: 'The desired date of policy coverage start. Must be in date format: mm/dd/yyyy' Fein: type: - string - 'null' description: Applicant's FEIN. If provided, accepted format is exactly 9 numeric characters ex. 123456789. Required to bind for WC quotes PrimaryAddress: $ref: '#/components/schemas/AddressPutApiModel' MailingAddress: $ref: '#/components/schemas/AddressApiModel' ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassPutModel' description: ClassCodes BusinessName: maxLength: 90 minLength: 0 type: - string - 'null' description: BusinessName DBA: maxLength: 90 minLength: 0 type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactApiModel' NatureOfBusiness: type: - string - 'null' description: Required to bind. LegalEntity: type: - integer - 'null' description: Required to bind. format: int32 YearsInBusiness: type: - integer - 'null' description: Required to bind. format: int32 ExpiredPremium: type: - integer - 'null' description: Required to bind. format: int32 IsNonProfit: type: - boolean - 'null' description: Required to bind. IsIncumbantAgent: type: - boolean - 'null' description: Required to bind. CompanyWebsiteAddress: type: - string - 'null' description: The customer's company website RatingZip: type: - string - 'null' 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. LiabilityLimits: type: - string - 'null' description: Save option from AvailableLiabiiltyLimits if default not wanted. If null, white space, or unavailable option, default value will remain. UnemploymentId: type: - string - 'null' description: UnemploymentId DigitalClientWorkflow: type: - string - 'null' description: 'DigitalClientWorkflow Only for WC' ExpirationDate: type: - string - 'null' description: 'ExpirationDate can be any date after today and within the next 12 months. Only for Specialty Program.' format: date-time FirmId: type: - string - 'null' description: 'Firm Id. Only for Specialty Program.' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: 'Additional Coverages like Stop Gap. Only for Specialty Program.' MasterAccountId: type: - integer - 'null' 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 BillType: $ref: '#/components/schemas/Billing' PayrollCompanyId: type: - integer - 'null' description: 'PayrollCompanyId Only for Specialty Program.' format: int32 StateModifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierPatchModel' description: 'Modifiers Only for Specialty Program.' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierPostModel' additionalProperties: false description: '' PolicyDividentDetailsResponse: type: object properties: PlanDescription: type: - string - 'null' ApprovedDate: type: - string - 'null' format: date-time DivCalcDone: type: - string - 'null' format: date-time DividendAmount: type: integer format: int32 DivWrittenPremium: type: integer format: int32 NetIncurred: type: integer format: int32 States: type: - array - 'null' items: type: string ApprovedBy: type: - string - 'null' DisqualifyNotes: type: - string - 'null' DividentPercentage: type: number format: double DivLossRatio: type: number format: double additionalProperties: false QuestionInformation: type: object properties: QuestionId: type: integer description: QuestionId format: int32 QuestionType: type: - string - 'null' description: QuestionType Question: type: - string - 'null' description: Question ExpirationDate: type: - string - 'null' description: ExpirationDate format: date-time additionalProperties: false description: QuestionInformation ModifierScheduleResponseDetail: type: object properties: CategoryTypeId: type: integer description: Category Type Id format: int32 CategoryName: type: - string - 'null' description: Category Name Amount: type: number description: Amount format: double IsSystemDefault: type: boolean Rationales: type: - array - 'null' items: $ref: '#/components/schemas/ModifierScheduleRationale' additionalProperties: false NaturalLanguageResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/NaturalLanguageResponse' description: Data additionalProperties: false description: '' ApiMessageType: enum: - 0 = Info - 1 = Error type: integer format: int32 ContactApiModel: type: object properties: FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Email: type: - string - 'null' description: Email format: email Phone: pattern: ((\(\d{3}\)?)|(\d{3}))([\s-./]?)(\d{3})([\s-./]?)(\d{4}) type: - string - 'null' description: Phone AgentContactId: type: - integer - 'null' description: AgentContactId format: int32 AgentContactName: type: - string - 'null' description: AgentContactName 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 - 'null' additionalProperties: false LegalEntityResponse: type: object properties: LegalEntityId: type: integer description: Int associated with a Legal Entity's description. Save this value. format: int32 EntityDescription: type: - string - 'null' description: Description of Legal Entity for display additionalProperties: false description: LegalEntityResponse ClassCodeEligibilityResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeEligibilityResponse' description: Data 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 - 'null' items: $ref: '#/components/schemas/PolicyEndorsementV3' description: EndorsementModel PolicyEndorsements additionalProperties: false NaturalLanguageResponse: type: object properties: ProductLine: type: - string - 'null' description: ProductLine SearchResults: type: - array - 'null' items: $ref: '#/components/schemas/SearchResult' description: SearchResults additionalProperties: false description: NaturalLanguageResponse QuestionsResponse: type: object properties: HttpStatusCode: $ref: '#/components/schemas/HttpStatusCode' StatusCode: type: - string - 'null' description: StatusCode Service: type: - string - 'null' description: Service Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Questions: type: - array - 'null' items: $ref: '#/components/schemas/QuestionResponse' description: All questions that must be answered to be able to bind the associated quote MasterEligibilityStatus: $ref: '#/components/schemas/EligibilityStatus' additionalProperties: false description: QuestionsResponse EndorsementHistoryResponse: type: object properties: Summary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryEndmt' Written: type: - array - 'null' items: $ref: '#/components/schemas/WrittenPremium' Earned: type: - array - 'null' items: $ref: '#/components/schemas/EarnedPremium' additionalProperties: false QuoteReturnModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/QuoteReturnModel' additionalProperties: false description: '' ClassCodeList: type: object properties: ClassCode: type: - string - 'null' description: NCCI Class Code. Must be 4 numeric characters for all states except 'DE' and 'PA' in which it must be 3 numeric characters ClassDescriptionCode: type: - string - 'null' description: Max 2 numeric characters if provided; defalulted if not LocState: type: - string - 'null' description: 'Required if ClassCode is provided. Max 2 characters. annot be: "AK", "ND", "OH", "WA", "WY"' Payroll: type: - string - 'null' description: Required if ClassCode is provided 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: '' Rationale: type: object properties: RationalName: type: - string - 'null' RationaleTypeId: type: integer format: int32 additionalProperties: false ClassPostModel: type: object properties: ClassCode: type: - string - 'null' description: ClassCode ClassDescriptionCode: type: - string - 'null' description: Max 2 numeric characters if provided State: type: - string - 'null' description: 'Required if ClassCode is provided. Max 2 characters. Cannot be: "AK", "ND", "OH", "WA", "WY"' 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: '' UwQuestionsResponse: type: object properties: GeneralQuestions: type: - array - 'null' items: $ref: '#/components/schemas/QuestionInformation' description: '' AllQuestionsBinary: type: - string - 'null' description: '' format: byte ClassCodeQuestions: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeQuestion' description: '' additionalProperties: false description: '' AgentInfoReturnModelIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/AgentInfoReturnModel' description: Data additionalProperties: false description: '' CategoryRationale: type: object properties: CategoryTypeId: type: integer format: int32 Category: type: - string - 'null' Minimum: type: - number - 'null' format: double Maximum: type: - number - 'null' format: double Rationales: type: - array - 'null' items: $ref: '#/components/schemas/Rationale' additionalProperties: false BillTypeResponse: type: object properties: BillTypes: type: - array - 'null' items: type: string description: bill types-- I for Agent and D for direct EndQuotingNewBusinessDate: type: - string - 'null' format: date-time 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 ContactResponse: type: object properties: FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Email: type: - string - 'null' description: Email Phone: type: - string - 'null' description: Phone AgentContactId: type: - integer - 'null' description: AgentContactId format: int32 AgentContactName: type: - string - 'null' description: AgentContactName additionalProperties: false description: '' StateModifiersResponseIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/StateModifiersResponse' description: Data additionalProperties: false description: '' PostQuotePartnerRequest: type: object properties: FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Organization: type: - string - 'null' description: Organization additionalProperties: false description: '' PrimaryInsuredAdditionalLocation: type: object properties: LocationNumber: type: integer format: int32 Line1: type: - string - 'null' Line2: type: - string - 'null' City: type: - string - 'null' State: type: - string - 'null' Zip: type: - string - 'null' EmployeeCount: type: integer format: int32 additionalProperties: false ClassInformationResponse: type: object properties: State: type: - string - 'null' description: 2 letter state ClassCode: type: - string - 'null' description: class code ClassCodeDescriptionCode: type: - string - 'null' description: class code description code ClassCodeDescription: type: - string - 'null' description: class code description ExpirationDate: type: - string - 'null' description: ExpirationDate format: date-time additionalProperties: false description: '' SummaryEndmt: type: object properties: EndorsementNumber: type: integer format: int32 EffectiveDate: type: - string - 'null' format: date-time Type: type: - string - 'null' Description: type: - string - 'null' CommitedBy: type: - string - 'null' DateCompleted: type: - string - 'null' format: date-time additionalProperties: false QuestionsClassCode: type: object properties: ClassCode: type: - string - 'null' description: ClassCode LocState: type: - string - 'null' description: LocState additionalProperties: false description: '' StateClassCodeModel: type: object properties: ClassCode: type: - string - 'null' description: ClassCode ClassDescriptionCode: type: - string - 'null' description: ClassDescriptionCode ClassDescription: type: - string - 'null' description: ClassDescription additionalProperties: false description: StateClassCodeModel PricingTierPostModel: required: - State - TierId type: object properties: TierId: type: integer format: int32 State: minLength: 1 type: string additionalProperties: false OfficerReturnModel: type: object properties: Id: type: integer description: Unique Id associated with Officer format: int32 Name: type: - string - 'null' description: Name EndorsementId: type: - string - 'null' description: EndorsementId Type: type: - string - 'null' description: Type State: type: - string - 'null' description: State OwnershipPercent: type: number description: OwnershipPercent format: double FormType: type: - string - 'null' description: FormType DateOfBirth: type: - string - 'null' description: DateOfBirth OfficeHeld: type: - string - 'null' description: OfficeHeld AnnualCompensation: type: - integer - 'null' description: '' format: int32 additionalProperties: false description: OfficerReturnModel EndorsementHistoryResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/EndorsementHistoryResponse' additionalProperties: false description: '' IncludingExcluding: enum: - 0 = I - 1 = E type: integer description: '' format: int32 NotFoundError: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageType: $ref: '#/components/schemas/ApiMessageType' Detail: type: - string - 'null' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true MessageCode: type: - string - 'null' readOnly: true Title: type: - string - 'null' readOnly: true additionalProperties: false ModifierUiInformation: type: object properties: Description: type: - string - 'null' description: Description RegexFormatting: type: - string - 'null' description: RegexFormatting ModifierType: type: - string - 'null' description: ModifierType OnlyAvailableValues: type: - array - 'null' items: type: - number - 'null' format: double description: OnlyAvailableValues MinValue: type: - number - 'null' description: MinValue format: double MaxValue: type: - number - 'null' description: MaxValue format: double additionalProperties: false description: ModifierUiInformation EndorsementEligibilityResponseVer2: type: object properties: EndorsementType: type: - array - 'null' items: type: string description: EndorsementType IneligibilityReason: type: - array - 'null' items: type: string description: IneligibilityReason CurrentPartners: type: - array - 'null' items: $ref: '#/components/schemas/CurrentPartnerModel' description: CurrentPartners SubChangeReasons: type: - array - 'null' items: $ref: '#/components/schemas/SubChangeReasonModel' description: SubChangeReasons additionalProperties: false description: Endorsement Eligibility Response Version 2 PutQuotePatnerRequest: type: object properties: PartnerId: type: integer description: PartnerId format: int32 FirstName: type: - string - 'null' description: FirstName LastName: type: - string - 'null' description: LastName Organization: type: - string - 'null' description: Organization additionalProperties: false description: '' BadRequestError: type: object properties: Id: type: - integer - 'null' format: int32 HttpStatus: $ref: '#/components/schemas/HttpStatusCode' MessageType: $ref: '#/components/schemas/ApiMessageType' Internal: type: - string - 'null' Reference: type: - string - 'null' Exception: $ref: '#/components/schemas/LogException' IsOk: type: boolean NeedsSanitization: type: boolean readOnly: true MessageCode: type: - string - 'null' readOnly: true Title: type: - string - 'null' readOnly: true Detail: type: - string - 'null' readOnly: true additionalProperties: false MessageToUnderwriterModelV2: required: - Message - Reason type: object properties: Message: minLength: 1 type: string Reason: minLength: 1 type: string additionalProperties: false ModifiersPatchResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/ModifiersPatchResponse' additionalProperties: false description: '' 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 ExcludingModifier: type: object properties: Id: type: - string - 'null' description: Id Description: type: - string - 'null' description: Description Value: type: - string - 'null' description: Value additionalProperties: false description: ExcludingModifier ApiPageRequest: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Count: type: boolean additionalProperties: false QuotePartnersResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/QuotePartnersResponse' additionalProperties: false description: '' OperationType: enum: - 0 = Add - 1 = Remove - 2 = Replace - 3 = Move - 4 = Copy - 5 = Test - 6 = Invalid type: integer format: int32 ByteArrayBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - string - 'null' description: Data format: byte additionalProperties: false description: '' SubmitToUnderwriterModel: required: - NoteToUnderwriter type: object properties: NoteToUnderwriter: minLength: 1 type: string description: Additional information an Underwriter might need. AgentNeedByDate: type: - string - 'null' 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 additionalProperties: false ModifiersPatchResponse: type: object properties: Eligibility: $ref: '#/components/schemas/EligibilityResponse_2' additionalProperties: false description: ModifiersPatchResponse BalanceSummaryResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/BalanceSummaryResponse' additionalProperties: false description: '' ModifierScheduleResponse: type: object properties: State: type: - string - 'null' description: State Categories: type: - array - 'null' items: $ref: '#/components/schemas/ModifierScheduleResponseDetail' additionalProperties: false FullQuoteReturnModelBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/FullQuoteReturnModel' additionalProperties: false description: '' BaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors additionalProperties: false description: '' PolicyInformationResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PolicyInformationResponse' additionalProperties: false description: '' OptionalAddressApiModel: type: object properties: Line1: type: - string - 'null' description: Line1 Line2: type: - string - 'null' description: Line2 City: type: - string - 'null' description: City State: type: - string - 'null' description: State Zip: type: - string - 'null' description: Zip additionalProperties: false BillTypeResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/BillTypeResponse' additionalProperties: false description: '' StringBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - string - 'null' description: Data additionalProperties: false description: '' PolicyInformationResponse: type: object properties: MasterAccountId: type: integer format: int32 Policy: type: - string - 'null' PolicyId: type: integer format: int32 Quote: type: - string - 'null' Premium: type: - string - 'null' DBA: type: - string - 'null' BusinessName: type: - string - 'null' PrimaryAddress: $ref: '#/components/schemas/BaseAddressModel' MailingAddress: $ref: '#/components/schemas/BaseAddressModel' Fein: type: - string - 'null' EffectiveDate: type: string format: date-time ExpirationDate: type: string format: date-time InsuredContact: $ref: '#/components/schemas/BaseContactResponse' LegalEntity: type: - string - 'null' PolicyStatus: type: - string - 'null' StateTaxes: type: integer format: int32 EstimatedAnnual: type: integer format: int32 EarnedPremium: type: - string - 'null' RatingZip: type: - string - 'null' CancelInformation: $ref: '#/components/schemas/CancelInformation' CompanyWebsite: type: - string - 'null' CarrierName: type: - string - 'null' ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/PolicyClassCode' Officers: type: - array - 'null' items: $ref: '#/components/schemas/PolicyOfficer' StopGapCoverages: type: - array - 'null' items: $ref: '#/components/schemas/StopGapCoverage' Partners: type: - array - 'null' items: $ref: '#/components/schemas/PolicyPartner' Limits: type: - array - 'null' items: $ref: '#/components/schemas/Limit' AdditionalInsureds: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInsured' PrimaryInsuredAdditionalLocations: type: - array - 'null' items: $ref: '#/components/schemas/PrimaryInsuredAdditionalLocation' AdditionalLocations: type: - array - 'null' items: $ref: '#/components/schemas/PolicyAdditionalLocation' RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' SpecificWaivers: type: - array - 'null' items: $ref: '#/components/schemas/WaiverReadModel' NonRenewalDate: type: - string - 'null' NonRenewalReason: type: - string - 'null' additionalProperties: false WrittenPremium: type: object properties: State: type: - string - 'null' Date: type: string format: date-time Description: type: - string - 'null' WrittenAmount: type: integer format: int32 additionalProperties: false QuoteApiModel: required: - PrimaryAddress type: object properties: MasterAccountId: type: - integer - 'null' 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 BillType: $ref: '#/components/schemas/Billing' EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: 'ExpirationDate can be any date after today and within the next 12 months. Only for Specialty Program.' format: date-time Fein: type: - string - 'null' description: Applicant's FEIN. If provided, 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 - 'null' description: BusinessName DBA: maxLength: 90 minLength: 0 type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactApiModelPost' NatureOfBusiness: type: - string - 'null' description: Description of Applicant's operations. Required to bind. LegalEntity: type: - integer - 'null' description: Legal Entity associated with quote's governing state. Required to bind. format: int32 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 - 'null' description: Identifies if the insured operates as a Not-for-profit business. IsIncumbentAgent: type: - boolean - 'null' CompanyWebsiteAddress: type: - string - 'null' description: Applicant's business website ClassCodes: type: - array - 'null' 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) RatingZip: type: - string - 'null' description: 'Required to bind if any location is in California - ie ClassCode state or Primary Address State. Required if the primary address is in CA and a CA class code is included on a quote.' UnemploymentId: type: - string - 'null' description: 'If the PrimaryAddress State is in HI, ME, MN, or RI, an UnemploymentId is required. In HI, it must be exactly 10 characters In ME and RI, it must be exactly 10 digits In MN, it must be between 8-12 digits' PayrollCompanyId: type: - integer - 'null' description: PayrollCompanyId format: int32 LiabilityLimits: type: - string - 'null' FirmId: type: - string - 'null' description: 'Firm Id. Only for Specialty Program.' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: 'Additional Coverages like Stop Gap. Only for Specialty Program.' SpousesNames: $ref: '#/components/schemas/HusbandAndWifeBase' additionalProperties: false description: '' StateClassCodesResponse: type: object properties: State: type: - string - 'null' description: State ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/StateClassCodeModel' description: ClassCodes additionalProperties: false description: StateClassCodesResponse 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: '' 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 - 'null' description: PaymentsApi is sending a transaction id for tracking additionalProperties: false description: '' EligibilityResponse_2: type: object properties: Eligibility: type: - string - 'null' description: Eligibility Details: type: - array - 'null' items: $ref: '#/components/schemas/EligibilityDetail' description: Details additionalProperties: false description: '' ClassCodeQuestion: type: object properties: State: type: - string - 'null' description: '' ClassCode: type: - string - 'null' description: ClassCode Questions: type: - array - 'null' items: $ref: '#/components/schemas/QuestionInformation' description: Questions additionalProperties: false description: '' GetEligibilityResponse: type: object properties: Eligibility: type: - string - 'null' description: Eligibility Details: type: - array - 'null' items: $ref: '#/components/schemas/EligibilityDetail' description: Details QuoteStatus: type: - string - 'null' description: Quote status, could be BindEligible, refer, ... additionalProperties: false description: '' WaiverReadModelIEnumerableBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/WaiverReadModel' description: Data additionalProperties: false description: '' ClassApiReturnModel: type: object properties: HttpStatusCode: $ref: '#/components/schemas/HttpStatusCode' StatusCode: type: - string - 'null' description: StatusCode Service: type: - string - 'null' description: Service Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages IndexId: type: integer description: IndexId format: int32 ClassCode: type: - string - 'null' description: ClassCode ClassDescriptionCode: type: - string - 'null' description: ClassDescriptionCode State: type: - string - 'null' description: State Payroll: type: - string - 'null' description: Payroll FullTimeEmployees: type: integer description: FullTimeEmployees format: int32 PartTimeEmployees: type: integer description: PartTimeEmployees format: int32 additionalProperties: false description: '' 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: '' BaseClassCodeModelListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/BaseClassCodeModel' description: Data additionalProperties: false description: '' PaymentResponseBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: $ref: '#/components/schemas/PaymentResponse' additionalProperties: false description: '' StateCategoryRationale: type: object properties: State: type: - string - 'null' Categories: type: - array - 'null' items: $ref: '#/components/schemas/CategoryRationale' additionalProperties: false CountryCodes: enum: - 225 = US type: integer description: us = 225 format: int32 QuoteApiReturnModel: type: object properties: HttpStatusCode: $ref: '#/components/schemas/HttpStatusCode' StatusCode: type: - string - 'null' description: StatusCode Service: type: - string - 'null' description: Service Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages EffectiveDate: type: - string - 'null' description: EffectiveDate Fein: type: - string - 'null' description: Fein PrimaryAddress: $ref: '#/components/schemas/AddressApiModel' MailingAddress: $ref: '#/components/schemas/AddressApiModel' ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassApiReturnModel' description: ClassCodes BusinessName: type: - string - 'null' description: BusinessName DBA: type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactApiModel' NatureOfBusiness: type: - string - 'null' description: NatureOfBusiness LegalEntity: type: integer description: LegalEntity format: int32 LiabilityLimits: type: - string - 'null' description: LiabilityLimits YearsInBusiness: type: integer description: YearsInBusiness format: int32 ExpiredPremium: type: integer description: ExpiredPremium format: int32 IsNonProfit: type: - boolean - 'null' description: IsNonProfit IsIncumbantAgent: type: - boolean - 'null' description: IsIncumbantAgent CompanyWebsiteAddress: type: - string - 'null' description: CompanyWebsiteAddress EstimatedAnnualPremium: type: integer description: EstimatedAnnualPremium format: int32 GoverningState: type: - string - 'null' description: GoverningState MasterAccountId: type: integer description: MasterAccountId format: int32 RatingZip: type: - string - 'null' description: RatingZip UnemploymentId: type: - string - 'null' description: UnemploymentId Eligibility: $ref: '#/components/schemas/GetEligibilityResponse' DigitalClientWorkflow: type: - string - 'null' description: 'DigitalClientWorkflow Only WC' RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' ExpirationDate: type: - string - 'null' description: 'ExpirationDate can be any date after today and within the next 12 months. Only for Specialty Program.' FirmId: type: - string - 'null' description: 'Firm Id. Only for Specialty Program.' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: 'Additional Coverages like Stop Gap. Only for Specialty Program.' PayrollCompanyId: type: - integer - 'null' description: 'PayrollCompanyId Only for Specialty Program.' format: int32 StateModifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' description: 'StateModifiers Only for Specialty Program.' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierResponseBase' additionalProperties: false description: QuoteApiReturnModel 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 - 'null' description: Text to display to user QuestionType: type: - string - 'null' description: 'Types include: bool, text, dropdown' DropdownOptions: type: - array - 'null' 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. 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 - 'null' description: If this value is answerd to the ParentQuestionId's question, display this question. Answer: type: - string - 'null' description: Answer saved by user. Null if not yet answered IsDuplicateQuestion: type: boolean additionalProperties: false description: QuestionResponse BaseClassCodeModel: type: object properties: HttpStatusCode: $ref: '#/components/schemas/HttpStatusCode' StatusCode: type: - string - 'null' description: StatusCode Service: type: - string - 'null' description: Service Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages IndexId: type: integer description: IndexId format: int32 OriginalClassCode: type: - string - 'null' readOnly: true OriginalDesc: type: - string - 'null' readOnly: true ClassCode: type: - string - 'null' description: ClassCode ClassDescriptionCode: type: - string - 'null' description: ClassDescriptionCode LocState: type: - string - 'null' description: LocState Payroll: type: - string - 'null' description: Payroll 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 - 'null' description: Description Premium: type: integer description: Premium format: int32 Exposure: type: integer description: Exposure format: int32 IsSplitRate: type: boolean readOnly: true additionalProperties: false description: '' Limit: type: object properties: LiabilityLimits: $ref: '#/components/schemas/PolicyLiabilityLimitDetails' additionalProperties: false PolicyClassCode: type: object properties: ClassCode: type: - string - 'null' DescriptionCode: type: - string - 'null' State: type: - string - 'null' 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 ClassApiReturnModelV2: type: object properties: ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassApiReturnModel' RatingZip: type: - string - 'null' description: RatingZip additionalProperties: false GetUnderwritingMessageListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: - array - 'null' items: $ref: '#/components/schemas/GetUnderwritingMessage' description: Data additionalProperties: false description: '' CancelInformation: type: object properties: CancelDate: type: - string - 'null' format: date-time CancelReason: type: - string - 'null' ShortRate: type: boolean additionalProperties: false BooleanBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' Message: type: - string - 'null' description: Message AdditionalMessages: type: - array - 'null' items: type: string description: AdditionalMessages Errors: type: - object - 'null' additionalProperties: type: - array - 'null' items: type: string description: Errors Data: type: boolean description: Data additionalProperties: false description: '' AddressPutApiModel: type: object properties: Line1: type: - string - 'null' description: Line1 Line2: type: - string - 'null' description: Line2 City: type: - string - 'null' description: City State: type: - string - 'null' description: State Zip: type: - string - 'null' description: Zip additionalProperties: false description: '' securitySchemes: apiKeyHeader: type: apiKey name: subscriber_id in: header apiKeyQuery: type: apiKey name: subscription-key in: query