openapi: 3.2.0 info: title: Digital WC Workers Comp-Specialty Programs 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-Specialty Programs paths: /api/v1/specialty-program/quote: post: tags: - Workers Comp-Specialty Programs summary: Creates a specialty program quote. description: 'Create a quote. __•__ If you have not specifically been told to use this endpoint, please do not map. This is for Specialty Programs' operationId: post-api-v1-specialty-program-quote requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModel' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string Modifiers: - State: string Modifiers: {} LoadRateSummary: true PricingTiers: - TierId: 0 State: string application/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModel' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string Modifiers: - State: string Modifiers: {} LoadRateSummary: true PricingTiers: - TierId: 0 State: string text/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModel' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string Modifiers: - State: string Modifiers: {} LoadRateSummary: true PricingTiers: - TierId: 0 State: string application/*+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModel' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string Modifiers: - State: string Modifiers: {} LoadRateSummary: true PricingTiers: - TierId: 0 State: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 36595a13af6d timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: cc643deacabd timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/QuoteSpecialtyReturnModelBaseResponse' example: Data: EffectiveDate: '2026-08-13T11:08:11.0000000+00:00' ExpirationDate: null Fein: 070818854 FirmId: '0' PrimaryAddress: Line1: 4th Line2: '' City: Florida State: FL Zip: '94022' MailingAddress: Line1: 4th Line2: '' City: Florida State: FL Zip: '94022' BusinessName: Stark Industries DBA: '' ContactInformation: FirstName: Pepper LastName: Potts-Stark Email: IronLove3000@mail.com Phone: '1112224444' AgentContactId: 406102 AgentContactName: Test Tester AH NatureOfBusiness: Defense LegalEntity: 3 YearsInBusiness: 5 ExpiredPremium: 0 IsNonProfit: false CompanyWebsiteAddress: '' RatingZip: '' PayrollCompanyId: 0 UnemploymentId: '' AccountInformation: QuoteId: 1 MasterAccountId: 1 GoverningState: FL Status: Refer Eligible AccountUrl: https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/1 Carrier: Technology Insurance Company, Inc. PremiumDetails: PriceIndication: 1122 StateTaxes: 0 LimitPerAccident: 100000 BodilyInjuryFromDiseasePolicyLimit: 500000 BodilyInjuryFromDiseasePerEmployeeLimit: 100000 LiabilityLimits: 100/500/100 ClassCodes: - IndexId: 8530395 ClassCode: '9082' ClassDescriptionCode: '00' State: FL Payroll: '65000' FullTimeEmployees: 2 PartTimeEmployees: 0 HttpStatusCode: 200 StatusCode: '200' Service: null Message: ok AdditionalMessages: [] Eligibility: Eligibility: Refer Details: - Type: ClassCodes Eligibility: BindEligible - Type: Questions Eligibility: Refer - Type: Territory Eligibility: BindEligible - Type: Modifiers Eligibility: BindEligible Questions: - Id: 1 Question: Does business have more than 50 people working at one location at a time? QuestionType: bool DropdownOptions: [] ParentQuestionId: 0 ParentAnswerToShow: null Answer: null AdditionalCoverages: null RatingSummary: - GovState: null ModelType: Discount ItemType: ExpConstant1 ClassCode: 0900 Description: Expense Constant Premium: 100 Year: 1 Rate: 0 Exposure: 0 PricingTiers: [] StatusCode: 201 Exception: null Message: null AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: c2039a2b0b67 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quote/{quoteId}: patch: tags: - Workers Comp-Specialty Programs summary: Updates the majority of fields on a specialty program quote description: You can update majority of fields on a quote operationId: patch-api-v1-specialty-program-quote-quoteid parameters: - name: quoteId in: path required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace application/json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace text/json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace application/*+json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 07b03a2c9b60 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 020dd1fe51d0 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PatchQuoteSpecialtyReturnModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: EffectiveDate: string ExpirationDate: string Fein: string FirmId: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string RatingZip: string PayrollCompanyId: 0 UnemploymentId: string AccountInformation: QuoteId: 0 MasterAccountId: 0 GoverningState: string Status: string AccountUrl: string Carrier: string PremiumDetails: PriceIndication: 0 StateTaxes: 0 LimitPerAccident: 0 BodilyInjuryFromDiseasePolicyLimit: 0 BodilyInjuryFromDiseasePerEmployeeLimit: 0 LiabilityLimits: string ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 Eligibility: Eligibility: string Details: - Type: string Eligibility: string Modifiers: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 70408743bfee timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/firms/{state}: get: tags: - Workers Comp-Specialty Programs summary: Shows all available firms in a specific state description: This endpoint will show all available firms in a specific state operationId: get-api-v1-specialty-program-firms-state parameters: - name: state in: path required: true schema: type: string - name: effectiveDate in: query description: Query will use the current date if unsent. schema: type: string format: date-time responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 54e0b64e4957 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: fc616c24825e timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetFirmResponseDtoIEnumerableBaseResponse' example: Data: - FirmId: 1 FirmName: AmTrust Test Firm 1 FirmNameShort: ATF1 AuthorizedState: AL - FirmId: 2 FirmName: AmTrust Test Firm 2 FirmNameShort: ATF2 AuthorizedState: AL - FirmId: 3 FirmName: AmTrust Test Firm 3 FirmNameShort: ATF3 AuthorizedState: AL StatusCode: 200 Exception: null Message: OK AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorBaseResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}/firms: get: tags: - Workers Comp-Specialty Programs summary: Shows all available firms for the specified quote description: This endpoint will show all available firms for this quote operationId: get-api-v1-specialty-program-quotes-quoteid-firms parameters: - name: quoteId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 447d929c2d60 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 1605d8130fd6 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetFirmResponseDtoIEnumerableBaseResponse' example: Data: - FirmId: 1 FirmName: AmTrust Test Firm 1 FirmNameShort: ATF1 AuthorizedState: AL - FirmId: 2 FirmName: AmTrust Test Firm 2 FirmNameShort: ATF2 AuthorizedState: AL - FirmId: 3 FirmName: AmTrust Test Firm 3 FirmNameShort: ATF3 AuthorizedState: AL StatusCode: 200 Exception: null Message: OK AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all currently saved information on a specified specialty program quote description: Retrieves all currently saved information on a specified quote, including (but not limited to) class codes, mailing/primary addresses, current eligibility, price indication, etc… operationId: get-api-v1-specialty-program-quotes-quoteid parameters: - name: quoteId in: path required: true schema: type: integer format: int32 - name: loadQuestions in: query description: Set to "true" to return all questions associated with the created quote schema: type: boolean default: false - name: loadRateSummary in: query schema: type: boolean default: false responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c932b646511d timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 156d934f8203 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetQuoteSpecialtyReturnModelBaseResponse' example: Data: ForeignVoluntaryCoverage: null SpecificWaivers: null AdditionalInformation: null Dividends: null QuoteStatus: null EffectiveDate: null ExpirationDate: null Fein: null FirmId: null PrimaryAddress: null MailingAddress: null BusinessName: null DBA: null ContactInformation: null NatureOfBusiness: null LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: null IsNonProfit: null CompanyWebsiteAddress: null RatingZip: null PayrollCompanyId: null UnemploymentId: null AccountInformation: null PremiumDetails: null ClassCodes: null Eligibility: Eligibility: null Details: [] Questions: null AdditionalCoverages: null RatingSummary: [] PricingTiers: [] StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' put: tags: - Workers Comp-Specialty Programs summary: Updates a specialty program quote. description: 'Use this to update the quote Please be aware if a field that is on the quote is not included in the request body it will remain as is. We will NOT delete the information previously included.' operationId: put-api-v1-specialty-program-quotes-quoteid parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: includeEligibility in: query schema: type: boolean default: false - name: loadRateSummary in: query schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPutModel' example: EffectiveDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbantAgent: true CompanyWebsiteAddress: string RatingZip: string LiabilityLimits: string UnemploymentId: string DigitalClientWorkflow: string ExpirationDate: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string MasterAccountId: 0 BillType: 0 = A PayrollCompanyId: 0 StateModifiers: - State: string Modifiers: {} PricingTiers: - TierId: 0 State: string application/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPutModel' example: EffectiveDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbantAgent: true CompanyWebsiteAddress: string RatingZip: string LiabilityLimits: string UnemploymentId: string DigitalClientWorkflow: string ExpirationDate: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string MasterAccountId: 0 BillType: 0 = A PayrollCompanyId: 0 StateModifiers: - State: string Modifiers: {} PricingTiers: - TierId: 0 State: string text/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPutModel' example: EffectiveDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbantAgent: true CompanyWebsiteAddress: string RatingZip: string LiabilityLimits: string UnemploymentId: string DigitalClientWorkflow: string ExpirationDate: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string MasterAccountId: 0 BillType: 0 = A PayrollCompanyId: 0 StateModifiers: - State: string Modifiers: {} PricingTiers: - TierId: 0 State: string application/*+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPutModel' example: EffectiveDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbantAgent: true CompanyWebsiteAddress: string RatingZip: string LiabilityLimits: string UnemploymentId: string DigitalClientWorkflow: string ExpirationDate: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string MasterAccountId: 0 BillType: 0 = A PayrollCompanyId: 0 StateModifiers: - State: string Modifiers: {} PricingTiers: - TierId: 0 State: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 2dd908a0110c timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f368ae898010 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SpecialtyQuoteApiReturnModel' example: HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string EffectiveDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 LiabilityLimits: string YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbantAgent: true CompanyWebsiteAddress: string EstimatedAnnualPremium: 0 GoverningState: string MasterAccountId: 0 RatingZip: string UnemploymentId: string Eligibility: Eligibility: string Details: - Type: string Eligibility: string QuoteStatus: string DigitalClientWorkflow: string RatingSummary: - GovState: string ModelType: string ItemType: string ClassCode: string Description: string Premium: 0 Year: 0 Rate: 0 Exposure: 0 ExpirationDate: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string PayrollCompanyId: 0 StateModifiers: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string PricingTiers: - TierId: 0 State: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 08803cb50d30 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: c0e6ddf93461 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD patch: tags: - Workers Comp-Specialty Programs summary: Partially updates the majority of fields on a specialty program quote description: You can update majority of fields on a quote operationId: patch-api-v1-specialty-program-quotes-quoteid parameters: - name: quoteId in: path required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace application/json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace text/json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace application/*+json: schema: type: array items: $ref: '#/components/schemas/Operation' example: - value: Stark path: /BusinessName op: replace - value: '15' path: /YearsInBusiness op: replace - value: '12' path: /LegalEntity op: replace responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b6d8b340a6c5 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8e29d793b95a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PatchQuoteSpecialtyReturnModelV2BaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string RatingZip: string PayrollCompanyId: 0 UnemploymentId: string AccountInformation: QuoteId: 0 MasterAccountId: 0 GoverningState: string Status: string AccountUrl: string Carrier: string PremiumDetails: PriceIndication: 0 StateTaxes: 0 LimitPerAccident: 0 BodilyInjuryFromDiseasePolicyLimit: 0 BodilyInjuryFromDiseasePerEmployeeLimit: 0 LiabilityLimits: string ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 Eligibility: Eligibility: string Details: - Type: string Eligibility: string Questions: - Id: 0 Question: string QuestionType: string DropdownOptions: - Key: string Text: string ParentQuestionId: 0 ParentAnswerToShow: string Answer: string FirmId: string ExperienceModifier: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string DigitalClientWorkflow: string SpousesNames: Spouse1: string Spouse2: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string Modifiers: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string RatingSummary: - GovState: string ModelType: string ItemType: string ClassCode: string Description: string Premium: 0 Year: 0 Rate: 0 Exposure: 0 PricingTiers: - TierId: 0 State: string AdditionalInformation: Officers: - Id: 0 Name: string EndorsementId: string Type: string State: string OwnershipPercent: 0 FormType: string DateOfBirth: string OfficeHeld: string AnnualCompensation: 0 AdditionalInsureds: - Id: 0 Name: string TaxId: string State: string LegalEntity: 0 DbaName: string UnemploymentId: string AdditionalLocations: - Id: 0 Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Id: 0 Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - IndexId: 0 FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string QuoteStatus: string ClosedDate: string ForeignVoluntaryCoverage: - IndexId: 0 GovState: string Employee: string Location: string WcLaw: string SpecificWaivers: - StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 EndDate: string '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 4e744a721e8f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/classcodes/information/{states}: get: tags: - Workers Comp-Specialty Programs summary: Provides a list of class codes in each state along with the firms and net rate… description: This endpoint will provide you with a list of class codes in each state along with the firms and net rate for the class codes operationId: get-api-v1-specialty-program-classcodes-information-states parameters: - name: states in: path required: true schema: type: string - name: classcode in: query schema: type: string - name: effectiveDate in: query schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 50521080ae09 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: b2351522d81e timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetClassCodeWithFirmResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: ClassCodes: - State: string ClassCode: string Information: - DescriptionCode: string NaicsDescription: string NaicsCode: string SicCode: string AvailableFirms: - FirmId: 0 BaseRate: 0 Firms: - FirmId: 0 FirmName: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}/available-liability-limits: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the available liability limit options for the specialty program quote… description: Retrieves the available liability limit options for the quote specified by the quote ID operationId: get-api-v1-specialty-program-quotes-quoteid-available-liability-limits parameters: - name: quoteId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 5fc401203d4f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 0e743a7d23eb timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StringListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}/submitToUnderwriter: post: tags: - Workers Comp-Specialty Programs summary: Submit to underwriter description: 'This endpoint can be used to submit quotes to the underwriter. This endpoint allows Managing General Agents (MGAs) to reserve accounts/block the market for quotes they want to proceed with. Note that this endpoint is for #WC - Specialty Programs only.' operationId: post-api-v1-specialty-program-quotes-quoteid-submittounderwriter parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/SpecialtySubmitToUnderwriterModel' example: NoteToUnderwriter: string AgentNeedByDate: string application/json: schema: $ref: '#/components/schemas/SpecialtySubmitToUnderwriterModel' example: NoteToUnderwriter: string AgentNeedByDate: string text/json: schema: $ref: '#/components/schemas/SpecialtySubmitToUnderwriterModel' example: NoteToUnderwriter: string AgentNeedByDate: string application/*+json: schema: $ref: '#/components/schemas/SpecialtySubmitToUnderwriterModel' example: NoteToUnderwriter: string AgentNeedByDate: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 7bbd06c084f2 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: a19a1766ec14 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SubmitToUnderwriterResponseModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: MasterAccountId: 0 SubmittedDate: string BusinessName: string QuoteInformation: QuoteId: 0 Product: string EffectiveDate: string Premium: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 1ac5f1123820 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 8f1a2589c67d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes/{quoteId}/PaymentPlans: get: tags: - Workers Comp-Specialty Programs 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-specialty-program-quotes-quoteid-paymentplans parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 99416eaf03bb timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 99243765496c timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: c4d3ddf262a6 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentPlanResponseV2BaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: Direct: - IsCurrentPaymentPlan: true PaymentPlan: 0 = None PaymentPlanDescription: string PaymentPlanId: 0 PayrollCompanyId: 0 NumberPayments: 0 TotalCost: 0 TotalPremium: 0 TotalStateTaxes: 0 TotalBillingFees: 0 DepositPercent: 0 DownPayment: 0 IsDirectDebit: true Message: string Invoices: - PremiumAmount: 0 Taxes: 0 Fees: 0 TotalBillAmount: 0 BillDate: string DueDate: string IsDownPayment: true Agency: - IsCurrentPaymentPlan: true PaymentPlan: 0 = None PaymentPlanDescription: string PaymentPlanId: 0 PayrollCompanyId: 0 NumberPayments: 0 TotalCost: 0 TotalPremium: 0 TotalStateTaxes: 0 TotalBillingFees: 0 DepositPercent: 0 DownPayment: 0 IsDirectDebit: true Message: string Invoices: - PremiumAmount: 0 Taxes: 0 Fees: 0 TotalBillAmount: 0 BillDate: string DueDate: string IsDownPayment: true /api/v1/specialty-program/affirmation: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the affirmation statement that will need to be displayed to agents… 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-specialty-program-affirmation responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 821a5b8c6042 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 90e083d6cbb3 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StringBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: string /api/v1/specialty-program/contacts/agents: get: tags: - Workers Comp-Specialty Programs summary: Retrieves agent information associated with an email address passed in the… 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-specialty-program-contacts-agents parameters: - name: emailAddress in: query schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: f16b4a7a1774 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 50c05d7d3d78 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AgentInfoReturnModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - AgentId: 0 AgentName: string /api/v2/specialty-program/fein/validation: post: tags: - Workers Comp-Specialty Programs summary: Optional but recommended endpoint to determine a FEIN's availability for use on… description: This endpoint is optional, but recommended, and can be used to determine a FEIN's availability for use on a quote. operationId: post-api-v2-specialty-program-fein-validation requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/FeinPostModel' example: Fein: string QuoteId: 0 application/json: schema: $ref: '#/components/schemas/FeinPostModel' example: Fein: string QuoteId: 0 text/json: schema: $ref: '#/components/schemas/FeinPostModel' example: Fein: string QuoteId: 0 application/*+json: schema: $ref: '#/components/schemas/FeinPostModel' example: Fein: string QuoteId: 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 027527a08a94 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: afb691f9326b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BooleanBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: true '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: fd33a3bd895e timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 6e88df1fe0fb timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/payment-plans/payroll-companies: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all payroll companies currently available to the agency associated… description: Retrieves all payroll companies currently available to the agency associated with the current authentication token. operationId: get-api-v1-specialty-program-payment-plans-payroll-companies responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 17e9330109a3 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: ea2fd790549b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AgentPayrollCompaniesResponseIListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - PayrollCompanyId: 0 PayrollCompanyName: string /api/v1/specialty-program/policies/{policy}: get: tags: - Workers Comp-Specialty Programs summary: Returns basic policy information on the requested policy number description: Returns basic policy information on requested policy number. operationId: get-api-v1-specialty-program-policies-policy parameters: - name: policy in: path required: true schema: type: string - name: loadRateSummary in: query schema: type: boolean default: false responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 83df077fca0f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 1eedfffd245f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyInformationResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: MasterAccountId: 0 Policy: string PolicyId: 0 Quote: string Premium: string DBA: string BusinessName: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string Fein: string EffectiveDate: string ExpirationDate: string InsuredContact: Name: string Phone: string Email: string LegalEntity: string PolicyStatus: string StateTaxes: 0 EstimatedAnnual: 0 EarnedPremium: string RatingZip: string CancelInformation: CancelDate: string CancelReason: string ShortRate: true CompanyWebsite: string CarrierName: string ClassCodes: - ClassCode: string DescriptionCode: string State: string Payroll: 0 FTEmployees: 0 PTEmployees: 0 Rate: 0 Premium: 0 Officers: - Name: string EndorsementId: string Type: string State: string OwnershipPercent: 0 FormType: string OfficerDOB: string OfficeHeld: string AnnualCompensation: 0 StopGapCoverages: - CoverageName: string State: string Limit: string Period: string AnnualPayroll: string Partners: - FirstName: string LastName: string Organization: string Limits: - LiabilityLimits: LimitPerAccident: 0 BodilyInjuryFromDiseasePolicyLimit: 0 BodilyInjuryFromDiseasePerEmployeeLimit: 0 LiabilityLimits: string AdditionalInsureds: - Id: 0 NamedInsuredId: 0 Name: string Dba: string Fein: string LegalEntity: 0 UnemploymentNumber: string Line1: string Line2: string City: string State: string Zip: string EmployeeCount: 0 PrimaryInsuredAdditionalLocations: - LocationNumber: 0 Line1: string Line2: string City: string State: string Zip: string EmployeeCount: 0 AdditionalLocations: - LocationNumber: 0 Line1: string Line2: string City: string State: string Zip: string EmployeeCount: 0 NameInsured: string RatingSummary: - GovState: string ModelType: string ItemType: string ClassCode: string Description: string Premium: 0 Year: 0 Rate: 0 Exposure: 0 SpecificWaivers: - StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 EndDate: string NonRenewalDate: string NonRenewalReason: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 507423c1c03b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policy}/available-documents: get: tags: - Workers Comp-Specialty Programs summary: Retrieves a list of all available policy documents currently available for… description: Retrieves a list of all available policy documents that are currently available for viewing under the given policy number. operationId: get-api-v1-specialty-program-policies-policy-available-documents parameters: - name: policy in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 2ced14a88e07 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 0a8dcd6d3b38 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyDocumentIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - DocumentName: string FileType: string DocumentType: string LibraryIndex: 0 DateReceived: string EndmtNum: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 557b97c63953 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policy}/documents: get: tags: - Workers Comp-Specialty Programs summary: Retrieves a specified policy document type in raw data (application-octet… 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-specialty-program-policies-policy-documents parameters: - name: policy in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/octet-stream: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 3f0fddcdc104 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 3f0fddcdc104 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/octet-stream: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 675f9ddc085a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 675f9ddc085a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/octet-stream: schema: type: string format: binary examples: default: value: null application/json: schema: type: string format: binary example: string '404': description: Not found content: application/octet-stream: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 5b2a614d16f6 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 5b2a614d16f6 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policy}/documents/{fileType}: get: tags: - Workers Comp-Specialty Programs summary: Retrieves a specified policy document type by file type in raw data… 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-specialty-program-policies-policy-documents-filetype parameters: - name: policy in: path required: true schema: type: string - name: fileType in: path required: true schema: type: string - name: libraryIndex in: query schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 89a2e868e733 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 16f7b9ddcb44 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ByteArrayBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: d1766dada0f6 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/policies/{policy}/endorsement-eligibility: get: tags: - Workers Comp-Specialty Programs summary: Retrieves a list of all endorsements the given policy is eligible for description: Retrieves a list of all endorsements the given policy is eligible for. operationId: get-api-v2-specialty-program-policies-policy-endorsement-eligibility parameters: - name: policy in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: ced5ff4101ab timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8543532b94c5 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EndorsementEligibilityResponseVer2BaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: EndorsementType: - string IneligibilityReason: - string CurrentPartners: - FirstName: string LastName: string Id: 0 SubChangeReasons: - EndmtSubType: string EndmtChangeReason: string EndmtChangeReasonId: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 984fcf75ab01 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v3/specialty-program/policies/{policy}/endorsements: post: tags: - Workers Comp-Specialty Programs summary: Saves the selected policy endorsement. description: 'The full list of potential endorsements based on the policy are • ''insured-name-update'' • ''insured-mailing-address-update'' • ''insured-fein-change'' • ''partners-update'' • ''cancellation'' • ''insured-primary-address-update'' • ''additional-insureds-update'' • ''exposure-update'' • ''officers-update'' • ''legal-entity-update'' • ''agent-other-request'' • ''blanket-waiver-change'' • ''specific-waivers-change'' • ''liability-limits-update'' Cancellation endorsement fields Required fields PrimaryReason SecondaryReason DisplayName WindowsFileType FileData Optional Fields NewCancellationDate - Is required if flatCancel is false Carrier Details NewInsuredEmailAddress EmailAddress NewMailingAddress flatCancel shortRate Line1 Line2 City State Zip StillIncumbentAgent SetAsPrimaryAddress NewBillingAddress Note: Cancellations can only be committed within its own endorsement request, separate from other endorsements. 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 PrimaryInsuredAdditionalLocations 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. AdditionalInsureds Required fields FirstName LastName State TaxId LegalEntity Locations Optional Fields Id DbaName UnemploymentId AdditionalInsureds Locations Required fields AddressLine1 City State ZipCode EmployeeCount Optional Fields Id AddressLine2 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 Specific Liability Limits update endorsement fields Required fields LiabilityLimits ChangeReason' operationId: post-api-v3-specialty-program-policies-policy-endorsements parameters: - name: policy in: path required: true schema: type: string requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PostPolicyEndorsementModelV3' examples: Insured Name Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Name: Name DBA: dba Type: insured-name-update Reason: Change in Entity Insured Mailing Address Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 7501 Saint Cecelia St Line2: null City: Austin State: TX Zip: '78757' Type: insured-mailing-address-update Reason: Change in Entity Insured Fein Change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Fein: '987654321' Type: insured-fein-change Reason: Correction Partners Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PartnerId: 1 FirstName: Jane LastName: Woods Organization: Stark Industries Type: partners-update Reason: Correction Cancellation: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryReason: Insured Request SecondaryReason: Price Carrier: Westfield Group Details: 1-5% NewInsuredEmailAddress: true FlatCancel: true ShortRate: false SetAsPrimaryAddress: false NewBillingAddress: false EmailAddress: aa@mail.com NewMailingAddress: true Line1: 1234 Main St Line2: null City: Los Angeles State: CA Zip: '90210' StillIncumbentAgent: true NewCancellationDate: '2025-11-29' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Type: cancellation Reason: null Insured Primary Address Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 1700 E Bayshore Rd Line2: '17' City: East Palo Alto State: CA ZipCode: '94303' EmployeeCount: 18 UpdateMailingAddress: 'false' UpdateBillingAddress: 'true' Type: insured-primary-address-update Reason: null Additional Insureds Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryInsuredAdditionalLocations: - Id: 1 AddressLine1: 1700 E Bayshore Rd AddressLine2: '17' City: East Palo Alto State: CA ZipCode: '94303' NoSpecificLocation: false EmployeeCount: 18 AdditionalInsureds: - Id: 1 FirstName: John LastName: Doe DbaName: Doe Enterprises TaxId: '123456789' State: CA LegalEntity: 1 UnemploymentId: UI12345 Locations: - Id: 2 AddressLine1: 500 Main St AddressLine2: Suite 100 City: Los Angeles State: CA ZipCode: '90001' NoSpecificLocation: false EmployeeCount: 5 Type: additional-insureds-update Reason: Change in Ownership Exposure Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Exposures: - State: TX DescriptionCode: '00' FullTimeEmployees: '2' PartTimeEmployees: '1' Payroll: '650000' ClassCode: '0005' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null Type: exposure-update Reason: Added Staff officers-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: null OfficerName: John Smith Type: SoleProprietor State: AL FormType: E EndorsementId: WC000308 OwnershipPercentage: '12' Type: officers-update Reason: null legal-entity-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null LegalEntityCode: '4' Type: legal-entity-update Reason: Change in Ownership agent-other-request: value: AgentContactId: 456 EffectiveDate: '2026-08-13T11:08:12.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: notes Type: agent-other-request Reason: null blanket-waiver-change: value: AgentContactId: 456 EffectiveDate: '2026-08-13T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - RemoveWaiver: false Type: blanket-waiver-change Reason: null specific-waivers-change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: '1' StartDate: '2026-08-13' EndDate: '2026-09-02' State: AK FirstName: John LastName: Doe Line1: 123 Main St Line2: Suite 100 City: Anchorage Zip: '99501' JobDescription: Carpentry Payroll: 50000 ClassCode: '0005' Delete: 'false' Type: specific-waivers-change Reason: null liability-limits-update: value: AgentContactId: 456 EffectiveDate: '2026-09-12T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - LiabilityLimits: 100/500/100 ChangeReason: 23 Type: liability-limits-update Reason: Data Correction application/json: schema: $ref: '#/components/schemas/PostPolicyEndorsementModelV3' examples: Insured Name Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Name: Name DBA: dba Type: insured-name-update Reason: Change in Entity Insured Mailing Address Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 7501 Saint Cecelia St Line2: null City: Austin State: TX Zip: '78757' Type: insured-mailing-address-update Reason: Change in Entity Insured Fein Change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Fein: '987654321' Type: insured-fein-change Reason: Correction Partners Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PartnerId: 1 FirstName: Jane LastName: Woods Organization: Stark Industries Type: partners-update Reason: Correction Cancellation: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryReason: Insured Request SecondaryReason: Price Carrier: Westfield Group Details: 1-5% NewInsuredEmailAddress: true FlatCancel: true ShortRate: false SetAsPrimaryAddress: false NewBillingAddress: false EmailAddress: aa@mail.com NewMailingAddress: true Line1: 1234 Main St Line2: null City: Los Angeles State: CA Zip: '90210' StillIncumbentAgent: true NewCancellationDate: '2025-11-29' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Type: cancellation Reason: null Insured Primary Address Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 1700 E Bayshore Rd Line2: '17' City: East Palo Alto State: CA ZipCode: '94303' EmployeeCount: 18 UpdateMailingAddress: 'false' UpdateBillingAddress: 'true' Type: insured-primary-address-update Reason: null Additional Insureds Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryInsuredAdditionalLocations: - Id: 1 AddressLine1: 1700 E Bayshore Rd AddressLine2: '17' City: East Palo Alto State: CA ZipCode: '94303' NoSpecificLocation: false EmployeeCount: 18 AdditionalInsureds: - Id: 1 FirstName: John LastName: Doe DbaName: Doe Enterprises TaxId: '123456789' State: CA LegalEntity: 1 UnemploymentId: UI12345 Locations: - Id: 2 AddressLine1: 500 Main St AddressLine2: Suite 100 City: Los Angeles State: CA ZipCode: '90001' NoSpecificLocation: false EmployeeCount: 5 Type: additional-insureds-update Reason: Change in Ownership Exposure Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Exposures: - State: TX DescriptionCode: '00' FullTimeEmployees: '2' PartTimeEmployees: '1' Payroll: '650000' ClassCode: '0005' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null Type: exposure-update Reason: Added Staff officers-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: null OfficerName: John Smith Type: SoleProprietor State: AL FormType: E EndorsementId: WC000308 OwnershipPercentage: '12' Type: officers-update Reason: null legal-entity-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null LegalEntityCode: '4' Type: legal-entity-update Reason: Change in Ownership agent-other-request: value: AgentContactId: 456 EffectiveDate: '2026-08-13T11:08:12.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: notes Type: agent-other-request Reason: null blanket-waiver-change: value: AgentContactId: 456 EffectiveDate: '2026-08-13T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - RemoveWaiver: false Type: blanket-waiver-change Reason: null specific-waivers-change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: '1' StartDate: '2026-08-13' EndDate: '2026-09-02' State: AK FirstName: John LastName: Doe Line1: 123 Main St Line2: Suite 100 City: Anchorage Zip: '99501' JobDescription: Carpentry Payroll: 50000 ClassCode: '0005' Delete: 'false' Type: specific-waivers-change Reason: null liability-limits-update: value: AgentContactId: 456 EffectiveDate: '2026-09-12T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - LiabilityLimits: 100/500/100 ChangeReason: 23 Type: liability-limits-update Reason: Data Correction text/json: schema: $ref: '#/components/schemas/PostPolicyEndorsementModelV3' examples: Insured Name Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Name: Name DBA: dba Type: insured-name-update Reason: Change in Entity Insured Mailing Address Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 7501 Saint Cecelia St Line2: null City: Austin State: TX Zip: '78757' Type: insured-mailing-address-update Reason: Change in Entity Insured Fein Change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Fein: '987654321' Type: insured-fein-change Reason: Correction Partners Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PartnerId: 1 FirstName: Jane LastName: Woods Organization: Stark Industries Type: partners-update Reason: Correction Cancellation: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryReason: Insured Request SecondaryReason: Price Carrier: Westfield Group Details: 1-5% NewInsuredEmailAddress: true FlatCancel: true ShortRate: false SetAsPrimaryAddress: false NewBillingAddress: false EmailAddress: aa@mail.com NewMailingAddress: true Line1: 1234 Main St Line2: null City: Los Angeles State: CA Zip: '90210' StillIncumbentAgent: true NewCancellationDate: '2025-11-29' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Type: cancellation Reason: null Insured Primary Address Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 1700 E Bayshore Rd Line2: '17' City: East Palo Alto State: CA ZipCode: '94303' EmployeeCount: 18 UpdateMailingAddress: 'false' UpdateBillingAddress: 'true' Type: insured-primary-address-update Reason: null Additional Insureds Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryInsuredAdditionalLocations: - Id: 1 AddressLine1: 1700 E Bayshore Rd AddressLine2: '17' City: East Palo Alto State: CA ZipCode: '94303' NoSpecificLocation: false EmployeeCount: 18 AdditionalInsureds: - Id: 1 FirstName: John LastName: Doe DbaName: Doe Enterprises TaxId: '123456789' State: CA LegalEntity: 1 UnemploymentId: UI12345 Locations: - Id: 2 AddressLine1: 500 Main St AddressLine2: Suite 100 City: Los Angeles State: CA ZipCode: '90001' NoSpecificLocation: false EmployeeCount: 5 Type: additional-insureds-update Reason: Change in Ownership Exposure Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Exposures: - State: TX DescriptionCode: '00' FullTimeEmployees: '2' PartTimeEmployees: '1' Payroll: '650000' ClassCode: '0005' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null Type: exposure-update Reason: Added Staff officers-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: null OfficerName: John Smith Type: SoleProprietor State: AL FormType: E EndorsementId: WC000308 OwnershipPercentage: '12' Type: officers-update Reason: null legal-entity-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null LegalEntityCode: '4' Type: legal-entity-update Reason: Change in Ownership agent-other-request: value: AgentContactId: 456 EffectiveDate: '2026-08-13T11:08:12.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: notes Type: agent-other-request Reason: null blanket-waiver-change: value: AgentContactId: 456 EffectiveDate: '2026-08-13T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - RemoveWaiver: false Type: blanket-waiver-change Reason: null specific-waivers-change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: '1' StartDate: '2026-08-13' EndDate: '2026-09-02' State: AK FirstName: John LastName: Doe Line1: 123 Main St Line2: Suite 100 City: Anchorage Zip: '99501' JobDescription: Carpentry Payroll: 50000 ClassCode: '0005' Delete: 'false' Type: specific-waivers-change Reason: null liability-limits-update: value: AgentContactId: 456 EffectiveDate: '2026-09-12T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - LiabilityLimits: 100/500/100 ChangeReason: 23 Type: liability-limits-update Reason: Data Correction application/*+json: schema: $ref: '#/components/schemas/PostPolicyEndorsementModelV3' examples: Insured Name Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Name: Name DBA: dba Type: insured-name-update Reason: Change in Entity Insured Mailing Address Update: value: AgentContactId: 123 EffectiveDate: '2025-05-20T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 7501 Saint Cecelia St Line2: null City: Austin State: TX Zip: '78757' Type: insured-mailing-address-update Reason: Change in Entity Insured Fein Change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Fein: '987654321' Type: insured-fein-change Reason: Correction Partners Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PartnerId: 1 FirstName: Jane LastName: Woods Organization: Stark Industries Type: partners-update Reason: Correction Cancellation: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryReason: Insured Request SecondaryReason: Price Carrier: Westfield Group Details: 1-5% NewInsuredEmailAddress: true FlatCancel: true ShortRate: false SetAsPrimaryAddress: false NewBillingAddress: false EmailAddress: aa@mail.com NewMailingAddress: true Line1: 1234 Main St Line2: null City: Los Angeles State: CA Zip: '90210' StillIncumbentAgent: true NewCancellationDate: '2025-11-29' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Type: cancellation Reason: null Insured Primary Address Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Line1: 1700 E Bayshore Rd Line2: '17' City: East Palo Alto State: CA ZipCode: '94303' EmployeeCount: 18 UpdateMailingAddress: 'false' UpdateBillingAddress: 'true' Type: insured-primary-address-update Reason: null Additional Insureds Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - PrimaryInsuredAdditionalLocations: - Id: 1 AddressLine1: 1700 E Bayshore Rd AddressLine2: '17' City: East Palo Alto State: CA ZipCode: '94303' NoSpecificLocation: false EmployeeCount: 18 AdditionalInsureds: - Id: 1 FirstName: John LastName: Doe DbaName: Doe Enterprises TaxId: '123456789' State: CA LegalEntity: 1 UnemploymentId: UI12345 Locations: - Id: 2 AddressLine1: 500 Main St AddressLine2: Suite 100 City: Los Angeles State: CA ZipCode: '90001' NoSpecificLocation: false EmployeeCount: 5 Type: additional-insureds-update Reason: Change in Ownership Exposure Update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Exposures: - State: TX DescriptionCode: '00' FullTimeEmployees: '2' PartTimeEmployees: '1' Payroll: '650000' ClassCode: '0005' DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null Type: exposure-update Reason: Added Staff officers-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: null OfficerName: John Smith Type: SoleProprietor State: AL FormType: E EndorsementId: WC000308 OwnershipPercentage: '12' Type: officers-update Reason: null legal-entity-update: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: null LegalEntityCode: '4' Type: legal-entity-update Reason: Change in Ownership agent-other-request: value: AgentContactId: 456 EffectiveDate: '2026-08-13T11:08:12.0000000+00:00' PolicyEndorsements: - Endorsements: - DisplayName: myDoc WindowsFileType: pdf FileData: RmlsZSBEYXRh Notes: notes Type: agent-other-request Reason: null blanket-waiver-change: value: AgentContactId: 456 EffectiveDate: '2026-08-13T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - RemoveWaiver: false Type: blanket-waiver-change Reason: null specific-waivers-change: value: AgentContactId: 456 EffectiveDate: '2025-06-15T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - Id: '1' StartDate: '2026-08-13' EndDate: '2026-09-02' State: AK FirstName: John LastName: Doe Line1: 123 Main St Line2: Suite 100 City: Anchorage Zip: '99501' JobDescription: Carpentry Payroll: 50000 ClassCode: '0005' Delete: 'false' Type: specific-waivers-change Reason: null liability-limits-update: value: AgentContactId: 456 EffectiveDate: '2026-09-12T12:00:00.0000000+00:00' PolicyEndorsements: - Endorsements: - LiabilityLimits: 100/500/100 ChangeReason: 23 Type: liability-limits-update Reason: Data Correction responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d78802dac5cb timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 4278c305f54a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PolicyEndorsementBulkResponseIEnumerableBaseResponse' example: Data: - Reason: Change in Ownership Type: null Endorsements: null - Reason: Data Correction Type: null Endorsements: null - Reason: Change in Entity Type: null Endorsements: null StatusCode: 0 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 345b0ff5522e timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 89fc2244a8f0 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/policies/{policy}/PaymentPlans/DirectDebit: post: tags: - Workers Comp-Specialty Programs summary: Saves bank account information for direct debit payments on a policy description: Allows user to save their bank account information for direct debit payments operationId: post-api-v2-specialty-program-policies-policy-paymentplans-directdebit parameters: - name: policy in: path required: true schema: type: string requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PostDirectDebitRequest' example: NameOnAccount: Business Bank Account AccountNumber: '123456789012' RoutingNumber: '987654321' Email: business@email.com AccountType: 1 application/json: schema: $ref: '#/components/schemas/PostDirectDebitRequest' example: NameOnAccount: Business Bank Account AccountNumber: '123456789012' RoutingNumber: '987654321' Email: business@email.com AccountType: 1 text/json: schema: $ref: '#/components/schemas/PostDirectDebitRequest' example: NameOnAccount: Business Bank Account AccountNumber: '123456789012' RoutingNumber: '987654321' Email: business@email.com AccountType: 1 application/*+json: schema: $ref: '#/components/schemas/PostDirectDebitRequest' example: NameOnAccount: Business Bank Account AccountNumber: '123456789012' RoutingNumber: '987654321' Email: business@email.com AccountType: 1 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 74df81822006 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: fd9d6739acc0 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: dda4dcc19a41 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/PostDirectDebitResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: NameOnAccount: string AccountNumber: string RoutingNumber: string Email: string AccountType: 1 = Checking BankName: string /api/v2/specialty-program/policies/{policy}/PaymentPlans/DirectDebit/Documents: post: tags: - Workers Comp-Specialty Programs summary: Allows user to upload the EFT form and/or voided check necessary to use direct… description: Allows user to upload the EFT form and/or the voided check necessary to use direct debit as a payment plan operationId: post-api-v2-specialty-program-policies-policy-paymentplans-directdebit-docum parameters: - name: policy in: path required: true schema: type: string requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string application/json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string text/json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string application/*+json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 5aed31411fed timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: a52f95c0d175 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: da91a6da5ef5 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadFileResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: LibraryId: 0 /api/v1/specialty-program/policies/{policy}/renewal: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the renewal policy number and information, if available, based on the… description: Retrieves the renewal policy number and information, if available, based on the expired policy number given. operationId: get-api-v1-specialty-program-policies-policy-renewal parameters: - name: policy in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 7c6bc028b388 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 49b8b89d16db timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyRenewalResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: RenewalPolicyNumber: string TotalEstimatedAnnualPremium: 0 TotalStateAssessment: 0 ClassCodes: - State: string ClassCode: string ClassCodeDescription: string ExposureLimit: string Rate: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 75d3ae3fd41d timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policy}/voluntary-compensation: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all voluntary compensation added at the quote level for a given policy description: Retrieves all voluntary compensation added at the quote level. operationId: get-api-v1-specialty-program-policies-policy-voluntary-compensation parameters: - name: policy in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d37a22ea398b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f314b7352ae1 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - EndorsementNumber: string Description: string FormDataFields: - IndexId: 0 Label: string Required: true CanEnterFreeText: true CurrentValue: string PresetValues: - string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 510ba14980e9 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policyId}/balance-summary: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the current balance on a policy. description: 'Retrieve the current balance on a policy. __If "CanMakePayment" is false, the current balance will reflect $0.00 Policy.__' operationId: get-api-v1-specialty-program-policies-policyid-balance-summary parameters: - name: policyId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 4ca1228e6488 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 1e0954f578e3 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BalanceSummaryResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: QuoteId: 0 PolicyId: 0 CurrentDueAmount: 0 RemainingDueAmount: 0 CanMakePayment: true '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 67c44ab41844 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policyId}/dividends: get: tags: - Workers Comp-Specialty Programs summary: Provides details on dividends included on the policy description: Provides details on dividends included on the policy. operationId: get-api-v1-specialty-program-policies-policyid-dividends parameters: - name: policyId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: a5ffa5e3589a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f972c22c3dcf timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicyDividentDetailsResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: PlanDescription: string ApprovedDate: string DivCalcDone: string DividendAmount: 0 DivWrittenPremium: 0 NetIncurred: 0 States: - string ApprovedBy: string DisqualifyNotes: string DividentPercentage: 0 DivLossRatio: 0 /api/v1/specialty-program/policies/{policyId}/payment: post: tags: - Workers Comp-Specialty Programs summary: Makes a payment on the policy. 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-specialty-program-policies-policyid-payment parameters: - name: policyId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PaymentPostModel' example: QuoteId: 0 SendEmail: true PayerInfo: FirstName: string LastName: string Address: Line1: string City: string State: string Zip: string Line2: string Country: 225 = US CountryName: string EmailAddress: string Phone: string ECheck: AccountNumber: string RoutingNumber: string FinancialInstitution: string AccountType: 1 = Checking CreditCard: CreditCardNumber: string CardType: 0 = Visa CVV: string ExpirationMonth: 0 ExpirationYear: 0 PaymentSystemInfo: Id: 0 Name: string LOB: string Type: string PayrollMonth: string Amount: Currency: string Total: 0 TaxAmount: Currency: string Total: 0 FeeAmount: Currency: string Total: 0 PaymentDescription: string application/json: schema: $ref: '#/components/schemas/PaymentPostModel' example: QuoteId: 0 SendEmail: true PayerInfo: FirstName: string LastName: string Address: Line1: string City: string State: string Zip: string Line2: string Country: 225 = US CountryName: string EmailAddress: string Phone: string ECheck: AccountNumber: string RoutingNumber: string FinancialInstitution: string AccountType: 1 = Checking CreditCard: CreditCardNumber: string CardType: 0 = Visa CVV: string ExpirationMonth: 0 ExpirationYear: 0 PaymentSystemInfo: Id: 0 Name: string LOB: string Type: string PayrollMonth: string Amount: Currency: string Total: 0 TaxAmount: Currency: string Total: 0 FeeAmount: Currency: string Total: 0 PaymentDescription: string text/json: schema: $ref: '#/components/schemas/PaymentPostModel' example: QuoteId: 0 SendEmail: true PayerInfo: FirstName: string LastName: string Address: Line1: string City: string State: string Zip: string Line2: string Country: 225 = US CountryName: string EmailAddress: string Phone: string ECheck: AccountNumber: string RoutingNumber: string FinancialInstitution: string AccountType: 1 = Checking CreditCard: CreditCardNumber: string CardType: 0 = Visa CVV: string ExpirationMonth: 0 ExpirationYear: 0 PaymentSystemInfo: Id: 0 Name: string LOB: string Type: string PayrollMonth: string Amount: Currency: string Total: 0 TaxAmount: Currency: string Total: 0 FeeAmount: Currency: string Total: 0 PaymentDescription: string application/*+json: schema: $ref: '#/components/schemas/PaymentPostModel' example: QuoteId: 0 SendEmail: true PayerInfo: FirstName: string LastName: string Address: Line1: string City: string State: string Zip: string Line2: string Country: 225 = US CountryName: string EmailAddress: string Phone: string ECheck: AccountNumber: string RoutingNumber: string FinancialInstitution: string AccountType: 1 = Checking CreditCard: CreditCardNumber: string CardType: 0 = Visa CVV: string ExpirationMonth: 0 ExpirationYear: 0 PaymentSystemInfo: Id: 0 Name: string LOB: string Type: string PayrollMonth: string Amount: Currency: string Total: 0 TaxAmount: Currency: string Total: 0 FeeAmount: Currency: string Total: 0 PaymentDescription: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 0c2bb2ff2bfd timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 6f00245f6d5a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PaymentResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: AmountProccessed: 0 RemainingPolicyPayment: 0 TransactionId: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 038d7ffe9df7 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: cac7c6ba4432 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policy/{policyId}/netRate: get: tags: - Workers Comp-Specialty Programs summary: Retrieves net rate information on a PAYO or PSR policy description: Retrieves net rate information on a PAYO or PSR policy. operationId: get-api-v1-specialty-program-policy-policyid-netrate parameters: - name: policyId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 6b0b8e4080ad timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: b93a84b41cf2 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetRateResponseListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - State: string ClassCode: string ClassDescription: string NetRate: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 8df3221561c4 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/print/{quoteId}: post: tags: - Workers Comp-Specialty Programs summary: Retrieves a byte representation of the quote proposal in PDF format description: Retrieves a byte representation of the quote proposal in PDF format. operationId: post-api-v1-specialty-program-print-quoteid parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 50b787f4372c timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: c3e5d1010777 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: type: string format: byte example: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 6ce836fea251 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quote/{quoteId}/netRate: get: tags: - Workers Comp-Specialty Programs summary: Retrieves net rate information on a PAYO or PSR quote description: Retrieves net rate information on a PAYO or PSR quote. operationId: get-api-v1-specialty-program-quote-quoteid-netrate parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: e2ff0ce964ba timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 44810e852fa9 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NetRateResponseListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - State: string ClassCode: string ClassDescription: string NetRate: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 454a6a98f587 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes: post: tags: - Workers Comp-Specialty Programs summary: Creates a specialty program quote (V2). description: 'Create a quote. __•__ If you have not specifically been told to use this endpoint, please do not map. This is for Specialty Programs' operationId: post-api-v2-specialty-program-quotes requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModelV2' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string SpousesNames: Spouse1: string Spouse2: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string ExperienceModifier: State: string Modifiers: {} StateModifiers: - State: string Modifiers: {} DigitalClientWorkflow: string LoadRateSummary: true PricingTiers: - TierId: 0 State: string application/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModelV2' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string SpousesNames: Spouse1: string Spouse2: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string ExperienceModifier: State: string Modifiers: {} StateModifiers: - State: string Modifiers: {} DigitalClientWorkflow: string LoadRateSummary: true PricingTiers: - TierId: 0 State: string text/json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModelV2' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string SpousesNames: Spouse1: string Spouse2: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string ExperienceModifier: State: string Modifiers: {} StateModifiers: - State: string Modifiers: {} DigitalClientWorkflow: string LoadRateSummary: true PricingTiers: - TierId: 0 State: string application/*+json: schema: $ref: '#/components/schemas/QuoteSpecialtyPostModelV2' example: Quote: MasterAccountId: 0 BillType: 0 = A EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string ClassCodes: - ClassCode: string ClassDescriptionCode: string State: string Payroll: 0 FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string UnemploymentId: string PayrollCompanyId: 0 LiabilityLimits: string FirmId: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string SpousesNames: Spouse1: string Spouse2: string LoadQuestions: true Questions: - QuestionId: 0 AnswerValue: string ExperienceModifier: State: string Modifiers: {} StateModifiers: - State: string Modifiers: {} DigitalClientWorkflow: string LoadRateSummary: true PricingTiers: - TierId: 0 State: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b6e5e21599dd timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8745efa64855 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/QuoteSpecialtyReturnModelV2BaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: EffectiveDate: string ExpirationDate: string Fein: string PrimaryAddress: Line1: string Line2: string City: string State: string Zip: string MailingAddress: Line1: string Line2: string City: string State: string Zip: string BusinessName: string DBA: string ContactInformation: FirstName: string LastName: string Email: string Phone: string AgentContactId: 0 AgentContactName: string NatureOfBusiness: string LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: 0 IsNonProfit: true IsIncumbentAgent: true CompanyWebsiteAddress: string RatingZip: string PayrollCompanyId: 0 UnemploymentId: string AccountInformation: QuoteId: 0 MasterAccountId: 0 GoverningState: string Status: string AccountUrl: string Carrier: string PremiumDetails: PriceIndication: 0 StateTaxes: 0 LimitPerAccident: 0 BodilyInjuryFromDiseasePolicyLimit: 0 BodilyInjuryFromDiseasePerEmployeeLimit: 0 LiabilityLimits: string ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 Eligibility: Eligibility: string Details: - Type: string Eligibility: string Questions: - Id: 0 Question: string QuestionType: string DropdownOptions: - Key: string Text: string ParentQuestionId: 0 ParentAnswerToShow: string Answer: string FirmId: string ExperienceModifier: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string DigitalClientWorkflow: string SpousesNames: Spouse1: string Spouse2: string AdditionalCoverages: - Coverage: string State: string Limit: string Period: string AnnualPayroll: string Modifiers: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string RatingSummary: - GovState: string ModelType: string ItemType: string ClassCode: string Description: string Premium: 0 Year: 0 Rate: 0 Exposure: 0 PricingTiers: - TierId: 0 State: string '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 49b4916e71b0 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes/{quoteId}: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all currently saved information on a specified specialty program… description: Retrieves all currently saved information on a specified quote, including (but not limited to) class codes, mailing/primary addresses, current eligibility, price indication, etc… operationId: get-api-v2-specialty-program-quotes-quoteid parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: loadQuestions in: query description: Set to "true" to return all questions associated with the created quote schema: type: boolean default: false - name: loadRateSummary in: query schema: type: boolean default: false responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: f5bb08d00d7d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 4dee64a51e56 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetQuoteSpecialtyReturnModelV2BaseResponse' example: Data: Dividends: null AdditionalInformation: null QuoteStatus: null ForeignVoluntaryCoverage: null SpecificWaivers: null EffectiveDate: null Fein: null PrimaryAddress: null MailingAddress: null BusinessName: null DBA: null ContactInformation: null NatureOfBusiness: null LegalEntity: 0 YearsInBusiness: 0 ExpiredPremium: null IsNonProfit: null CompanyWebsiteAddress: null RatingZip: null PayrollCompanyId: null UnemploymentId: null AccountInformation: null PremiumDetails: null ClassCodes: null Eligibility: Eligibility: null Details: [] Questions: null Modifiers: null RatingSummary: [] PricingTiers: [] StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v2/specialty-program/quotes/{quoteId}/additional-information: post: tags: - Workers Comp-Specialty Programs summary: Saves additional locations, additional insureds, and/or officers to the… 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-specialty-program-quotes-quoteid-additional-information parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/AdditionalInfoPostModelV2' example: Officers: - Name: string EndorsementId: string Type: 1 = Officers State: string OfficeHeld: string OwnershipPercent: 0 FormType: 0 = I DateOfBirth: string AnnualCompensation: 0 AdditionalInsureds: - Name: string TaxId: string State: string LegalEntity: 0 UnemploymentId: string DbaName: string AdditionalLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string application/json: schema: $ref: '#/components/schemas/AdditionalInfoPostModelV2' example: Officers: - Name: string EndorsementId: string Type: 1 = Officers State: string OfficeHeld: string OwnershipPercent: 0 FormType: 0 = I DateOfBirth: string AnnualCompensation: 0 AdditionalInsureds: - Name: string TaxId: string State: string LegalEntity: 0 UnemploymentId: string DbaName: string AdditionalLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string text/json: schema: $ref: '#/components/schemas/AdditionalInfoPostModelV2' example: Officers: - Name: string EndorsementId: string Type: 1 = Officers State: string OfficeHeld: string OwnershipPercent: 0 FormType: 0 = I DateOfBirth: string AnnualCompensation: 0 AdditionalInsureds: - Name: string TaxId: string State: string LegalEntity: 0 UnemploymentId: string DbaName: string AdditionalLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string application/*+json: schema: $ref: '#/components/schemas/AdditionalInfoPostModelV2' example: Officers: - Name: string EndorsementId: string Type: 1 = Officers State: string OfficeHeld: string OwnershipPercent: 0 FormType: 0 = I DateOfBirth: string AnnualCompensation: 0 AdditionalInsureds: - Name: string TaxId: string State: string LegalEntity: 0 UnemploymentId: string DbaName: string AdditionalLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 8280a74f1989 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 5d693d633d58 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AdditionalInfoReturnModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: Officers: - Id: 0 Name: string EndorsementId: string Type: string State: string OwnershipPercent: 0 FormType: string DateOfBirth: string OfficeHeld: string AnnualCompensation: 0 AdditionalInsureds: - Id: 0 Name: string TaxId: string State: string LegalEntity: 0 DbaName: string UnemploymentId: string AdditionalLocations: - Id: 0 Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true AdditionalPrimaryInsuredLocations: - Id: 0 Address1: string Address2: string City: string State: string Zip: string TotalEmployeeNumber: 0 NoSpecificLocation: true ThirdPartyNotices: - IndexId: 0 FirstName: string LastName: string Address1: string Address2: string City: string State: string Zip: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' /api/v2/specialty-program/quotes/{quoteId}/additionalInformation/insured-locations: delete: tags: - Workers Comp-Specialty Programs summary: Deletes a specified insured location record, by location ID and address, from… description: Deletes a specified insured location record, by location ID and address, from the quote specified by the URI parameter quoteId. operationId: delete-api-v2-specialty-program-quotes-quoteid-additionalinformation-insured parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/DeleteLocationModel' example: LocationId: 1 AddressLine1: 617 W Haiti Ave application/json: schema: $ref: '#/components/schemas/DeleteLocationModel' example: LocationId: 1 AddressLine1: 617 W Haiti Ave text/json: schema: $ref: '#/components/schemas/DeleteLocationModel' example: LocationId: 1 AddressLine1: 617 W Haiti Ave application/*+json: schema: $ref: '#/components/schemas/DeleteLocationModel' example: LocationId: 1 AddressLine1: 617 W Haiti Ave responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 9f1a9844c192 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 70bb581ece29 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 92cd29d88f61 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/additionalInformation/officers/{id}: delete: tags: - Workers Comp-Specialty Programs summary: Deletes an officer record specified by ID from the quote specified by the URI… description: Deletes an officer record specified by ID from the quote specified by the URI parameter __quoteId.__ operationId: delete-api-v1-specialty-program-quotes-quoteid-additionalinformation-officer parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: id in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: e58981269c88 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 5cffbe15c161 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: fbe0477915e5 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/agent-contact: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the agent contact information for the quote specified by the URI… description: Retrieves the agent contact information for the quote specified by the URI parameter __quoteId__ operationId: get-api-v1-specialty-program-quotes-quoteid-agent-contact parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 96d1a396b857 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 68e08bd96396 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AgentContactBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: Id: string FullName: string Email: string AgentId: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: a55bf53ffdb9 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/available-class-codes: get: tags: - Workers Comp-Specialty Programs summary: Retrieves a list of all class codes that can be added to the quote specified by… description: Retrieves a list of all class codes that can be added to the quote specified by the URI parameter __quoteId.__ operationId: get-api-v1-specialty-program-quotes-quoteid-available-class-codes parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 88e159f4704a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f9422b6e5534 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StateClassCodesResponseListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - State: string ClassCodes: - ClassCode: string ClassDescriptionCode: string ClassDescription: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: c24ec3b3e528 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/available-officer-types: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all officer types that can be added to the quote specified by the URI… description: Retrieves all officer types that can be added to the quote specified by the URI parameter __quoteId__ operationId: get-api-v1-specialty-program-quotes-quoteid-available-officer-types parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: a9074e9ac634 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 9349d292f22b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StringIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: c134d1a94e1b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/classCodes: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all class codes currently saved on the specified quote description: Retrieves all class codes currently saved on the specified quote. operationId: get-api-v1-specialty-program-quotes-quoteid-classcodes parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d6a511263f9b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 85d8087fef93 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseClassCodeModelListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 OriginalClassCode: string OriginalDesc: string ClassCode: string ClassDescriptionCode: string LocState: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 IsDeleted: true ClassRate: 0 Description: string Premium: 0 Exposure: 0 IsSplitRate: true '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 4d5d5da2d7e8 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes/{quoteId}/classCodes: put: tags: - Workers Comp-Specialty Programs summary: Replaces the entire collection of current class codes on a quote with the class… 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-specialty-program-quotes-quoteid-classcodes parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ClassPutModelV2' example: ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string application/json: schema: $ref: '#/components/schemas/ClassPutModelV2' example: ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string text/json: schema: $ref: '#/components/schemas/ClassPutModelV2' example: ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string application/*+json: schema: $ref: '#/components/schemas/ClassPutModelV2' example: ClassCodes: - IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 9842289dc24e timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: eac58c23688b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClassApiReturnModelV2' example: ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 59d936589f6f timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 4ce2b7862b1b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD post: tags: - Workers Comp-Specialty Programs summary: Saves additional class codes to a specified quote. 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-specialty-program-quotes-quoteid-classcodes parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ClassCodePostModel' example: ClassCodes: - ClassCode: string ClassDescriptionCode: string LocState: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string application/json: schema: $ref: '#/components/schemas/ClassCodePostModel' example: ClassCodes: - ClassCode: string ClassDescriptionCode: string LocState: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string text/json: schema: $ref: '#/components/schemas/ClassCodePostModel' example: ClassCodes: - ClassCode: string ClassDescriptionCode: string LocState: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string application/*+json: schema: $ref: '#/components/schemas/ClassCodePostModel' example: ClassCodes: - ClassCode: string ClassDescriptionCode: string LocState: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 102bd85bf792 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8cdff039bdd8 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClassApiReturnModelV2' example: ClassCodes: - HttpStatusCode: 100 = Continue StatusCode: string Service: string Message: string AdditionalMessages: - string IndexId: 0 ClassCode: string ClassDescriptionCode: string State: string Payroll: string FullTimeEmployees: 0 PartTimeEmployees: 0 RatingZip: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: de49540bd261 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: c78fd61c0479 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/documents: post: tags: - Workers Comp-Specialty Programs summary: Allows user to upload any supporting documentation that the Underwriter may… description: Allows user to upload any supporting documentation that the Underwriter may need when reviewing the quote. operationId: post-api-v1-specialty-program-quotes-quoteid-documents parameters: - name: quoteId in: path required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string application/json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string text/json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string application/*+json: schema: $ref: '#/components/schemas/FilePostModel' example: WindowsFileType: string FileData: string DisplayName: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 93ab28f2945a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 2ad32254b133 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadFileResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: LibraryId: 0 '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 4a7dfa35a872 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 4a77aaf7337b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/eligibility: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the current eligibility and status of the quote specified by quoteId. 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-specialty-program-quotes-quoteid-eligibility parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: f42c49ccc23a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 5843eb686698 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetEligibilityResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: Eligibility: string Details: - Type: string Eligibility: string QuoteStatus: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 5a426667f700 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/legalEntities/available: get: tags: - Workers Comp-Specialty Programs summary: Retrieves legal entities available for the quote specified by quote ID description: Retrieves legal entities available for the quote specified by quote ID. operationId: get-api-v1-specialty-program-quotes-quoteid-legalentities-available parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 72ee66743468 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 2360ad86dd6e timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LegalEntityResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - LegalEntityId: 0 EntityDescription: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: dcff8d8ab479 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/modifiers: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all available modifiers on the quote specified by the URI parameter… description: Retrieves all available modifiers on the quote specified by the URI parameter __quoteId.__ operationId: get-api-v1-specialty-program-quotes-quoteid-modifiers parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 88118a245403 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: fdb21babd38a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StateModifiersResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - State: string Modifiers: - Id: string Value: string ModifierUiInformation: Description: string RegexFormatting: string ModifierType: string OnlyAvailableValues: - 0 MinValue: 0 MaxValue: 0 ExcludingModifier: Id: string Description: string Value: string State: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: b802dcd5fbea timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD patch: tags: - Workers Comp-Specialty Programs summary: Updates the quote to include modifiers. 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-specialty-program-quotes-quoteid-modifiers parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ModifierPatchModel' example: LoadEligibility: true StateModifiers: - State: string Modifiers: {} application/json: schema: $ref: '#/components/schemas/ModifierPatchModel' example: LoadEligibility: true StateModifiers: - State: string Modifiers: {} text/json: schema: $ref: '#/components/schemas/ModifierPatchModel' example: LoadEligibility: true StateModifiers: - State: string Modifiers: {} application/*+json: schema: $ref: '#/components/schemas/ModifierPatchModel' example: LoadEligibility: true StateModifiers: - State: string Modifiers: {} responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 807378df9c0b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 9d254b47dcd7 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ModifiersPatchResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: Eligibility: Eligibility: string Details: - Type: string Eligibility: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 96bb0fcb1d7a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 3cbe5e459bbf timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/officer-information: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all officer types and endorsement information that can be added to… description: Retrieves all officer types and endorsement information that can be added to the quote specified by the URI parameter __quoteId.__ operationId: get-api-v1-specialty-program-quotes-quoteid-officer-information parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: state in: query schema: type: string - name: type in: query schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 1e84f08c3667 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: ede12c8a5601 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OfficerInformationModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - OfficerType: string State: string LimitInformation: ExcludedOfficerLimit: 0 ValidationMessage: string EndorsementInformation: ValidationMessage: string Endorsements: - FormType: string FormSubType: string Id: string Description: string MinOwnershipPercentage: 0 MaxOwnershipPercentage: 0 OwnershipPctValidationMessage: string MinAnnualCompensation: 0 MaxAnnualCompensation: 0 AnnualCompensationValidationMessage: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: f29e3fdbf31c timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/partners: delete: tags: - Workers Comp-Specialty Programs summary: Removes saved California partner information from the quote. 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-specialty-program-quotes-quoteid-partners parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: partnerId in: query schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b19539ed3411 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: aba1aecf9691 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BooleanBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: true '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: e3c05113ba74 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD post: tags: - Workers Comp-Specialty Programs summary: Saves California partner names to a quote. 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-specialty-program-quotes-quoteid-partners parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/PostQuotePartnerRequest' example: - FirstName: string LastName: string Organization: string application/json: schema: type: array items: $ref: '#/components/schemas/PostQuotePartnerRequest' example: - FirstName: string LastName: string Organization: string text/json: schema: type: array items: $ref: '#/components/schemas/PostQuotePartnerRequest' example: - FirstName: string LastName: string Organization: string application/*+json: schema: type: array items: $ref: '#/components/schemas/PostQuotePartnerRequest' example: - FirstName: string LastName: string Organization: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: e0b57cb36352 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: e9309109c9cf timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - PartnerId: 0 FirstName: string LastName: string Organization: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 9b89055259ce timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD get: tags: - Workers Comp-Specialty Programs summary: Returns the partner names and organization on the specified quote. 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-specialty-program-quotes-quoteid-partners parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: partnerId in: query schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b799bb4bbbfc timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: b6e322095170 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - PartnerId: 0 FirstName: string LastName: string Organization: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: b82cc715ac7a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD put: tags: - Workers Comp-Specialty Programs summary: Updates the partner names or organizations on the specified quote. 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-specialty-program-quotes-quoteid-partners parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: partnerId in: query schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/PutQuotePatnerRequest' example: - PartnerId: 0 FirstName: string LastName: string Organization: string application/json: schema: type: array items: $ref: '#/components/schemas/PutQuotePatnerRequest' example: - PartnerId: 0 FirstName: string LastName: string Organization: string text/json: schema: type: array items: $ref: '#/components/schemas/PutQuotePatnerRequest' example: - PartnerId: 0 FirstName: string LastName: string Organization: string application/*+json: schema: type: array items: $ref: '#/components/schemas/PutQuotePatnerRequest' example: - PartnerId: 0 FirstName: string LastName: string Organization: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: adbbd01f7b03 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f675d2a21bd1 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QuotePartnersResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - PartnerId: 0 FirstName: string LastName: string Organization: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 7c0dcf524f92 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/partners/{partnerId}: patch: tags: - Workers Comp-Specialty Programs summary: Updates the partner name or organization for a specific partner ID on the… 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-specialty-program-quotes-quoteid-partners-partnerid parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: partnerId in: path required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PatchQuotePatnerRequest' example: FirstName: string LastName: string Organization: string application/json: schema: $ref: '#/components/schemas/PatchQuotePatnerRequest' example: FirstName: string LastName: string Organization: string text/json: schema: $ref: '#/components/schemas/PatchQuotePatnerRequest' example: FirstName: string LastName: string Organization: string application/*+json: schema: $ref: '#/components/schemas/PatchQuotePatnerRequest' example: FirstName: string LastName: string Organization: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 9531e6d5e518 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 87617973716a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QuotePartnersResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: PartnerId: 0 FirstName: string LastName: string Organization: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 33274ccd2b9d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes/{quoteId}/paymentPlans: post: tags: - Workers Comp-Specialty Programs summary: Saves the selected payment plan to the specified quote description: Saves the selected payment plan to the specified quote. operationId: post-api-v2-specialty-program-quotes-quoteid-paymentplans parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PaymentPlanPostModel' examples: Standard payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Agency Direct payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Direct Payo payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PAYO InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: 10020 BillingType: Direct Psr payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PSR InsuredName: Test Insured InsuredEmail: insured@email.com AgentName: Test Agent AgentEmail: agent@email.com AccountManagerCSRName: Test Account Manager CSR AccountManagerCSREmail: csr@email.com PayrollCompanyId: null BillingType: Direct application/json: schema: $ref: '#/components/schemas/PaymentPlanPostModel' examples: Standard payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Agency Direct payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Direct Payo payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PAYO InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: 10020 BillingType: Direct Psr payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PSR InsuredName: Test Insured InsuredEmail: insured@email.com AgentName: Test Agent AgentEmail: agent@email.com AccountManagerCSRName: Test Account Manager CSR AccountManagerCSREmail: csr@email.com PayrollCompanyId: null BillingType: Direct text/json: schema: $ref: '#/components/schemas/PaymentPlanPostModel' examples: Standard payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Agency Direct payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Direct Payo payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PAYO InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: 10020 BillingType: Direct Psr payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PSR InsuredName: Test Insured InsuredEmail: insured@email.com AgentName: Test Agent AgentEmail: agent@email.com AccountManagerCSRName: Test Account Manager CSR AccountManagerCSREmail: csr@email.com PayrollCompanyId: null BillingType: Direct application/*+json: schema: $ref: '#/components/schemas/PaymentPlanPostModel' examples: Standard payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Agency Direct payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: None InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: null BillingType: Direct Payo payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PAYO InsuredName: null InsuredEmail: null AgentName: null AgentEmail: null AccountManagerCSRName: null AccountManagerCSREmail: null PayrollCompanyId: 10020 BillingType: Direct Psr payment plan: value: DepositPercent: 50 NumberPayments: 6 PaymentPlanId: 1 IsDirectDebit: false PaymentPlan: PaymentPlanType: PSR InsuredName: Test Insured InsuredEmail: insured@email.com AgentName: Test Agent AgentEmail: agent@email.com AccountManagerCSRName: Test Account Manager CSR AccountManagerCSREmail: csr@email.com PayrollCompanyId: null BillingType: Direct responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c38427a812ea timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 5e8f073b58b9 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: f88b7f52a0e2 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} /api/v1/specialty-program/quotes/{quoteId}/terms-of-agreement: post: tags: - Workers Comp-Specialty Programs summary: Saves acknowledgement that the insured has read the Terms of Agreement… description: This endpoint is meant to be used in conjunction with the (GET) Terms of Agreement endpoint. Insureds will need to acknowledge that they have red the statement in order to submit their Direct Debit Information. operationId: post-api-v1-specialty-program-quotes-quoteid-terms-of-agreement parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/TermsOfAgreementModel' example: IsAcknowledged: string application/json: schema: $ref: '#/components/schemas/TermsOfAgreementModel' example: IsAcknowledged: string text/json: schema: $ref: '#/components/schemas/TermsOfAgreementModel' example: IsAcknowledged: string application/*+json: schema: $ref: '#/components/schemas/TermsOfAgreementModel' example: IsAcknowledged: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d2fad18be6f3 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: d7b05517ea10 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: d3f6be632143 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '200': description: Success content: application/json: schema: type: object properties: isOk: type: boolean httpStatusCode: type: integer format: int32 responseId: type: string timeStamp: type: string format: date-time messages: type: array items: type: object properties: httpStatusCode: type: integer format: int32 messageCode: type: string isOk: type: boolean detail: type: string maxMessageIndex: type: integer format: int32 _v: type: string example: isOk: true httpStatusCode: 200 responseId: bf30862e05fe timeStamp: '2026-08-13T11:08:12.0000000+00:00' messages: - httpStatusCode: 200 messageCode: SUCCESS isOk: true detail: Acknowledgement saved successfully! maxMessageIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/underwriter-messages: post: tags: - Workers Comp-Specialty Programs summary: Send message to underwriter operationId: post-api-v1-specialty-program-quotes-quoteid-underwriter-messages parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/MessageToUnderwriterModel' example: Message: string application/json: schema: $ref: '#/components/schemas/MessageToUnderwriterModel' example: Message: string text/json: schema: $ref: '#/components/schemas/MessageToUnderwriterModel' example: Message: string application/*+json: schema: $ref: '#/components/schemas/MessageToUnderwriterModel' example: Message: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: edb9bf9e2757 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: c158da195cbe timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: c37118dab887 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: b6e12239d40f timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '200': description: Success content: application/json: schema: type: object properties: isOk: type: boolean httpStatusCode: type: integer format: int32 responseId: type: string timeStamp: type: string format: date-time messages: type: array items: type: object properties: httpStatusCode: type: integer format: int32 messageCode: type: string isOk: type: boolean detail: type: string maxMessageIndex: type: integer format: int32 _v: type: string example: isOk: true httpStatusCode: 200 responseId: bf30862e05fe timeStamp: '2026-08-13T11:08:12.0000000+00:00' messages: - httpStatusCode: 200 messageCode: SUCCESS isOk: true detail: Your message has been successfully sent to the underwriter! maxMessageIndex: 0 _v: AD get: tags: - Workers Comp-Specialty Programs summary: Retrieve underwriter message history operationId: get-api-v1-specialty-program-quotes-quoteid-underwriter-messages parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 36539c3e1045 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: c4f0ea92af8d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetUnderwritingMessageListBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - IndexId: 0 User: string Message: string AgentEntry: true Sent: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: c4c9c10f0d6e timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/voluntary-compensation: post: tags: - Workers Comp-Specialty Programs summary: Saves a voluntary compensation endorsement to the quote specified by the quote… description: Saves a voluntary compensation endorsement to the quote specified by the quote ID passed. operationId: post-api-v1-specialty-program-quotes-quoteid-voluntary-compensation parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/PostCompensationRequest' example: - EndorsementNumber: string FormDataFields: - IndexId: 0 Values: string application/json: schema: type: array items: $ref: '#/components/schemas/PostCompensationRequest' example: - EndorsementNumber: string FormDataFields: - IndexId: 0 Values: string text/json: schema: type: array items: $ref: '#/components/schemas/PostCompensationRequest' example: - EndorsementNumber: string FormDataFields: - IndexId: 0 Values: string application/*+json: schema: type: array items: $ref: '#/components/schemas/PostCompensationRequest' example: - EndorsementNumber: string FormDataFields: - IndexId: 0 Values: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 38e78b7ec852 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: ae22ca88ec7b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StringBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 636db5e80997 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: cdb859c93caa timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD get: tags: - Workers Comp-Specialty Programs summary: Retrieves available voluntary compensation coverage information for the quote… description: Retrieves available voluntary compensation coverage information for the quote ID passed. operationId: get-api-v1-specialty-program-quotes-quoteid-voluntary-compensation parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 13eb9393f97b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: beee95f55c0a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VoluntaryCompensationResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - EndorsementNumber: string Description: string FormDataFields: - IndexId: 0 Label: string Required: true CanEnterFreeText: true CurrentValue: string PresetValues: - string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 9b52dc14fe4b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD delete: tags: - Workers Comp-Specialty Programs summary: Removes the voluntary compensation coverage endorsement from the quote ID… 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-specialty-program-quotes-quoteid-voluntary-compensation parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: endorsementNumber in: query schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c430496ff63d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: a85b73f6e2de timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StringBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 2a1da9d1ac69 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/agent-contacts: get: tags: - Workers Comp-Specialty Programs summary: Returns all agent contact IDs, names, and emails linked to the agent associated… description: Returns all agent contact IDs, names, and emails linked to the agent associated with the current authentication token. operationId: get-api-v1-specialty-program-quotes-agent-contacts responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c368f3afdffa timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 93c86e8d3301 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/AgentContact' example: - Id: string FullName: string Email: string AgentId: 0 /api/v1/specialty-program/quotes/billType: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the bill type available for the agency associated with the current… description: Retrieves the bill type available for the agency associated with the current authentication token. operationId: get-api-v1-specialty-program-quotes-billtype responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: a1fcdfc21d47 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8a032bb1bc1a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillTypeResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: BillTypes: - string EndQuotingNewBusinessDate: string /api/v1/specialty-program/state-classes-eligibility/{state}/{classCode}: get: tags: - Workers Comp-Specialty Programs summary: Retrieves eligibility status of a specified class code in the given state. 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-specialty-program-state-classes-eligibility-state-classcode parameters: - name: state in: path required: true schema: type: string - name: classCode in: path required: true schema: type: string - name: effectiveDate in: query schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: a0663ede9bfa timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 2d904fa28c3b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClassCodeEligibilityResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - ClassCode: string ClassDescriptionCode: string ClassDescription: string Eligibility: string EffectiveDate: string ExpirationDate: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: e0719835ef05 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/states/{governingState}/effectiveDate/{effectiveDate}/legalEntities/available: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all legal entities that are available in a specified state as of the… description: Retrieves all legal entities that are availablein a specified state, as of the effective date passed. operationId: get-api-v2-specialty-program-states-governingstate-effectivedate-effectiveda parameters: - name: governingState in: path required: true schema: maxLength: 2 minLength: 2 type: string - name: effectiveDate in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b0b3c1d39ed4 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 061ee618b04b timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LegalEntityResponseIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - LegalEntityId: 0 EntityDescription: string /api/v1/specialty-program/terms-of-agreement: get: tags: - Workers Comp-Specialty Programs summary: Retrieves the Terms of Agreement statement. description: This endpoint is meant to be used in conjunction with the (POST) Terms of Agreement endpoint. Insureds will need to acknowledge that they have read the statement before entering the Direct Debit information. operationId: get-api-v1-specialty-program-terms-of-agreement responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 8a0870f4752a timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: e58e8c065627 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: type: string example: string /api/v1/specialty-program/quotes/{quoteId}/stop-gap/{id}: delete: tags: - Workers Comp-Specialty Programs summary: Deletes the stop gap coverage selected as well as all additional locations in… description: This endpoint will delete the stop gap coverage selected as well as all additional locations in that state. The ID that should be used is that associated with the Stop Gap Coverage. operationId: delete-api-v1-specialty-program-quotes-quoteid-stop-gap-id parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: id in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c25244d47165 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 145d135973d4 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DeleteStopGapCoverageResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: CoverageId: 0 Locations: - Line1: string Line2: string City: string State: string Zip: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: b27a25d0d674 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/additionalInformation/insureds/{insuerdId}: delete: tags: - Workers Comp-Specialty Programs summary: Removes a specified insured from the specialty quote specified by the URI… description: Removes a specified insured from the quote specified by the URI parameter quoteId. operationId: remove_specialty_quote_additional_information_insured parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: insuerdId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 7dff195c84a5 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: cbdd1fce64ba timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 8e61a7a96b9f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/bind/agent-contact/{agentContactId}: post: tags: - Workers Comp-Specialty Programs summary: Binds a specialty program quote to a policy description: This endpoint is used to bind quotes operationId: post-api-v1-specialty-program-quotes-quoteid-bind-agent-contact-agentcontact parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: agentContactId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 85be146042d2 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: fcb251eba4a0 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BindResponseBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: QuoteId: 0 Policy: string PolicyId: 0 EffectiveDate: string AnnualPremium: string /api/v1/specialty-program/quotes/{quoteId}/dividends: post: tags: - Workers Comp-Specialty Programs summary: Adds dividends to the specified specialty program quote description: Add dividends to quote operationId: post-api-v1-specialty-program-quotes-quoteid-dividends parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/PostDividendsModel' example: DividendId: 0 DividendSubTypeId: 0 application/json: schema: $ref: '#/components/schemas/PostDividendsModel' example: DividendId: 0 DividendSubTypeId: 0 text/json: schema: $ref: '#/components/schemas/PostDividendsModel' example: DividendId: 0 DividendSubTypeId: 0 application/*+json: schema: $ref: '#/components/schemas/PostDividendsModel' example: DividendId: 0 DividendSubTypeId: 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d49a5b687d49 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 3f4d7d2fa864 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PostDividendsResponseModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: DividendId: 0 DividendSubTypeId: 0 '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' delete: tags: - Workers Comp-Specialty Programs summary: Removes a dividend from the specified specialty program quote description: Allows users to remove a dividend from a quote. operationId: delete-api-v1-specialty-program-quotes-quoteid-dividends parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: cdd981206a74 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 009c999ed0c4 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' '424': description: An internal dependency has failed. content: application/json: schema: $ref: '#/components/schemas/FailedDependencyErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}/foreign-voluntary-coverage: post: tags: - Workers Comp-Specialty Programs summary: Save Foreign Voluntary Coverage description: Allows users to submit Foreign Voluntary Coverage. operationId: post-api-v1-specialty-program-quotes-quoteid-foreign-voluntary-coverage parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/ForeignVoluntaryCoverageWriteModel' example: - GovState: string Employee: string Location: string WcLaw: string application/json: schema: type: array items: $ref: '#/components/schemas/ForeignVoluntaryCoverageWriteModel' example: - GovState: string Employee: string Location: string WcLaw: string text/json: schema: type: array items: $ref: '#/components/schemas/ForeignVoluntaryCoverageWriteModel' example: - GovState: string Employee: string Location: string WcLaw: string application/*+json: schema: type: array items: $ref: '#/components/schemas/ForeignVoluntaryCoverageWriteModel' example: - GovState: string Employee: string Location: string WcLaw: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 2a74ce9fdf4d timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 08633afe92b4 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ForeignVoluntaryCoverageReadModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - IndexId: 0 GovState: string Employee: string Location: string WcLaw: string '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 695f86c39506 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/available_dividends: get: tags: - Workers Comp-Specialty Programs summary: Provides a list of all available dividends for a specialty program quote description: Provides a list of all available dividends for a specialty quote. operationId: get-api-v1-specialty-program-quotes-quoteid-available_dividends parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: c5481c1b8ba4 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: b5d1a5574312 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetSpecialtyQuoteAvailableDividendsResponseModelBaseResponse' example: Data: SingleState: - DividendSubTypeId: 1 DividendName: Test Single State Dividend DividendId: 123 MultiState: - DividendSubTypeId: 2 DividendName: Test Multi State Dividend DividendId: 234 NationalGroup: - DividendSubTypeId: 3 DividendName: Test National Group Dividend DividendId: 345 StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorBaseResponse' /api/v1/specialty-program/quotes/{quoteId}/third-party-notices: delete: tags: - Workers Comp-Specialty Programs summary: Deletes the specified third-party notice from a specialty program quote description: This endpoint will delete the specified third-party notice. operationId: delete-api-v1-specialty-program-quotes-quoteid-third-party-notices parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ThirdPartyNoticeDeleteModelV1' example: Indexes: - 0 application/json: schema: $ref: '#/components/schemas/ThirdPartyNoticeDeleteModelV1' example: Indexes: - 0 text/json: schema: $ref: '#/components/schemas/ThirdPartyNoticeDeleteModelV1' example: Indexes: - 0 application/*+json: schema: $ref: '#/components/schemas/ThirdPartyNoticeDeleteModelV1' example: Indexes: - 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: e7899db25b6d timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: e679abb20a87 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' /api/v1/specialty-program/policies/{policyId}/reinstatement: post: tags: - Workers Comp-Specialty Programs summary: This endpoint allows authorized users to reinstate a cancelled policy description: This endpoint allows authorized users to reinstate a cancelled policy. operationId: post-api-v1-specialty-program-policies-policyid-reinstatement parameters: - name: policyId in: path required: true schema: type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/ReinstatePolicyRequest' example: ReinstatementReason: string ReinstatementDate: string application/json: schema: $ref: '#/components/schemas/ReinstatePolicyRequest' example: ReinstatementReason: string ReinstatementDate: string text/json: schema: $ref: '#/components/schemas/ReinstatePolicyRequest' example: ReinstatementReason: string ReinstatementDate: string application/*+json: schema: $ref: '#/components/schemas/ReinstatePolicyRequest' example: ReinstatementReason: string ReinstatementDate: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d2105dab72cd timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 92d61c661275 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 900e5d598ba3 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: ce5ddbd9e20e timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/foreign-voluntary-coverage/{indexId}: delete: tags: - Workers Comp-Specialty Programs summary: Delete Foreign Voluntary Coverage description: This endpoint allows users to delete foreign voluntary coverages from a quote. operationId: delete-api-v1-specialty-program-quotes-quoteid-foreign-voluntary-coverage-in parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: indexId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d9685d5da94b timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 9dab87f7a96a timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 5466a7361a39 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/Nonrenewal-reason: get: tags: - Workers Comp-Specialty Programs summary: Returns full list of all available reasons for not renewing a policy description: Provides full list of all available reasons for not renewing a policy operationId: get-api-v1-specialty-program-policies-nonrenewal-reason responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: b5437558cf3e timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 693a7228eb94 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/NonrenewCodeModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - NonrenewReasonCode: 0 NonrenewReasonDesc: string StateExclusion: - string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: bc13f1a38a14 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v2/specialty-program/quotes/{quoteId}/underwriter-messages: post: tags: - Workers Comp-Specialty Programs summary: Send message to underwriter description: 'The Reason available options: __•__ Price __•__ Waiver of Subrogation (WOS) __•__ Form/Coverage Request (not WOS) __•__ Dividend __•__ Deductible __•__ Class Code Verification __•__ Other' operationId: post-api-v2-specialty-program-quotes-quoteid-underwriter-messages parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/MessageToUnderwriterModelV2' example: Message: string Reason: string application/json: schema: $ref: '#/components/schemas/MessageToUnderwriterModelV2' example: Message: string Reason: string text/json: schema: $ref: '#/components/schemas/MessageToUnderwriterModelV2' example: Message: string Reason: string application/*+json: schema: $ref: '#/components/schemas/MessageToUnderwriterModelV2' example: Message: string Reason: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 7b39a729fd28 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 9f85c25dc0c2 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 1761c69bc533 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 457b9bbb8645 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD '200': description: Success content: application/json: schema: type: object properties: isOk: type: boolean httpStatusCode: type: integer format: int32 responseId: type: string timeStamp: type: string format: date-time messages: type: array items: type: object properties: httpStatusCode: type: integer format: int32 messageCode: type: string isOk: type: boolean detail: type: string maxMessageIndex: type: integer format: int32 _v: type: string example: isOk: true httpStatusCode: 200 responseId: bf30862e05fe timeStamp: '2026-08-13T11:08:12.0000000+00:00' messages: - httpStatusCode: 200 messageCode: SUCCESS isOk: true detail: Your message has been successfully sent to the underwriter! maxMessageIndex: 0 _v: AD /api/v1/specialty-program/policies: get: tags: - Workers Comp-Specialty Programs summary: Search basic policy information 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-specialty-program-policies parameters: - name: MasterAccountId in: query schema: type: integer format: int32 - name: PolicyId in: query schema: type: integer format: int32 - name: Fein in: query schema: type: string - name: Quote in: query schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 91ce88732efb timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 9c6a92517adf timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PolicySearchResponseIReadOnlyCollectionBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - PolicyNumber: string BusinessName: string EffectiveDate: string PolicyStatus: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 83e71d6de708 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policyId}/nonrenewal: post: tags: - Workers Comp-Specialty Programs summary: Set Policy As Non-Renewal description: This endpoint allows users to set policy as non-renewal. operationId: post-api-v1-specialty-program-policies-policyid-nonrenewal parameters: - name: policyId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/SetPolicyAsNonRenewalRequest' example: NonRenewalReason: 11 Description: Customer has requested to not renew this policy. application/json: schema: $ref: '#/components/schemas/SetPolicyAsNonRenewalRequest' example: NonRenewalReason: 11 Description: Customer has requested to not renew this policy. text/json: schema: $ref: '#/components/schemas/SetPolicyAsNonRenewalRequest' example: NonRenewalReason: 11 Description: Customer has requested to not renew this policy. application/*+json: schema: $ref: '#/components/schemas/SetPolicyAsNonRenewalRequest' example: NonRenewalReason: 11 Description: Customer has requested to not renew this policy. responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 54b20e1fc85d timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 142d42b70da4 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: e39a8cdf51d2 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/policies/{policyId}/nonrenewal/reversal: post: tags: - Workers Comp-Specialty Programs summary: This endpoint allows users to reverse a non-renewal that was previously set on… description: This endpoint allows users to reverse a non-renewal that was previously set on a policy. operationId: post-api-v1-specialty-program-policies-policyid-nonrenewal-reversal parameters: - name: policyId in: path description: '' required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 300589d83328 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: b84421ed49ee timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorBaseResponse' /api/v1/specialty-program/policies/{policyId}/officer-information: get: tags: - Workers Comp-Specialty Programs summary: Get policy officer information description: Provides all officers available to be included on this policy operationId: get-api-v1-specialty-program-policies-policyid-officer-information parameters: - name: policyId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 8c037cc82eeb timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: fb2b56c4912f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OfficerInformationModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: OfficerType: string State: string LimitInformation: ExcludedOfficerLimit: 0 ValidationMessage: string EndorsementInformation: ValidationMessage: string Endorsements: - FormType: string FormSubType: string Id: string Description: string MinOwnershipPercentage: 0 MaxOwnershipPercentage: 0 OwnershipPctValidationMessage: string MinAnnualCompensation: 0 MaxAnnualCompensation: 0 AnnualCompensationValidationMessage: string /api/v1/specialty-program/price-tiering/state/{stateAbbreviation}/classCode/{classCode}/zipCode/{zipCode}: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all available pricing tiers for a given state, class code, and zip… description: Retrieves all available pricing tiers for the provided state, class code, and zip code. operationId: get-api-v1-specialty-program-price-tiering-state-stateabbreviation-classcode parameters: - name: stateAbbreviation in: path required: true schema: type: string - name: classCode in: path required: true schema: type: string - name: zipCode in: path required: true schema: type: string responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 1915fca8b5e8 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 3f9b624991b9 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PriceTieringResponseModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - ClassCode: string FirmName: string FirmId: 0 TierId: 0 TierName: string /api/v1/specialty-program/quotes/{quoteId}/small-deductible: get: tags: - Workers Comp-Specialty Programs summary: Retrieves all available small deductible options for a specified specialty… description: This provides all available small deductible options per quote. operationId: get-api-v1-specialty-program-quotes-quoteid-small-deductible parameters: - name: quoteId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 4a9eb59c4c3f timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 18dfccf962d1 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SmallDeductibleResponseModelIEnumerableBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: - DedId: 0 GovState: string DedAccLimit: 0 DedPct: 0 HazardGrp: string '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorBaseResponse' /api/v1/specialty-program/price-tiering/state/{state}/firm/{firmId}: get: tags: - Workers Comp-Specialty Programs summary: Provides a breakdown of pricing tier options by state and firm description: This endpoint provides a breakdown of pricing tier options by state and firm. operationId: get-api-v1-specialty-program-price-tiering-state-state-firm-firmid parameters: - name: state in: path required: true schema: type: string - name: firmId in: path required: true schema: type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: d4496b5c8a48 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: f5737cd93841 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PricingTierResponseIEnumerableBaseResponse' example: Data: - FirmId: 1 TierName: Standard TierId: 0 State: AL - FirmId: 1 TierName: Standard-1 TierId: 7 State: AL StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} /api/v1/specialty-program/quotes/{quoteId}/specific-waivers: post: tags: - Workers Comp-Specialty Programs summary: Creates new specific waivers description: Allows users to create new specific waivers operationId: post-api-v1-specialty-program-quotes-quoteid-specific-waivers parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/WaiverWriteModel' example: - StartDate: '2026-08-13' Name: Waiver 123 Address: 2001 Park Manor Blvd City: Pittsburgh State: AL Zip: '15205' ClassCode: '8810' GovState: AL JobDescription: General construction labor Payroll: 65000 application/json: schema: type: array items: $ref: '#/components/schemas/WaiverWriteModel' example: - StartDate: '2026-08-13' Name: Waiver 123 Address: 2001 Park Manor Blvd City: Pittsburgh State: AL Zip: '15205' ClassCode: '8810' GovState: AL JobDescription: General construction labor Payroll: 65000 text/json: schema: type: array items: $ref: '#/components/schemas/WaiverWriteModel' example: - StartDate: '2026-08-13' Name: Waiver 123 Address: 2001 Park Manor Blvd City: Pittsburgh State: AL Zip: '15205' ClassCode: '8810' GovState: AL JobDescription: General construction labor Payroll: 65000 application/*+json: schema: type: array items: $ref: '#/components/schemas/WaiverWriteModel' example: - StartDate: '2026-08-13' Name: Waiver 123 Address: 2001 Park Manor Blvd City: Pittsburgh State: AL Zip: '15205' ClassCode: '8810' GovState: AL JobDescription: General construction labor Payroll: 65000 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 856f85c11821 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 40a57cc76aec timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WaiverReadModelIEnumerableBaseResponse' example: Data: - IndexId: 123 EndDate: null StartDate: '2026-08-13' Name: Waiver 123 Address: 2001 Park Manor Blvd City: Pittsburgh State: AL Zip: '15205' ClassCode: '8810' GovState: AL JobDescription: General construction labor Payroll: 65000 StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 14dd497c63a9 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD put: tags: - Workers Comp-Specialty Programs summary: Updates a specific waiver description: Allows users to update an existing specific waiver operationId: put-api-v1-specialty-program-quotes-quoteid-specific-waivers parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/UpdateWaiverModel' example: StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 application/json: schema: $ref: '#/components/schemas/UpdateWaiverModel' example: StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 text/json: schema: $ref: '#/components/schemas/UpdateWaiverModel' example: StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 application/*+json: schema: $ref: '#/components/schemas/UpdateWaiverModel' example: StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: f6522ce62f7f timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 04dcf7dfc0ee timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WaiverReadModelBaseResponse' example: StatusCode: 100 = Continue Message: string AdditionalMessages: - string Errors: {} Data: StartDate: string Name: string Address: string City: string State: string Zip: string ClassCode: string GovState: string JobDescription: string Payroll: 0 IndexId: 0 EndDate: string '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 8afc6b6069cd timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/specific-waivers/{indexId}: delete: tags: - Workers Comp-Specialty Programs summary: Deletes a specific waiver description: This endpoint is to delete specific waivers no longer needed. operationId: delete-api-v1-specialty-program-quotes-quoteid-specific-waivers-indexid parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 - name: indexId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 063a09fbd312 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 8026e54f0db8 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/BadRequestErrorIApiResponse' example: responseId: 9395833e39b9 timeStamp: '2026-08-13T11:08:12.0000000+00:00' httpStatusCode: 400 isOk: false errors: - MessageCode: ERR-ValidationErr Title: Validation Error Detail: Validation detail message httpStatusCode: 400 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/modifiers/available_schedulemodifier: get: tags: - Workers Comp-Specialty Programs summary: Get available state category rationales description: If a scheduled modifier is added to a quote, user can provide additional information to explain the reason for adding this modifier. This endpoint provides the options for the additional information required. It is not required, and the rationale will default if no user selected rationale is included. operationId: get-api-v1-specialty-program-quotes-quoteid-modifiers-available_schedulemodi parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 9695e1c85a62 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: c3ebfad42897 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StateCategoryRationaleIEnumerableBaseResponse' example: Data: - State: CA Categories: - CategoryTypeId: 1 Category: Employees Minimum: -10 Maximum: 10 Rationales: - RationalName: Turnover rate RationaleTypeId: 17 - RationalName: Wage scales RationaleTypeId: 11 StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 5e48c9e7d613 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD /api/v1/specialty-program/quotes/{quoteId}/modifiers/schedulemodifier: get: tags: - Workers Comp-Specialty Programs summary: Get available schedule modifiers description: Provides all scheduled modifier rationales added to a quote. operationId: get-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: 279641357baa timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 82812db43c0f timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse' example: Data: - State: NY Categories: - CategoryTypeId: 1 CategoryName: Employees Amount: 1 Rationales: - RationaleTypeId: 20 RationaleName: Training at hire and ongoing - RationaleTypeId: 27 RationaleName: Supervised workforce StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: 2e9c9d94e5d9 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD post: tags: - Workers Comp-Specialty Programs summary: Get available modifier schedules description: If a scheduled modifier is added to a quote the rationale for this modifier is defaulted at time of adding to the quote. This endpoint allows users to update the rationale included on the quote for the scheduled modifier. operationId: post-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 application/json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 text/json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 application/*+json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: ad80083a63da timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 28c2ed1c456c timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BaseResponse' example: StatusCode: 200 Exception: null Message: The non-renewal reason of 11 'Other' was saved. The non-renewal date set is today's date. AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: cde95b355cd6 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD put: tags: - Workers Comp-Specialty Programs summary: Update schedule modifier rationale information description: This endpoint allows users to edit information entered for the schedule modifier rationale operationId: put-api-v1-specialty-program-quotes-quoteid-modifiers-schedulemodifier parameters: - name: quoteId in: path required: true schema: minimum: 1.0 type: integer format: int32 requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 application/json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 text/json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 application/*+json: schema: $ref: '#/components/schemas/RationalePostModel' example: State: string CategoryTypeId: 0 Amount: 0 RationaleTypeId: 0 responses: '401': description: Bad or expired token. To resolve this error, generate a new or refreshed token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedErrorIApiResponse' example: responseId: bab2eac34bfd timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 401 isOk: false errors: - MessageCode: ERR-NOTAUTHORIZED Title: Bearer token is not authorized httpStatusCode: 401 isOk: false maxErrorIndex: 0 _v: AD '403': description: The authenticated user or client does not have required permissions to complete this request. content: application/json: schema: $ref: '#/components/schemas/ForbiddenErrorIApiResponse' example: responseId: 948fdeca7937 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 403 isOk: false errors: - MessageCode: ERR-FORBIDDEN Title: The token provided does not have permissions for the requested action httpStatusCode: 403 isOk: false maxErrorIndex: 0 _v: AD '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ModifierScheduleResponseIEnumerableBaseResponse' example: Data: - State: NY Categories: - CategoryTypeId: 1 CategoryName: Employees Amount: 1 Rationales: - RationaleTypeId: 20 RationaleName: Training at hire and ongoing - RationaleTypeId: 27 RationaleName: Supervised workforce StatusCode: 200 Exception: null Message: null AdditionalMessages: [] Errors: {} '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorIApiResponse' example: responseId: aac712a39212 timeStamp: '2026-08-13T11:08:11.0000000+00:00' httpStatusCode: 404 isOk: false errors: - MessageCode: ERR-ItemNotFound Title: Item was not found httpStatusCode: 404 isOk: false maxErrorIndex: 0 _v: AD components: schemas: 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: '' DeleteStopGapCoverageResponseBaseResponse: 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/DeleteStopGapCoverageResponse' 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 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 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 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: '' GetDividendModelBase: type: object properties: DividendName: type: - string - 'null' DividendId: type: integer format: int32 additionalProperties: false PricingTierResponse: type: object properties: TierId: type: integer format: int32 State: type: - string - 'null' FirmId: type: integer format: int32 TierName: type: - string - 'null' additionalProperties: false 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 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: '' ModifierScheduleRationale: type: object properties: RationaleTypeId: type: integer description: Rationale Type Id format: int32 RationaleName: type: - string - 'null' description: Rationale Name additionalProperties: false 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 PriceTieringResponseModelIEnumerableBaseResponse: 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/PriceTieringResponseModel' description: Data 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: '' ClassSpecialtyPostModel: required: - ClassCode - FullTimeEmployees - PartTimeEmployees - Payroll type: object properties: ClassCode: minLength: 1 type: string 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: maximum: 79228162514264337593543950335 minimum: 1.0 type: integer description: Required if ClassCode is provided format: int32 FullTimeEmployees: type: integer description: Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both format: int32 PartTimeEmployees: type: integer description: Either FullTimeEmployees or PartTimeEmployees is required to bind. Can update quote without both format: int32 additionalProperties: false description: '' 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 QuoteSpecialtyPostModelV2: 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 GetQuoteSpecialtyReturnModelBaseResponse: 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/GetQuoteSpecialtyReturnModel' additionalProperties: false description: '' 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: '' 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: '' 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 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 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 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 Operation: type: object properties: OperationType: $ref: '#/components/schemas/OperationType' path: type: - string - 'null' op: type: - string - 'null' from: type: - string - 'null' value: {} additionalProperties: false 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 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: '' GetDividendModel: type: object properties: DividendName: type: - string - 'null' DividendId: type: integer format: int32 DividendSubTypeId: type: integer format: int32 additionalProperties: false 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 QuoteSpecialtyReturnModelV2: 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 PostDividendsResponseModel: type: object properties: DividendId: type: integer format: int32 DividendSubTypeId: type: integer format: int32 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 QuoteSpecialtyReturnModelV2BaseResponse: 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/QuoteSpecialtyReturnModelV2' additionalProperties: false description: '' 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: '' QuoteSpecialtyPutModel: 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 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 PriceTieringResponseModel: type: object properties: ClassCode: type: - string - 'null' FirmName: type: - string - 'null' FirmId: type: integer format: int32 TierId: type: integer format: int32 TierName: type: - string - 'null' additionalProperties: false 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 NonrenewCodeModel: type: object properties: NonrenewReasonCode: type: integer description: NonrenewReasonCode format: int32 NonrenewReasonDesc: type: - string - 'null' description: NonrenewReasonDesc StateExclusion: type: - array - 'null' items: type: string description: StateExclusion additionalProperties: false description: NonrenewCodeModel 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: '' 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: '' 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 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: '' 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 PricingTierResponseIEnumerableBaseResponse: 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/PricingTierResponse' 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 PostDividendsResponseModelBaseResponse: 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/PostDividendsResponseModel' additionalProperties: false description: '' 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: '' 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 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: '' QuoteSpecialtyReturnModel: type: object properties: EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: Expiration Date Fein: type: - string - 'null' description: Fein FirmId: type: - string - 'null' description: Firm Id 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 Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierResponseBase' additionalProperties: false description: QuoteReturnModel 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: '' 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: '' 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: '' QuoteSpecialtyReturnModelBaseResponse: 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/QuoteSpecialtyReturnModel' 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: '' 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: '' DeleteStopGapCoverageResponse: type: object properties: CoverageId: type: integer format: int32 Locations: type: - array - 'null' items: $ref: '#/components/schemas/AddressApiModel' additionalProperties: false 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 QuoteSpecialtyPostModel: type: object properties: Quote: $ref: '#/components/schemas/QuoteSpecialtyApiModel' LoadQuestions: type: - boolean - 'null' description: LoadQuestions Questions: type: - array - 'null' items: $ref: '#/components/schemas/Answer' description: Questions Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierPatchModel' description: 'List of modifiers including: Experience, Schedule, Drug Free and Safety Credit.' LoadRateSummary: type: boolean PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierPostModel' additionalProperties: false description: QuoteSpecialtyPostModel 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: '' ForeignVoluntaryCoverageWriteModel: required: - Employee - GovState - Location - WcLaw type: object properties: GovState: minLength: 1 type: string Employee: minLength: 1 type: string Location: minLength: 1 type: string WcLaw: minLength: 1 type: string additionalProperties: false PatchQuoteSpecialtyReturnModelV2BaseResponse: 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/PatchQuoteSpecialtyReturnModelV2' additionalProperties: false description: '' ForeignVoluntaryCoverageReadModelIEnumerableBaseResponse: 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/ForeignVoluntaryCoverageReadModel' description: Data 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: '' 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: '' 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: '' FirmWithName: type: object properties: FirmId: type: integer description: Firm Id format: int32 FirmName: type: - string - 'null' description: Firm Name 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 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: '' GetFirmResponseDto: type: object properties: FirmId: type: integer format: int32 FirmName: type: - string - 'null' FirmNameShort: type: - string - 'null' AuthorizedState: type: - string - 'null' additionalProperties: false 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: '' PatchQuoteSpecialtyReturnModelV2: 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 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: '' MessageToUnderwriterModel: required: - Message type: object properties: Message: maxLength: 1000 minLength: 0 type: string additionalProperties: false 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 GetClassCodeWithFirmResponseBaseResponse: 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/GetClassCodeWithFirmResponse' 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 ContactApiModelSpecialtyPost: required: - FirstName - LastName type: object properties: FirstName: minLength: 1 type: string description: FirstName LastName: minLength: 1 type: string 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: '' 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: '' 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 NonrenewCodeModelIEnumerableBaseResponse: 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/NonrenewCodeModel' description: Data additionalProperties: false description: '' 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 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 ApiPaging: type: object properties: Request: $ref: '#/components/schemas/ApiPageRequest' Response: $ref: '#/components/schemas/ApiPageResponse' additionalProperties: false 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 PostDividendsModel: required: - DividendId - DividendSubTypeId type: object properties: DividendId: type: integer format: int32 DividendSubTypeId: type: integer format: int32 additionalProperties: false PatchQuoteSpecialtyReturnModel: type: object properties: EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: Expiration Date Fein: type: - string - 'null' description: Fein FirmId: type: - string - 'null' description: Firm Id 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' Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' additionalProperties: false FirmWithRate: type: object properties: FirmId: type: integer format: int32 BaseRate: type: number format: double 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: '' 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 ClassCodeWithFirm: type: object properties: State: type: - string - 'null' description: 2 letter state ClassCode: type: - string - 'null' description: class code Information: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeInformation' description: '' AvailableFirms: type: - array - 'null' items: $ref: '#/components/schemas/FirmWithRate' description: Firms ids that this class code can be used with additionalProperties: false description: '' 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 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 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 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: '' GetQuoteSpecialtyReturnModel: type: object properties: EffectiveDate: type: - string - 'null' description: EffectiveDate ExpirationDate: type: - string - 'null' description: Expiration Date Fein: type: - string - 'null' description: Fein FirmId: type: - string - 'null' description: Firm Id 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 Modifiers: type: - array - 'null' items: $ref: '#/components/schemas/StateModifierShortResponse' AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' RatingSummary: type: - array - 'null' items: $ref: '#/components/schemas/SummaryItemBase' PricingTiers: type: - array - 'null' items: $ref: '#/components/schemas/PricingTierResponseBase' ForeignVoluntaryCoverage: type: - array - 'null' items: $ref: '#/components/schemas/ForeignVoluntaryCoverageReadModel' SpecificWaivers: type: - array - 'null' items: $ref: '#/components/schemas/WaiverReadModel' AdditionalInformation: $ref: '#/components/schemas/AdditionalInfoReturnModel' Dividends: $ref: '#/components/schemas/GetDividendModelBase' QuoteStatus: type: - string - 'null' description: Quote Status ClosedDate: type: string description: Closed Date format: date-time additionalProperties: false GetQuoteSpecialtyReturnModelV2: 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' Dividends: $ref: '#/components/schemas/GetDividendModelBase' additionalProperties: false 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 SetPolicyAsNonRenewalRequest: required: - NonRenewalReason type: object properties: NonRenewalReason: type: integer description: 'The reason code for non-renewal. Accepted values are 1–12. If reason code 11 is provided then Description is required.' format: int32 Description: type: - string - 'null' description: Additional description for non-renewal. Required when NonRenewalReason is 11 ('Other'). additionalProperties: false 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: '' 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: '' PatchQuoteSpecialtyReturnModelBaseResponse: 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/PatchQuoteSpecialtyReturnModel' 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 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 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 GetQuoteSpecialtyReturnModelV2BaseResponse: 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/GetQuoteSpecialtyReturnModelV2' additionalProperties: false description: '' IncludingExcluding: enum: - 0 = I - 1 = E type: integer description: '' format: int32 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 GetSpecialtyQuoteAvailableDividendsResponseModelBaseResponse: 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/GetSpecialtyQuoteAvailableDividendsResponseModel' additionalProperties: false description: '' 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: '' QuoteSpecialtyApiModel: required: - Fein - 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 must be today or greater, it cannot be in the past. format: date-time ExpirationDate: type: - string - 'null' description: ExpirationDate can be any date after today and within the next 12 months. format: date-time Fein: minLength: 1 type: string description: Applicant's FEIN. Accepted format is exactly 9 numeric characters ex. 123456789. Required before bind for WC quotes PrimaryAddress: $ref: '#/components/schemas/AddressApiModel' MailingAddress: $ref: '#/components/schemas/OptionalAddressApiModel' BusinessName: maxLength: 90 minLength: 0 type: - string - 'null' description: BusinessName DBA: maxLength: 90 minLength: 0 type: - string - 'null' description: DBA ContactInformation: $ref: '#/components/schemas/ContactApiModelSpecialtyPost' 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: maximum: 2147483647.0 minimum: 0.0 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' description: Required to bind. CompanyWebsiteAddress: type: - string - 'null' description: Applicant's business website ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassSpecialtyPostModel' description: List of class codes in their appropriate state formats (PA and DE should be 3-digit or 4-digit, all other states should be 4-digit) RatingZip: maxLength: 5 minLength: 5 type: - string - 'null' description: Required to bind if any location is in California - ie ClassCode state or Primary Address State. If Primary Address State is CA, and no RatingZip is provided, the Rating Zip is defaulted to the Primary Address Zip 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 AdditionalCoverages: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalCoverage' description: Additional Coverages like Stop Gap additionalProperties: false description: '' 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 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 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 GetFirmResponseDtoIEnumerableBaseResponse: 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/GetFirmResponseDto' description: Data additionalProperties: false description: '' 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: '' ReinstatePolicyRequest: required: - ReinstatementDate - ReinstatementReason type: object properties: ReinstatementReason: minLength: 1 type: string ReinstatementDate: minLength: 1 type: string additionalProperties: false 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: '' ApiPageRequest: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Count: type: boolean additionalProperties: false OperationType: enum: - 0 = Add - 1 = Remove - 2 = Replace - 3 = Move - 4 = Copy - 5 = Test - 6 = Invalid type: integer format: int32 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 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 SmallDeductibleResponseModel: type: object properties: DedId: type: integer format: int32 GovState: type: - string - 'null' DedAccLimit: type: integer format: int32 DedPct: type: number format: double HazardGrp: type: - string - 'null' additionalProperties: false GetSpecialtyQuoteAvailableDividendsResponseModel: type: object properties: SingleState: type: - array - 'null' items: $ref: '#/components/schemas/GetDividendModel' MultiState: type: - array - 'null' items: $ref: '#/components/schemas/GetDividendModel' NationalGroup: type: - array - 'null' items: $ref: '#/components/schemas/GetDividendModel' 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 SmallDeductibleResponseModelIEnumerableBaseResponse: 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/SmallDeductibleResponseModel' description: Data additionalProperties: false description: '' 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: '' GetClassCodeWithFirmResponse: type: object properties: ClassCodes: type: - array - 'null' items: $ref: '#/components/schemas/ClassCodeWithFirm' Firms: type: - array - 'null' items: $ref: '#/components/schemas/FirmWithName' additionalProperties: false description: '' BadRequestErrorBaseResponse: 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/BadRequestError' 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 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 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: '' 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: '' 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: '' SpecialtySubmitToUnderwriterModel: type: object properties: NoteToUnderwriter: type: - string - 'null' 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 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: '' 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: '' CountryCodes: enum: - 225 = US type: integer description: us = 225 format: int32 StateCategoryRationale: type: object properties: State: type: - string - 'null' Categories: type: - array - 'null' items: $ref: '#/components/schemas/CategoryRationale' additionalProperties: false SpecialtyQuoteApiReturnModel: 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 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