{ "openapi": "3.0.1", "info": { "title": "Digital BOP API", "description": "Digital BOP API allows users to create and edit Businessowners Policy (BOP) quotes", "version": "1.0" }, "servers": [ { "url": "https://gateway.amtrustgroup.com/digital-bop" }, { "url": "https://prod-apim-gw.amtrustservices.com/digital-bop" } ], "paths": { "/api/v1/agent-contacts": { "get": { "tags": [ "Agent Contacts" ], "summary": "Retrieve all agent contacts", "description": "Returns all agent contact IDs, names, and emails linked to the agency authenticated", "operationId": "get-api-v1-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": "c06a30939799", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "9fe42ed125cd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContactDtoIEnumerableIApiResponse" }, "example": { "data": [ { "id": 1, "name": "George Washington", "email": "gwashington@uspresident.gov" }, { "id": 2, "name": "John Adams", "email": "jadams@uspresident.gov" }, { "id": 1, "name": "Thomas Jefferson", "email": "tjefferson@uspresident.gov" } ], "responseId": "71f8e87007bd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } } } } }, "/api/v1/insured/clearance": { "post": { "tags": [ "Insured Clearance" ], "summary": "Retrieve insured clearance", "description": "Returns availability of an insured to be quoted, based on name and street address", "operationId": "post-api-v1-insured-clearance", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostInsuredClearanceRequestDto" }, "example": { "name": "BOP insured", "address": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostInsuredClearanceRequestDto" }, "example": { "name": "BOP insured", "address": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostInsuredClearanceRequestDto" }, "example": { "name": "BOP insured", "address": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostInsuredClearanceRequestDto" }, "example": { "name": "BOP insured", "address": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "ebd364d150d8", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "0a69234335a0", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "004b5d0ad76a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostInsuredClearanceResponseDtoIApiResponse" }, "example": { "data": { "isAvailable": true, "message": "Insured is available for BOP product" }, "responseId": "39c78b3162f9", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/locations": { "post": { "tags": [ "Location" ], "summary": "Add location", "description": "This endpoint adds a location to the quote. Only one location per POST call is accepted", "operationId": "post-api-v1-quotes-quoteid-locations", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LocationDto" }, "example": { "propertyDeductible": "$500", "propertyDeductable": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationDto" }, "example": { "propertyDeductible": "$500", "propertyDeductable": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationDto" }, "example": { "propertyDeductible": "$500", "propertyDeductable": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LocationDto" }, "example": { "propertyDeductible": "$500", "propertyDeductable": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "3196ca14e2f4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "517272e1555c", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationGetDtoIApiResponse" }, "example": { "data": { "buildings": [], "id": 1, "propertyDeductible": "$500", "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "responseId": "08c3ee3a280b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "406f79b62a7b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } }, "get": { "tags": [ "Location" ], "summary": "Retrieve locations", "description": "Returns all currently saved locations on the quote passed, along with any class codes saved to that location", "operationId": "get-api-v1-quotes-quoteid-locations", "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": "7d02774616c2", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "fd289e0b751d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationGetDtoIEnumerableIApiResponse" }, "example": { "data": [ { "buildings": [ { "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "id": 1, "propertyDeductible": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "responseId": "f32b95309b2b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "a6dfa728daa7", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/locations/{locationId}": { "patch": { "tags": [ "Location" ], "summary": "Update location", "description": "Updates existing location information on a quote", "operationId": "patch-api-v1-quotes-quoteid-locations-locationid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "items": { "$ref": "#/components/schemas/JsonPatchDocument" } }, "example": [ { "value": "800 Superior Ave", "path": "/line1", "op": "replace" }, { "value": "Suit A", "path": "/line2", "op": "replace" }, { "value": "OH", "path": "/territory", "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": "4a7bd0034b48", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "53b4b573a74a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationPatchResponseDtoIApiResponse" }, "example": { "data": { "id": 1, "propertyDeductible": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "responseId": "7558a28c540e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "d3438e597e07", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "30016deaaa46", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/locations/{locationId}/buildings/{buildingId}": { "patch": { "tags": [ "Location" ], "summary": "Update building", "description": "Updates existing building information under a specific location, on a quote", "operationId": "patch-api-v1-quotes-quoteid-locations-locationid-buildings-buildingid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "buildingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "items": { "$ref": "#/components/schemas/JsonPatchDocument" } }, "example": [ { "value": "10000", "path": "/annualSales", "op": "replace" }, { "value": "39262", "path": "/classCode/classCodeId", "op": "replace" }, { "value": "60999", "path": "/classCode/classCode", "op": "replace" }, { "value": "01", "path": "/classCode/classDescriptionCode", "op": "replace" }, { "value": "1000", "path": "/classCode/personalPropertyCoverage/coverageLimit", "op": "replace" }, { "value": "5000", "path": "/classCode/buildingCoverage/coverageLimit", "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": "6e13ed56fc0d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "3556faf809af", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchBuildingResponseV1IApiResponse" }, "example": { "data": { "premiumDetails": { "priceIndication": 0, "generalLiabilityLimits": "100/500", "medicalPayments": "1000", "damagesToPremisesLiabilityLimit": "500", "businessPersonalProperty": "100", "propertyDeductible": "400", "expansionEndorsement": "Basic" }, "id": 1, "classCode": { "classCodeId": null, "classCode": "60999", "classDescriptionCode": "01", "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": null, "highestStoryOccupied": null }, "responseId": "9832be4f0495", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "43634f7e62a5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "5dc50def78ab", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote information", "description": "Returns all currently saved quote information", "operationId": "get-api-v1-quotes-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": "0f04770c5af9", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "24a53fede95c", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuoteDtoIApiResponse" }, "example": { "data": { "locations": [ { "buildings": [ { "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "id": 1, "propertyDeductible": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "accountInformation": { "quoteId": 1234567, "masterAccountId": 24786342 }, "premiumDetails": { "taxes": 0, "totalPremium": 1500.55, "totalCost": 0 }, "fein": "234567823", "businessName": "Super Great Developers", "primaryContactInformation": { "name": "Steve Everyman", "phoneNumber": "8001234567", "email": "Steve.Everyman@GreatDevs.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "agentContactId": 123, "agentContactName": "Bill Gates", "legalEntity": "Partnership", "eligibility": "Eligible", "eligibilityReasons": null, "hasTerrorismCoverage": true, "companyWebsite": "www.company.web.site.amtrust" }, "responseId": "badcbb6e65b9", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "a1ba25139b76", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } }, "patch": { "tags": [ "Quotes" ], "summary": "Update quote information", "description": "Updates basic insured level information on quote", "operationId": "patch-api-v1-quotes-quoteid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "minimum": 1.0, "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "items": { "$ref": "#/components/schemas/JsonPatchDocument" } }, "example": [ { "value": "800 Superior Ave", "path": "/mailingAddress/line1", "op": "replace" }, { "value": "Suit A", "path": "/mailingAddress/line2", "op": "replace" }, { "value": "Cleveland", "path": "/mailingAddress/city", "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": "27b32e84c8d2", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "2dd0c08d3849", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchQuoteDtoIApiResponse" }, "example": { "data": { "premiumDetails": { "taxes": 0, "totalPremium": 1500.55, "totalCost": 0 }, "locations": [ { "buildings": [ { "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "id": 1, "propertyDeductible": null, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "companyWebsite": "www.company.web.site.eu", "digitalClientWorkflow": "DigitalClientWorkflow", "accountInformation": { "quoteId": 1234567, "masterAccountId": 24786342 }, "fein": "234567823", "businessName": "Super Great Developers", "primaryContactInformation": { "name": "Steve Everyman", "phoneNumber": "8001234567", "email": "Steve.Everyman@GreatDevs.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "agentContactId": 123, "legalEntity": "Partnership" }, "responseId": "f5c0edd10393", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "11cbad15dd86", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "06b20002ec8b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } }, "put": { "tags": [ "Quotes" ], "summary": "Update quote information.", "description": "Updates information on an existing quote.

\r\n __Please Note:__ entire existing quote body must be included, \r\n and any desired additonal/updated information should be added/changed within the body. \r\n If information is omitted, it will be deleted.", "operationId": "put-api-v1-quotes-quoteid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "minimum": 1.0, "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/QuoteRatePutRequest" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "masterAccountId": 0, "numberOfEmployees": 0, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string", "lessorLiability": true, "propertyDeductible": "string", "classCode": { "classCodeId": 0, "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteRatePutRequest" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "masterAccountId": 0, "numberOfEmployees": 0, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string", "lessorLiability": true, "propertyDeductible": "string", "classCode": { "classCodeId": 0, "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteRatePutRequest" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "masterAccountId": 0, "numberOfEmployees": 0, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string", "lessorLiability": true, "propertyDeductible": "string", "classCode": { "classCodeId": 0, "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuoteRatePutRequest" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "masterAccountId": 0, "numberOfEmployees": 0, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string", "lessorLiability": true, "propertyDeductible": "string", "classCode": { "classCodeId": 0, "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "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": "2abeee3cdb5c", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "2ad5cf27519f", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostQuoteRateDtoV3IApiResponse" }, "example": { "data": { "lessorLiability": false, "status": "NotSubmitted", "premiumDetails": { "totalCost": 500, "taxes": 0, "priceIndication": 0, "generalLiabilityLimits": "100/500", "medicalPayments": "1000", "damagesToPremisesLiabilityLimit": "500", "businessPersonalProperty": "100", "propertyDeductible": "400", "expansionEndorsement": "Basic" }, "roofType": "ClayTiles", "highestStoryOccupied": 1, "digitalClientWorkflow": "DigitalClientWorkflow", "accountInformation": { "quoteId": 1235677, "masterAccountId": 23543456 }, "businessName": "Stark Inc", "primaryContactInformation": { "name": "John Dou", "phoneNumber": "5559991234", "email": "john@test.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "locations": [ { "id": 1, "propertyDeductible": "$250", "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "fein": "123456789", "agentContact": { "id": 8, "name": "Mike Jordan" }, "eligibility": "Eligible", "eligibilityReasons": null, "legalEntity": "Individual", "companyWebsite": "stark-company.com", "classCode": { "classCodeId": null, "classCode": "8838", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 2000, "annualPayroll": null, "numberOfEmployees": null, "construction": { "categoryCode": 1, "categoryName": "Frame" }, "totalSquareFootage": 1500, "totalSquareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": { "yearRoofUpdated": 2019, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2019, "yearHeatingUpdated": 2019, "yearBuilt": 2012 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "hasTerrorismCoverage": true }, "responseId": "478dc52749a5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "979a42ffe33d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/rate": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote premium information", "description": "Returns premium information on quote passed", "operationId": "get-api-v1-quotes-quoteid-rate", "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": "4e9e222d5efd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "e5045eeb0042", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRateDtoIApiResponse" }, "example": { "data": { "taxes": 0, "totalPremium": 1500.55, "totalCost": 0 }, "responseId": "9efdadc7d503", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "39003473dcce", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/reference-resources/class-codes": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve class code information", "description": "This endpoint allows user to retrieve class code information based on query information below:
\r\n
- If no state/class code passed, endpoint will return all class codes, with information necessary to understand any state limitations that exist
\r\n
- If state is passed, endpoint will return only the class codes that are available in that specific state
\r\n
- If state and class code is passed, endpoint will return only that class code
", "operationId": "get-api-v1-reference-resources-class-codes", "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "classCode", "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": "03f174f03bf4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassCodeDtoIEnumerableIApiResponse" }, "example": { "data": [ { "stateLimitation": "All states not WA", "classCodeId": 5, "classCode": "65121", "classDescriptionCode": null, "description": "Accounting Services - Office - CPAs", "naics": "541211", "sic": "8721", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": false }, { "stateLimitation": "WA only", "classCodeId": 27, "classCode": "50141", "classDescriptionCode": null, "description": "Bakeries - Distributors - No baking on premises", "naics": "422490", "sic": "5149", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": false }, { "stateLimitation": "WA only", "classCodeId": 192, "classCode": "33018", "classDescriptionCode": null, "description": "Fruits and Vegetables - no seasonal operations", "naics": "445110", "sic": "5411", "requiresPersonalPropertyCoverage": true, "requiresBuildingCoverage": false } ], "responseId": "b7d9e462da15", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "SUCCESS", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/underwriting-questions": { "get": { "tags": [ "Underwriting Questions" ], "summary": "Retrieve quote’s underwriting questions", "description": "Returns all underwriting questions applicable to quote passed", "operationId": "get-api-v1-quotes-quoteid-underwriting-questions", "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": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "b3d10d5016f1", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "b3d10d5016f1", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "b3d10d5016f1", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "451859c32325", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "451859c32325", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "451859c32325", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDtoIEnumerableIApiResponse" }, "example": { "data": [ { "answer": "Yes", "requirementConditions": null, "questionId": "Bop-59999.2-2", "questionType": "Radio", "text": "Does applicant have sub-contractors that perform installation or repair?", "potentialResponses": [ "Yes", "No" ], "childQuestions": [ { "answer": "No", "requirementConditions": { "conditions": [ { "qualifyingParentAnswer": "Yes", "qualifyingOperator": "=" } ] }, "questionId": "Bop-59999.2-3", "questionType": "Radio", "text": "Is cost of sub-contracting work greater than 25% of annual gross sales?", "potentialResponses": [ "Yes", "No" ], "childQuestions": null } ] } ], "responseId": "b1f3ec92764e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDtoIEnumerableIApiResponse" }, "example": { "data": [ { "answer": "Yes", "requirementConditions": null, "questionId": "Bop-59999.2-2", "questionType": "Radio", "text": "Does applicant have sub-contractors that perform installation or repair?", "potentialResponses": [ "Yes", "No" ], "childQuestions": [ { "answer": "No", "requirementConditions": { "conditions": [ { "qualifyingParentAnswer": "Yes", "qualifyingOperator": "=" } ] }, "questionId": "Bop-59999.2-3", "questionType": "Radio", "text": "Is cost of sub-contracting work greater than 25% of annual gross sales?", "potentialResponses": [ "Yes", "No" ], "childQuestions": null } ] } ], "responseId": "b1f3ec92764e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDtoIEnumerableIApiResponse" }, "example": { "data": [ { "answer": "Yes", "requirementConditions": null, "questionId": "Bop-59999.2-2", "questionType": "Radio", "text": "Does applicant have sub-contractors that perform installation or repair?", "potentialResponses": [ "Yes", "No" ], "childQuestions": [ { "answer": "No", "requirementConditions": { "conditions": [ { "qualifyingParentAnswer": "Yes", "qualifyingOperator": "=" } ] }, "questionId": "Bop-59999.2-3", "questionType": "Radio", "text": "Is cost of sub-contracting work greater than 25% of annual gross sales?", "potentialResponses": [ "Yes", "No" ], "childQuestions": null } ] } ], "responseId": "b1f3ec92764e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "ab4b4538ea63", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "ab4b4538ea63", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "ab4b4538ea63", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } }, "post": { "tags": [ "Underwriting Questions" ], "summary": "Save quote’s underwriting question answers", "description": "Saves answers to underwriting questions applicable to the quote", "operationId": "post-api-v1-quotes-quoteid-underwriting-questions", "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/AddUnderwritingQuestionAnswerDto" } }, "example": [ { "questionId": "Bop-59999.2-1", "answer": "No" }, { "questionId": "Bop-59999.2-2", "answer": "Yes" }, { "questionId": "Bop-59999.2-3", "answer": "No" }, { "questionId": "Bop-59999.2-4", "answer": "Yes" }, { "questionId": "Bop-59999.2-5", "answer": "No" } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddUnderwritingQuestionAnswerDto" } }, "example": [ { "questionId": "Bop-59999.2-1", "answer": "No" }, { "questionId": "Bop-59999.2-2", "answer": "Yes" }, { "questionId": "Bop-59999.2-3", "answer": "No" }, { "questionId": "Bop-59999.2-4", "answer": "Yes" }, { "questionId": "Bop-59999.2-5", "answer": "No" } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddUnderwritingQuestionAnswerDto" } }, "example": [ { "questionId": "Bop-59999.2-1", "answer": "No" }, { "questionId": "Bop-59999.2-2", "answer": "Yes" }, { "questionId": "Bop-59999.2-3", "answer": "No" }, { "questionId": "Bop-59999.2-4", "answer": "Yes" }, { "questionId": "Bop-59999.2-5", "answer": "No" } ] }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddUnderwritingQuestionAnswerDto" } }, "example": [ { "questionId": "Bop-59999.2-1", "answer": "No" }, { "questionId": "Bop-59999.2-2", "answer": "Yes" }, { "questionId": "Bop-59999.2-3", "answer": "No" }, { "questionId": "Bop-59999.2-4", "answer": "Yes" }, { "questionId": "Bop-59999.2-5", "answer": "No" } ] } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "4ff29e032d19", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "4ff29e032d19", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "4ff29e032d19", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "e6829db7e126", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "e6829db7e126", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "e6829db7e126", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "97c63f731b0e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "97c63f731b0e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "97c63f731b0e", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "fc5322beb138", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "fc5322beb138", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "fc5322beb138", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "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-07-23T11:04:43.0000000+00:00", "messages": [ { "httpStatusCode": 200, "messageCode": "SUCCESS", "isOk": true, "detail": "Answers have been successfully saved to the quote" } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/loss-history": { "post": { "tags": [ "Loss History" ], "summary": "Add loss history", "description": "Add loss history", "operationId": "post-api-v1-quotes-quoteid-loss-history", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostRequestDto" }, "example": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": 2 } }, "application/json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostRequestDto" }, "example": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": 2 } }, "text/json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostRequestDto" }, "example": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": 2 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostRequestDto" }, "example": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": 2 } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "f08be4f52bb2", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "f08be4f52bb2", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "f08be4f52bb2", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "a8b7b27ed202", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "a8b7b27ed202", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "a8b7b27ed202", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LossHistoryPostResponseDtoIApiResponse" }, "example": { "data": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": "Single Non-Weather Loss $5,000 - $10,000" }, "responseId": "c7a705da7545", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostResponseDtoIApiResponse" }, "example": { "data": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": "Single Non-Weather Loss $5,000 - $10,000" }, "responseId": "c7a705da7545", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LossHistoryPostResponseDtoIApiResponse" }, "example": { "data": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": false, "lossApplication": "Single Non-Weather Loss $5,000 - $10,000" }, "responseId": "c7a705da7545", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "d4771723643b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "d4771723643b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "d4771723643b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "5d048eadde5b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "5d048eadde5b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "5d048eadde5b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/proposal": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote proposal PDF", "description": "This endpoint will return a byte representation of the quote proposal PDF", "operationId": "get-api-v1-quotes-quoteid-proposal", "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": "64fd6b5448b5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "6be9dfa72e4e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" }, "examples": { "default": { "value": null } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "8037241cdaf9", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "b9413040ae74", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/terrorism-statement": { "post": { "tags": [ "Quotes" ], "summary": "Save Terrorism Coverage Acknowledgement", "description": "This endpoint is meant to be used in conjunction with the (GET) Terrorism Coverage Statement endpoint. Insureds will need to acknowledge that they have read the statement before binding.", "operationId": "post-api-v1-quotes-quoteid-terrorism-statement", "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/PostAcknowledgementDto" }, "example": { "isAcknowledged": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostAcknowledgementDto" }, "example": { "isAcknowledged": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostAcknowledgementDto" }, "example": { "isAcknowledged": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostAcknowledgementDto" }, "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": "38043c39e831", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "03b117a56c6b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIApiResponse" }, "example": { "data": "String", "responseId": "b64a84ea2164", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } } } } }, "/api/v1/reference-resources/terrorism-statement": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve Terrorism Coverage Acknowledgement Statement", "description": "This endpoint is meant to be used in conjunction with the (POST) Terrorism Acknowledgement endpoint. Insureds will need to acknowledge that they have read the statement before binding", "operationId": "get-api-v1-reference-resources-terrorism-statement", "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "aa5f3cf51637", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIApiResponse" }, "example": { "data": "String", "responseId": "f9da7a753496", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } } } } }, "/api/v2/quotes/{quoteId}/locations/{locationId}/buildings": { "post": { "tags": [ "Location" ], "summary": "Save building to location", "description": "Adds building information to specific location, under the quote", "operationId": "post-api-v2-quotes-quoteid-locations-locationid-buildings", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV2" }, "example": { "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV2" }, "example": { "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV2" }, "example": { "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV2" }, "example": { "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "02b4c0a27892", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "0cd3bcc9472b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBuildingResponseV2IApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "fbc77c115f03", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/additional-insured": { "post": { "tags": [ "Quotes" ], "summary": "Add additional insured or interest", "description": "This endpoint allows you to add additional insured or interest information to the quote.", "operationId": "post-api-v1-quotes-quoteid-additional-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/PostAdditionalInsuredRequest" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequest" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequest" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequest" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "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": "d5c5b1fc42a4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "6e3dca5ded0a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredResponseIApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "2948f1655a66", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "9f8eaf0b63ac", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/prior-carrier": { "post": { "tags": [ "Quotes" ], "summary": "Save prior carrier information", "description": "This endpoint allows user to save prior carrier information to the specified quote", "operationId": "post-api-v1-quotes-quoteid-prior-carrier", "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/CarrierRequestDto" }, "example": { "hasPriorCarrier": true, "priorCarrierName": "string", "effectiveDate": "string", "expirationDate": "string", "premium": 0, "claimInformation": [ { "dateOfLoss": "string", "lossDescription": "string", "lossAmount": 0, "policyTermStartYear": 0, "policyTermEndYear": 0, "atFault": true, "claimType": "0 = Liability" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRequestDto" }, "example": { "hasPriorCarrier": true, "priorCarrierName": "string", "effectiveDate": "string", "expirationDate": "string", "premium": 0, "claimInformation": [ { "dateOfLoss": "string", "lossDescription": "string", "lossAmount": 0, "policyTermStartYear": 0, "policyTermEndYear": 0, "atFault": true, "claimType": "0 = Liability" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/CarrierRequestDto" }, "example": { "hasPriorCarrier": true, "priorCarrierName": "string", "effectiveDate": "string", "expirationDate": "string", "premium": 0, "claimInformation": [ { "dateOfLoss": "string", "lossDescription": "string", "lossAmount": 0, "policyTermStartYear": 0, "policyTermEndYear": 0, "atFault": true, "claimType": "0 = Liability" } ] } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CarrierRequestDto" }, "example": { "hasPriorCarrier": true, "priorCarrierName": "string", "effectiveDate": "string", "expirationDate": "string", "premium": 0, "claimInformation": [ { "dateOfLoss": "string", "lossDescription": "string", "lossAmount": 0, "policyTermStartYear": 0, "policyTermEndYear": 0, "atFault": true, "claimType": "0 = Liability" } ] } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "b721b050b038", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "8974e894b5d5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierResponseDtoIApiResponse" }, "example": { "data": { "id": 0, "hasPreviousClaimInLastThreeYears": true, "claimInformation": [ { "claimInfoID": 0, "dateOfLoss": "2026-07-23T11:04:42.0000000+00:00", "lossDescription": "n/a", "lossAmount": 3000, "policyTermStartYear": 2025, "policyTermEndYear": 2027, "atFault": null, "claimType": "Liability" } ], "totalLossesInThreeYears": 0, "totalIncurredinLastThreeYears": 0, "hasPriorCarrier": true, "priorCarrierName": "HammerTech", "effectiveDate": "2026-07-23", "expirationDate": "2026-07-23", "premium": 500000 }, "responseId": "2e532a4e2085", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "367c596c88c9", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/reference-resources/questions": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve class code underwriting questions", "description": "This endpoint allows user to request underwriting questions applicable under a class code/state combination
\r\nPlease note: The response will also include all general questions that have to be answered regardless of class code", "operationId": "get-api-v1-reference-resources-questions-classcodeid-classcodeid-state-state", "parameters": [ { "name": "classCodeId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "state", "in": "query", "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": "dbb71c63d00c", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuestionsDtoIApiResponse" }, "example": { "data": { "generalQuestions": [ { "answer": null, "requirementConditions": null, "questionId": "1156", "questionType": "Text(Numeric)", "text": "How many years in business?", "potentialResponses": [], "childQuestions": [ { "answer": null, "requirementConditions": { "conditions": [ { "qualifyingParentAnswer": "5", "qualifyingOperator": ">" } ] }, "questionId": "1157", "questionType": "Radio", "text": "Does the applicant have less than 3 years of recent experience as the owner or general manager in this or a similar operation of the same size and type?", "potentialResponses": [ "Yes", "No" ], "childQuestions": null } ] } ], "classCodeQuestions": [ { "answer": null, "requirementConditions": null, "questionId": "1352", "questionType": "Radio", "text": "Are all tenants required by their lease to carry insurance and list the owner (our insured) as an Additional Insured?", "potentialResponses": [ "Yes", "No" ], "childQuestions": null } ] }, "responseId": "1b406deaca32", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "SUCCESS", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/reference-resources/all-questions": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve all underwriting questions", "description": "This endpoint will return all underwriting questions required for every class code. The general questions, that are required for every quote regardless of class code, will also be returned.", "operationId": "get-api-v1-reference-resources-all-questions", "parameters": [ { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "effectiveDate", "in": "query", "schema": { "pattern": "^\\d{2}-\\d{2}-\\d{4}$", "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": "cfe348e8e5a5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllUwQuestionsDtoIApiResponse" } } } } } } }, "/api/v2/quotes/{quoteId}/locations/{locationId}/buildings/{buildingId}": { "patch": { "tags": [ "Location" ], "summary": "Update building", "description": "Updates existing building information under a specific location, on a quote", "operationId": "patch-api-v2-quotes-quoteid-locations-locationid-buildings-buildingid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "buildingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "items": { "$ref": "#/components/schemas/JsonPatchDocument" } }, "example": [ { "value": "10000", "path": "/annualSales", "op": "replace" }, { "value": "39262", "path": "/classCode/classCodeId", "op": "replace" }, { "value": "60999", "path": "/classCode/classCode", "op": "replace" }, { "value": "01", "path": "/classCode/classDescriptionCode", "op": "replace" }, { "value": "1000", "path": "/classCode/personalPropertyCoverage/coverageLimit", "op": "replace" }, { "value": "5000", "path": "/classCode/buildingCoverage/coverageLimit", "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": "981338ce63f4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "04531baa8fef", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchBuildingResponseV2IApiResponse" }, "example": { "data": { "lessorLiability": true, "premiumDetails": { "priceIndication": 0, "generalLiabilityLimits": "100/500", "medicalPayments": "1000", "damagesToPremisesLiabilityLimit": "500", "businessPersonalProperty": "100", "propertyDeductible": "400", "expansionEndorsement": "Basic" }, "id": 1, "classCode": { "classCodeId": null, "classCode": "60999", "classDescriptionCode": "01", "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": null, "highestStoryOccupied": null }, "responseId": "1f1c9c5985b5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "460528ef66ba", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "512b568864c1", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/quotes/{quoteId}": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote information", "description": "Returns all currently saved quote information", "operationId": "get-api-v2-quotes-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": "c49cb3763c9e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "b6c3da01a568", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuoteDtoV3IApiResponse" }, "example": { "data": { "locations": [ { "buildings": [ { "lessorLiability": true, "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "propertyDeductible": "100", "id": 1, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "WA", "postalCode": "44114" } ], "status": "NotSubmitted", "accountInformation": { "quoteId": 1234567, "masterAccountId": 24786342 }, "premiumDetails": { "taxes": 150, "totalPremium": 1500, "totalCost": 1650 }, "fein": "234567823", "businessName": "Super Great Developers", "primaryContactInformation": { "name": "Steve Everyman", "phoneNumber": "8001234567", "email": "Steve.Everyman@GreatDevs.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "agentContactId": 123, "agentContactName": "Bill Gates", "legalEntity": "Partnership", "eligibility": "Eligible", "eligibilityReasons": null, "hasTerrorismCoverage": false, "companyWebsite": "www.company.web.site.amtrust", "additionalInsureds": [ { "id": 1, "formName": 0, "name": "John Doe", "locationNumber": 1, "typeOfRisk": 1, "additionalInsuredType": "string", "buildingIds": [ 1 ], "commonOwnership": false, "address": { "line1": "123 Fake Street", "line2": null, "city": "Seattle", "territory": "WA", "postalCode": "98101" } } ] }, "responseId": "d3cd59c0e528", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "dba92f77c038", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/reference-resources/class-codes/{state}": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve All Class Codes in a State", "description": "This endpoint will provide all class codes available in a specific state", "operationId": "get-api-v2-reference-resources-class-codes-state", "parameters": [ { "name": "state", "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": "689bc2165655", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassCodeBaseDtoIEnumerableIApiResponse" }, "example": { "data": [ { "classCodeId": 5, "classCode": "65121", "classDescriptionCode": null, "description": "Accounting Services - Office - CPAs", "naics": "541211", "sic": "8721", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": false }, { "classCodeId": 27, "classCode": "50141", "classDescriptionCode": null, "description": "Bakeries - Distributors - No baking on premises", "naics": "422490", "sic": "5149", "requiresPersonalPropertyCoverage": true, "requiresBuildingCoverage": false }, { "classCodeId": 192, "classCode": "33018", "classDescriptionCode": null, "description": "Fruits and Vegetables - no seasonal operations", "naics": "445110", "sic": "5411", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": true } ], "responseId": "70df8f314551", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "SUCCESS", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/payment-plans": { "get": { "tags": [ "Payment Plans" ], "summary": "GET Payment Plans", "description": "Retrieve all payment plans available to quote", "operationId": "get-api-v1-quotes-quoteid-payment-plans", "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": "8a19329b4d6a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "125f704d4987", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPlanResponseIApiResponse" }, "example": { "data": { "agency": [ { "paymentPlanId": 1, "paymentPlanDescription": "Standard Payment In Full", "billType": null }, { "paymentPlanId": 38, "paymentPlanDescription": "Standard Payment 50% Down + 1 Installment", "billType": null } ], "direct": [ { "paymentPlanId": 13, "paymentPlanDescription": "Standard Payment In Full", "billType": null }, { "paymentPlanId": 39, "paymentPlanDescription": "Standard Payment 50% Down + 1 Installment", "billType": null } ] }, "responseId": "7fe207b5cd8e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "1e734db74b37", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } }, "post": { "tags": [ "Payment Plans" ], "summary": "Saves selected payment plan to the specific quote", "description": "Saves selected payment plan to the specific quote", "operationId": "post-api-v1-quotes-quoteid-payment-plans", "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/CreatePaymentPlanRequest" }, "example": { "paymentPlanId": 0 } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentPlanRequest" }, "example": { "paymentPlanId": 0 } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentPlanRequest" }, "example": { "paymentPlanId": 0 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePaymentPlanRequest" }, "example": { "paymentPlanId": 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": "7bcc02d3c79d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "51358779da79", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentPlanPostResponseIApiResponse" }, "example": { "responseId": "4dfe151fb54a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true }, { "httpStatusCode": 200, "messageCode": "SUCCESS", "title": "Payment plan successfully saved", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "9c7c223be4d6", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/documents": { "post": { "tags": [ "Document" ], "summary": "Upload Documentation for Review", "description": " Allows users to upload any supporting documentation that the Underwriter may need when reviewing the quote.", "operationId": "post-api-v1-quotes-quoteid-documents", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostFileModel" }, "example": { "windowsFileType": "pdf", "fileData": "UDtD4Yy1qkCIR5Lt3TAujQ==", "displayName": "Document" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostFileModel" }, "example": { "windowsFileType": "pdf", "fileData": "UDtD4Yy1qkCIR5Lt3TAujQ==", "displayName": "Document" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostFileModel" }, "example": { "windowsFileType": "pdf", "fileData": "UDtD4Yy1qkCIR5Lt3TAujQ==", "displayName": "Document" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostFileModel" }, "example": { "windowsFileType": "pdf", "fileData": "UDtD4Yy1qkCIR5Lt3TAujQ==", "displayName": "Document" } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "4f5a3e1769ce", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "5adf2f31e460", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadFileResponseDtoIApiResponse" }, "example": { "data": { "libraryId": 123 }, "responseId": "9d5402f17f17", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "6b6cd3430616", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/quotes/{quoteId}/locations": { "get": { "tags": [ "Location" ], "summary": "Retrieve locations", "description": "Returns all currently saved locations on the quote passed, along with any class codes saved to that location", "operationId": "get-api-v2-quotes-quoteid-locations", "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": "3439762cd06b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "d48c4ab16b3b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationGetDtoV2IEnumerableIApiResponse" }, "example": { "data": [ { "buildings": [ { "lessorLiability": true, "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "propertyDeductible": null, "id": 1, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "responseId": "2530ac565b29", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "83ef91f42692", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v3/quotes/{quoteId}/locations/{locationId}/buildings": { "post": { "tags": [ "Location" ], "summary": "Save building to location", "description": "Adds building information to specific location, under the quote", "operationId": "post-api-v3-quotes-quoteid-locations-locationid-buildings", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "locationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV3" }, "example": { "lessorLiability": null, "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV3" }, "example": { "lessorLiability": null, "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV3" }, "example": { "lessorLiability": null, "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostBuildingRequestV3" }, "example": { "lessorLiability": null, "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "classCode": { "classCodeId": 1101, "classCode": null, "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "ec5d9681b441", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "8e1458b4ab09", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostBuildingResponseV3IApiResponse" }, "example": { "data": { "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "classCodeSuffix": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "AsphaltShingles", "highestStoryOccupied": 1, "lessorLiability": true, "premiumDetails": { "priceIndication": 0, "generalLiabilityLimits": "100/500", "medicalPayments": "1000", "damagesToPremisesLiabilityLimit": "500", "businessPersonalProperty": "100", "propertyDeductible": "400", "expansionEndorsement": "Basic" } }, "responseId": "563e17c30aee", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "b2f6b54f0c84", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/bind/agent-contact/{agentContactId}": { "post": { "tags": [ "Bind" ], "summary": "Bind Quote", "description": "THIS ENDPOINT IS ONLY AVAILABLE FOR INTERNAL TESTING PURPOSES. PLEASE DO NOT USE THIS ENDPOINT.", "operationId": "post-api-v1-quotes-quoteid-bind-agent-contact-agentcontactid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "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": "006abf5210db", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "387f9c1ae5bb", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BindResponseIApiResponse" }, "example": { "data": { "quoteID": 1234567, "policyId": 123489, "policy": "RC3207103", "effectiveDate": "2026-07-23", "annualPremium": 1234 }, "responseId": "3cf988586fc7", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "fc24a87d1045", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policy}/payment-plans/direct-debit": { "post": { "tags": [ "Payment Plans" ], "summary": "Save Direct Debit Information", "description": "Allows user to save their bank account information for direct debit payments", "operationId": "post-api-v1-policies-policy-payment-plans-direct-debit", "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", "routingNumber": "011111037", "accountNumber": "123453211111", "email": "business@email.com", "accountType": "1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitRequest" }, "example": { "nameOnAccount": "Business Bank Account", "routingNumber": "011111037", "accountNumber": "123453211111", "email": "business@email.com", "accountType": "1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitRequest" }, "example": { "nameOnAccount": "Business Bank Account", "routingNumber": "011111037", "accountNumber": "123453211111", "email": "business@email.com", "accountType": "1" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitRequest" }, "example": { "nameOnAccount": "Business Bank Account", "routingNumber": "011111037", "accountNumber": "123453211111", "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": "b714c7e0ed79", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "df328cb02806", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitResponseIApiResponse" }, "example": { "data": { "nameOnAccount": "Business Bank Account", "accountNumber": "123453211111", "routingNumber": "011111037", "email": "business@email.com", "accountType": 1, "bankName": "Bank name" }, "responseId": "81be133692bd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "090a1729b42d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "1d629a02c67e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policy}/PaymentPlans/DirectDebit/Documents": { "post": { "tags": [ "Payment Plans" ], "summary": "Upload Direct Debit Documents", "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-v1-policies-policy-paymentplans-directdebit-documents", "parameters": [ { "name": "policy", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitDocRequest" }, "example": { "displayName": "string", "windowsFileType": "string", "fileData": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitDocRequest" }, "example": { "displayName": "string", "windowsFileType": "string", "fileData": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitDocRequest" }, "example": { "displayName": "string", "windowsFileType": "string", "fileData": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitDocRequest" }, "example": { "displayName": "string", "windowsFileType": "string", "fileData": "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": "f9c4b86f48bb", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "551bf05ca3f4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostDirectDebitDocResponseIApiResponse" }, "example": { "data": { "libraryId": 123456 }, "responseId": "73e38c4dc73c", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true }, { "httpStatusCode": 200, "detail": "Documentation Saved", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/terms-of-agreement": { "get": { "tags": [ "Terms of Agreement" ], "summary": "Retrieve 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. Endpoint Summary: Retrieve Terms of Agreement Statement", "operationId": "get-api-v1-terms-of-agreement", "parameters": [ { "name": "api-version", "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": "e60be2ece3bf", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "0beec75dd605", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" }, "example": "string" } } } } } }, "/api/v1/terms-of-agreement/{quoteId}": { "post": { "tags": [ "Terms of Agreement" ], "summary": "Save Terms of Agreement acknowledgement", "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-terms-of-agreement-quoteid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "api-version", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TermsOfAgreementRequest" }, "example": { "isAcknowledged": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfAgreementRequest" }, "example": { "isAcknowledged": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/TermsOfAgreementRequest" }, "example": { "isAcknowledged": true } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TermsOfAgreementRequest" }, "example": { "isAcknowledged": true } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "39a17716af90", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "3c83b5d21167", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfAgreementDtoApiResponse" }, "examples": { "True": { "value": { "data": { "isAcknowledged": true }, "responseId": "01a28a8f053a", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "detail": "Acknowledgement saved successfully!", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } }, "False": { "value": { "data": { "isAcknowledged": false }, "responseId": "ef2b9ac5425f", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "detail": "Disclosure must be acknowledged before quote can be bound", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "88c93ab314e7", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "6afc68ae9755", "timeStamp": "2026-07-23T11:04:43.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/{quoteId}/eligibility": { "get": { "tags": [ "Quotes" ], "summary": "Get eligibility information", "description": "Get eligibility information", "operationId": "get-api-v1-quotes-quoteid-eligibility", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "minimum": 1.0, "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "2e282feea3f3", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "260b73c27386", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEligibilityResponseDtoIApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "61c0df17bbdc", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "5feefdea290a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/quotes/{quoteId}/rate": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote premium information", "description": "Returns premium information on quote passed", "operationId": "get-api-v2-quotes-quoteid-rate", "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": "ea9e1f1976bd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "af7cd4ce00aa", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRateDtoIApiResponse" }, "example": { "data": { "taxes": 0, "totalPremium": 1500.55, "totalCost": 0 }, "responseId": "a79b112c554d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "8b86c59bcc92", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v3/quotes/{quoteId}": { "get": { "tags": [ "Quotes" ], "summary": "Retrieve quote information", "description": "Returns all currently saved quote information", "operationId": "get-api-v3-quotes-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": "1e1ff4c8664d", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "c229b25b8456", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQuoteDtoV3IApiResponse" }, "example": { "data": { "locations": [ { "buildings": [ { "lessorLiability": true, "id": 1, "classCode": { "classCodeId": null, "classCode": "11011", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 10000, "annualPayroll": null, "numberOfEmployees": null, "constructionCategoryCode": 1, "totalSquareFootage": 1500, "squareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": 1959, "yearRoofUpdated": 2020, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2018, "yearHeatingUpdated": 2019, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": false, "isSprinkleredBuilding": true, "roofType": "ClayTiles", "highestStoryOccupied": 3 } ], "propertyDeductible": "100", "id": 1, "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "WA", "postalCode": "44114" } ], "status": "NotSubmitted", "accountInformation": { "quoteId": 1234567, "masterAccountId": 24786342 }, "premiumDetails": { "taxes": 150, "totalPremium": 1500, "totalCost": 1650 }, "fein": "234567823", "businessName": "Super Great Developers", "primaryContactInformation": { "name": "Steve Everyman", "phoneNumber": "8001234567", "email": "Steve.Everyman@GreatDevs.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "agentContactId": 123, "agentContactName": "Bill Gates", "legalEntity": "Partnership", "eligibility": "Eligible", "eligibilityReasons": null, "hasTerrorismCoverage": false, "companyWebsite": "www.company.web.site.amtrust", "additionalInsureds": [ { "id": 1, "formName": 0, "name": "John Doe", "locationNumber": 1, "typeOfRisk": 1, "additionalInsuredType": "string", "buildingIds": [ 1 ], "commonOwnership": false, "address": { "line1": "123 Fake Street", "line2": null, "city": "Seattle", "territory": "WA", "postalCode": "98101" } } ] }, "responseId": "032eb9067ed6", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "0736b962ebe6", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/quotes/rate": { "post": { "tags": [ "Quotes" ], "summary": "Create rated quote", "description": "This endpoint takes in all information necessary to return a quote and price indication", "operationId": "post-api-v1-quotes-rate", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/QuoteRatePostRequestV1" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "lessorLiability": true, "propertyDeductible": "string", "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string", "classCode": { "classCodeId": 0, "classCode": "string", "classDescriptionCode": "string", "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "annualPayroll": 0, "numberOfEmployees": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "masterAccountId": 0, "newMasterAccountId": true, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string" } }, "application/json": { "schema": { "$ref": "#/components/schemas/QuoteRatePostRequestV1" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "lessorLiability": true, "propertyDeductible": "string", "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string", "classCode": { "classCodeId": 0, "classCode": "string", "classDescriptionCode": "string", "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "annualPayroll": 0, "numberOfEmployees": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "masterAccountId": 0, "newMasterAccountId": true, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string" } }, "text/json": { "schema": { "$ref": "#/components/schemas/QuoteRatePostRequestV1" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "lessorLiability": true, "propertyDeductible": "string", "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string", "classCode": { "classCodeId": 0, "classCode": "string", "classDescriptionCode": "string", "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "annualPayroll": 0, "numberOfEmployees": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "masterAccountId": 0, "newMasterAccountId": true, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "string" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/QuoteRatePostRequestV1" }, "example": { "skipUWQuestions": true, "expandedResponse": true, "skipRate": true, "skipEval": true, "dba": "string", "lessorLiability": true, "propertyDeductible": "string", "roofType": "string", "highestStoryOccupied": 0, "digitalClientWorkflow": "string", "classCode": { "classCodeId": 0, "classCode": "string", "classDescriptionCode": "string", "personalPropertyCoverage": { "coverageLimit": 0, "valuation": "string" }, "buildingCoverage": { "coverageLimit": 0, "valuation": "string" } }, "annualSales": 0, "annualPayroll": 0, "numberOfEmployees": 0, "constructionCategoryCode": 0, "totalSquareFootage": 0, "totalSquareFootageOccupied": 0, "totalStories": 0, "yearBuilt": { "yearBuilt": 0, "yearRoofUpdated": 0, "yearElectricalUpdated": 0, "yearPlumbingUpdated": 0, "yearHeatingUpdated": 0 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "underwritingQuestions": [ { "questionId": "string", "answer": "string" } ], "lossHistory": { "hasPriorCarrier": true, "hasZeroClaimsInLastThreeYears": true, "lossApplication": 0, "premium": 0 }, "masterAccountId": 0, "newMasterAccountId": true, "businessName": "string", "fein": "string", "primaryContactInformation": { "name": "string", "phoneNumber": "string", "email": "string" }, "primaryAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "mailingAddress": { "line1": "string", "line2": "string", "city": "string", "territory": "string", "postalCode": "string" }, "effectiveDate": "string", "agentContactId": 0, "legalEntity": "string", "companyWebsite": "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": "1485b858aad1", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "aceb2b705189", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostQuoteRateDtoV3IApiResponse" }, "example": { "data": { "lessorLiability": false, "status": "NotSubmitted", "premiumDetails": { "totalCost": 500, "taxes": 0, "priceIndication": 0, "generalLiabilityLimits": "100/500", "medicalPayments": "1000", "damagesToPremisesLiabilityLimit": "500", "businessPersonalProperty": "100", "propertyDeductible": "400", "expansionEndorsement": "Basic" }, "roofType": "ClayTiles", "highestStoryOccupied": 1, "digitalClientWorkflow": "DigitalClientWorkflow", "accountInformation": { "quoteId": 1235677, "masterAccountId": 23543456 }, "businessName": "Stark Inc", "primaryContactInformation": { "name": "John Dou", "phoneNumber": "5559991234", "email": "john@test.com" }, "primaryAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "mailingAddress": { "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" }, "effectiveDate": "2026-07-25", "locations": [ { "id": 1, "propertyDeductible": "$250", "line1": "800 Superior Ave", "line2": "Suit A", "city": "Cleveland", "territory": "OH", "postalCode": "44114" } ], "fein": "123456789", "agentContact": { "id": 8, "name": "Mike Jordan" }, "eligibility": "Eligible", "eligibilityReasons": null, "legalEntity": "Individual", "companyWebsite": "stark-company.com", "classCode": { "classCodeId": null, "classCode": "8838", "classDescriptionCode": null, "personalPropertyCoverage": { "coverageLimit": 1000, "valuation": "Replacement Cost" }, "buildingCoverage": { "coverageLimit": 2000, "valuation": "Actual Cash Value" } }, "annualSales": 2000, "annualPayroll": null, "numberOfEmployees": null, "construction": { "categoryCode": 1, "categoryName": "Frame" }, "totalSquareFootage": 1500, "totalSquareFootageOccupied": 1200, "totalStories": 13, "yearBuilt": { "yearRoofUpdated": 2019, "yearElectricalUpdated": 2019, "yearPlumbingUpdated": 2019, "yearHeatingUpdated": 2019, "yearBuilt": 2012 }, "hasCentralStationFireAlarm": true, "hasCentralStationBurglarAlarm": true, "isSprinkleredBuilding": true, "hasTerrorismCoverage": true }, "responseId": "81b526691412", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 201, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "Deeplink", "title": "https://devk8s.amtrustgroup.com/usertest/webapp-nexus/AccountManagement/24786342", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "d185294ea3f5", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policyId}/balance-summary": { "get": { "tags": [ "Payments" ], "summary": "Balance-Summary", "description": "Retrieve the current balance on a policy
Please be aware that if \"CanMakePayment\" is false, the current balance will reflect $0.00 Policy.", "operationId": "get-api-v1-policies-policyid-balance-summary", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "173fc390cc2f", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "3dbf7b8e774e", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSummaryResponseIApiResponse" }, "example": { "data": { "quoteId": 12345, "policyId": 6789, "currentDueAmount": 0.3, "remainingDueAmount": 5.7, "canMakePayment": true }, "responseId": "0f3488bf1c64", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "21076e4744e6", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policyId}/payment": { "post": { "tags": [ "Payments" ], "summary": "Make a payment", "description": "This endpoint is used to make a payment on the policy.

\r\n The Balance Summary endpoint can be used to retrieve the current balance on the policy.

\r\n Payment sent must be equal to the current amount due.

\r\n __Please note:__ Payment may take up to 24 hours to reflect on the account", "operationId": "post-api-v1-policies-policyid-payment", "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "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", "line2": "string", "city": "string", "state": "string", "zip": "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", "line2": "string", "city": "string", "state": "string", "zip": "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", "line2": "string", "city": "string", "state": "string", "zip": "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", "line2": "string", "city": "string", "state": "string", "zip": "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": "ec19c0fad678", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "27483277e068", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentResponseIApiResponse" }, "example": { "data": { "amountProcessed": 4554.25, "remainingPolicyPayment": 245.75, "transactionId": "7a6ec09e4016" }, "responseId": "d343bb0b5a46", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "ab833a11acce", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "a51d77449456", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policy}/available-documents": { "get": { "tags": [ "Policy" ], "summary": "All Policy Documents", "description": "Retrieves a list of all available documents that are currently available for viewing under the given policy number.", "operationId": "get-api-v1-policies-policy-available-documents", "parameters": [ { "name": "policy", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "59b057ae5963", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "46ecdf1de56a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyDocumentResponseIEnumerableIApiResponse" }, "example": { "data": [ { "documentName": "Policy Issued", "fileType": "PDF", "documentType": "Policy document", "libraryIndex": 12345, "dateReceived": "File data" } ], "responseId": "6219e9324271", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "f504753ff3a0", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v1/policies/{policy}/binder": { "get": { "tags": [ "Policy" ], "summary": "Policy Binder", "description": "Retrieves the policies Binder document", "operationId": "get-api-v1-policies-policy-binder", "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": "6d3ae9333024", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "ac2ad1b826a7", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIApiResponse" }, "example": { "data": "String", "responseId": "dad276b5e9bd", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "_v": "AD" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "e83f6ab5b469", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/reference-resources/class-codes": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve class code information", "description": "This endpoint will return all available codes in all states", "operationId": "get-api-v2-reference-resources-class-codes", "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "c38e9c1b4938", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassCodeDtoV2IEnumerableIApiResponse" }, "example": { "data": [ { "classDescriptionCode": "00", "classCode": "65121", "description": "Accounting Services - Office - CPAs", "naics": "541211", "sic": "8721", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": false, "stateLimitation": "All states not WA" }, { "classDescriptionCode": "01", "classCode": "50141", "description": "Bakeries - Distributors - No baking on premises", "naics": "422490", "sic": "5149", "requiresPersonalPropertyCoverage": false, "requiresBuildingCoverage": false, "stateLimitation": "WA only" }, { "classDescriptionCode": "02", "classCode": "33018", "description": "Fruits and Vegetables - no seasonal operations", "naics": "445110", "sic": "5411", "requiresPersonalPropertyCoverage": true, "requiresBuildingCoverage": false, "stateLimitation": "WA only" } ], "responseId": "0c25433ee300", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 200, "isOk": true, "messages": [ { "httpStatusCode": 200, "messageCode": "SUCCESS", "isOk": true } ], "maxMessageIndex": 0, "_v": "AD" } } } } } } }, "/api/v3/reference-resources/class-codes/{state}": { "get": { "tags": [ "Reference Resources" ], "summary": "Retrieve All Class Codes in a State", "description": "This endpoint will provide all class codes available in a specific state", "operationId": "get-api-v3-reference-resources-class-codes-state", "parameters": [ { "name": "state", "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": "54e5448f96d0", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassCodeBaseDtoV2IEnumerableIApiResponse" } } } } } } }, "/api/v1/quotes/{quoteId}/additional-insured/{additionalInsuredId}": { "delete": { "tags": [ "Quotes" ], "summary": "Remove additional insured.", "description": "This endpoint allows users to remove an additional insured on the specific quote.", "operationId": "delete-api-v1-quotes-quoteid-additional-insured-additionalinsuredid", "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "minimum": 1.0, "type": "integer", "format": "int32" } }, { "name": "additionalInsuredId", "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": "f6de569ccbd4", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "57de05d41a04", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IApiResponse" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "0bb43264d709", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } }, "/api/v2/quotes/{quoteId}/additional-insured": { "post": { "tags": [ "Quotes" ], "summary": "Add additional insured or interest", "description": "This endpoint allows you to add additional insured or interest information to the quote. If NamedInsured and CommonOwnership are both true we will default the form. For named insured, only values ​​from the AdditionalInsuredName, DBA, CommonOwnership, locationId and buildings fields will be used, all other fields will be ignored.", "operationId": "post-api-v2-quotes-quoteid-additional-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/PostAdditionalInsuredRequestV2" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string", "namedInsured": true, "dba": "string", "commonOwnership": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequestV2" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string", "namedInsured": true, "dba": "string", "commonOwnership": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequestV2" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string", "namedInsured": true, "dba": "string", "commonOwnership": true } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredRequestV2" }, "example": { "form": "0 = Mortgagee", "additionalInsuredName": "string", "propertyDescription": "string", "clause": "0 = NotApplicable", "locationId": 0, "buildings": [ 0 ], "nameOfInsuredPersonOrganization": "string", "leasedEquipmentDescription": "string", "typeOfRisk": "1 = ApartmentAndOffice", "leasedEquipmentLocation": "string", "locationAndDescriptionOfCompletedOperations": "string", "stateOrPoliticalSubdivision": "string", "namedInsured": true, "dba": "string", "commonOwnership": true } } } }, "responses": { "401": { "description": "Bad or expired token. To resolve this error, generate a new or refreshed token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorIApiResponse" }, "example": { "responseId": "a52be490ad7a", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 401, "isOk": false, "errors": [ { "httpStatusCode": 401, "messageCode": "ERR-NOTAUTHORIZED", "title": "Bearer token is not authorized", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "403": { "description": "The authenticated user or client does not have required permissions to complete this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenErrorIApiResponse" }, "example": { "responseId": "3d3b872ac4a3", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 403, "isOk": false, "errors": [ { "httpStatusCode": 403, "messageCode": "ERR-FORBIDDEN", "title": "The token provided does not have permissions for the requested action", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostAdditionalInsuredResponseV2IApiResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorIApiResponse" }, "example": { "responseId": "341367925060", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 400, "isOk": false, "errors": [ { "httpStatusCode": 400, "messageCode": "ERR-ValidationErr", "title": "Validation Error", "detail": "Validation detail message", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorIApiResponse" }, "example": { "responseId": "d2a89556347b", "timeStamp": "2026-07-23T11:04:42.0000000+00:00", "httpStatusCode": 404, "isOk": false, "errors": [ { "httpStatusCode": 404, "messageCode": "ERR-ItemNotFound", "title": "Item was not found", "isOk": false } ], "maxErrorIndex": 0, "_v": "AD" } } } } } } } }, "components": { "schemas": { "AccountInformation": { "type": "object", "properties": { "quoteId": { "type": "integer", "format": "int32" }, "masterAccountId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AddUnderwritingQuestionAnswerDto": { "required": [ "answer", "questionId" ], "type": "object", "properties": { "questionId": { "minLength": 1, "type": "string" }, "answer": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "AdditionalInsuredDto": { "required": [ "form" ], "type": "object", "properties": { "form": { "enum": [ "0 = Mortgagee", "1 = MgrLsrPrem", "2 = MortAssgnRec", "3 = LandLeased", "4 = InsuredPrem", "6 = Designated", "7 = SchedPerson", "8 = LossPayable", "9 = EquipmentLeased", "10 = CompOperation", "11 = Permits", "12 = OtherInsurance", "13 = EXTOFNI" ], "type": "integer", "description": "Short name for Additional Insured Forms\n
Form NameDescription
MortageeBOP MORTGAGEE
MgrLsrPremADDITIONAL INSURED - MANAGERS OR LESSORS OF PREMISES
MortAssgnRecADDITIONAL INSURED - MORTGAGEE, ASSIGNEE OR RECEIVER
LandLeasedADDITIONAL INSURED - OWNERS OR OTHER INTERESTS FROM WHOM LAND HAS BEEN LEASED
InsuredPremADDITIONAL INSURED - CO-OWNER OF INSURED PREMISES
DesignatedADDITIONAL INSURED - DESIGNATED PERSON OR ORGANIZATION
SchedPersonADDITIONAL INSURED - OWNERS, LESSEES OR CONTRACTORS - SCHEDULED PERSON OR ORGANIZATION
LossPayableLOSS PAYABLE PROVISIONS
EquipmentLeasedADDITIONAL INSURED - LESSOR OF LEASED EQUIPMENTS
CompOperationADDITIONAL INSURED OWNERS LESSEES OR CONTRACTORS - COMPLETED OPERATIONS
PermitsADDITIONAL INSURED STATE OR POLITICAL SUBDIVISIONS - PERMITS RELATING TO PREMISES
OtherInsuranceADDITIONAL INSURED - OWNERS, LESSEES, OR CONTRACTORS WITH ADDITIONAL INSURED REQUIREMENT IN CONSTRUCTION CONTRACT PRIMARY AND NON-CONTRIBUTORY-OTHER INSURANCE CONDITION
", "format": "int32" }, "additionalInsuredName": { "type": "string", "nullable": true }, "propertyDescription": { "type": "string", "description": "PropertyDescription - Only required for Mortgagee, Vendor, and LossPayable forms", "nullable": true }, "clause": { "enum": [ "0 = NotApplicable", "1 = A", "2 = B", "3 = C" ], "type": "integer", "description": "Only Applicable for Loss Payable Forms; value will be ignored if submitted for other form types.\n
ClauseDescription
NotApplicable(Default) Clause Description is Not Applicable for Quote
ALoss Payable Clause
BLenders' Loss Payable Clause
CContract of Sale Clause
", "format": "int32" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "buildings": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Building IDs - Only required for Mortgagee, LossPayable, MgrLsrPrem", "nullable": true }, "nameOfInsuredPersonOrganization": { "type": "string", "description": "NameOfInsuredPersonOrganization - Only required for EquipmentLeased and CompOperation forms", "nullable": true }, "leasedEquipmentDescription": { "type": "string", "description": "LeasedEquipmentDescription - Only required for EquipmentLeased form", "nullable": true }, "typeOfRisk": { "enum": [ "1 = ApartmentAndOffice", "2 = AllOther" ], "type": "integer", "description": "TypeOfRisk - Only required for EquipmentLeased form", "format": "int32", "nullable": true }, "leasedEquipmentLocation": { "type": "string", "description": "LeasedEquipmentLocation - Only required for EquipmentLeased form", "nullable": true }, "locationAndDescriptionOfCompletedOperations": { "type": "string", "description": "LocationAndDescriptionOfCompletedOperations - Only required for CompOperation form", "nullable": true }, "stateOrPoliticalSubdivision": { "type": "string", "description": "StateOrPoliticalSubdivision - Only required for Permits form", "nullable": true } }, "additionalProperties": false }, "AdditionalInsuredDtoV2": { "required": [ "form" ], "type": "object", "properties": { "form": { "enum": [ "0 = Mortgagee", "1 = MgrLsrPrem", "2 = MortAssgnRec", "3 = LandLeased", "4 = InsuredPrem", "6 = Designated", "7 = SchedPerson", "8 = LossPayable", "9 = EquipmentLeased", "10 = CompOperation", "11 = Permits", "12 = OtherInsurance", "13 = EXTOFNI" ], "type": "integer", "description": "Short name for Additional Insured Forms\n
Form NameDescription
MortageeBOP MORTGAGEE
MgrLsrPremADDITIONAL INSURED - MANAGERS OR LESSORS OF PREMISES
MortAssgnRecADDITIONAL INSURED - MORTGAGEE, ASSIGNEE OR RECEIVER
LandLeasedADDITIONAL INSURED - OWNERS OR OTHER INTERESTS FROM WHOM LAND HAS BEEN LEASED
InsuredPremADDITIONAL INSURED - CO-OWNER OF INSURED PREMISES
DesignatedADDITIONAL INSURED - DESIGNATED PERSON OR ORGANIZATION
SchedPersonADDITIONAL INSURED - OWNERS, LESSEES OR CONTRACTORS - SCHEDULED PERSON OR ORGANIZATION
LossPayableLOSS PAYABLE PROVISIONS
EquipmentLeasedADDITIONAL INSURED - LESSOR OF LEASED EQUIPMENTS
CompOperationADDITIONAL INSURED OWNERS LESSEES OR CONTRACTORS - COMPLETED OPERATIONS
PermitsADDITIONAL INSURED STATE OR POLITICAL SUBDIVISIONS - PERMITS RELATING TO PREMISES
OtherInsuranceADDITIONAL INSURED - OWNERS, LESSEES, OR CONTRACTORS WITH ADDITIONAL INSURED REQUIREMENT IN CONSTRUCTION CONTRACT PRIMARY AND NON-CONTRIBUTORY-OTHER INSURANCE CONDITION
", "format": "int32" }, "additionalInsuredName": { "type": "string", "description": "The name of the additional insured.", "nullable": true }, "propertyDescription": { "type": "string", "description": "PropertyDescription - Only required for Mortgagee, Vendor, and LossPayable forms", "nullable": true }, "clause": { "enum": [ "0 = NotApplicable", "1 = A", "2 = B", "3 = C" ], "type": "integer", "description": "Only Applicable for Loss Payable Forms; value will be ignored if submitted for other form types.\n
ClauseDescription
NotApplicable(Default) Clause Description is Not Applicable for Quote
ALoss Payable Clause
BLenders' Loss Payable Clause
CContract of Sale Clause
", "format": "int32" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "buildings": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Building IDs - Only required for Mortgagee, LossPayable, MgrLsrPrem", "nullable": true }, "nameOfInsuredPersonOrganization": { "type": "string", "description": "NameOfInsuredPersonOrganization - Only required for EquipmentLeased and CompOperation forms", "nullable": true }, "leasedEquipmentDescription": { "type": "string", "description": "LeasedEquipmentDescription - Only required for EquipmentLeased form", "nullable": true }, "typeOfRisk": { "enum": [ "1 = ApartmentAndOffice", "2 = AllOther" ], "type": "integer", "description": "TypeOfRisk - Only required for EquipmentLeased form", "format": "int32", "nullable": true }, "leasedEquipmentLocation": { "type": "string", "description": "LeasedEquipmentLocation - Only required for EquipmentLeased form", "nullable": true }, "locationAndDescriptionOfCompletedOperations": { "type": "string", "description": "LocationAndDescriptionOfCompletedOperations - Only required for CompOperation form", "nullable": true }, "stateOrPoliticalSubdivision": { "type": "string", "description": "StateOrPoliticalSubdivision - Only required for Permits form", "nullable": true }, "namedInsured": { "type": "boolean", "description": "Indicates whether this is a Named Insured. When true, DBA and CommonOwnership fields are required.\nThe remaining fields will be ignored, and Form field will default to EXTOFNI." }, "dba": { "type": "string", "description": "The DBA (Doing Business As) name. Required when NamedInsured is true.", "nullable": true }, "commonOwnership": { "type": "boolean", "description": "Common Ownership should be selected for entities which share 51% or greater ownership interest. \nTo add an additional named insured common ownership must be TRUE.\nRequired when NamedInsured is true, and must be true to save a Named Insured." } }, "additionalProperties": false }, "AdditionalInsuredGetDtoV2": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "formName": { "enum": [ "0 = Mortgagee", "1 = MgrLsrPrem", "2 = MortAssgnRec", "3 = LandLeased", "4 = InsuredPrem", "6 = Designated", "7 = SchedPerson", "8 = LossPayable", "9 = EquipmentLeased", "10 = CompOperation", "11 = Permits", "12 = OtherInsurance", "13 = EXTOFNI" ], "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "propertyDescription": { "type": "string", "nullable": true }, "locationNumber": { "type": "integer", "format": "int32", "nullable": true }, "typeOfRisk": { "enum": [ "1 = ApartmentAndOffice", "2 = AllOther" ], "type": "integer", "format": "int32", "nullable": true }, "additionalInsuredType": { "type": "string", "nullable": true }, "buildingIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "dba": { "type": "string", "nullable": true }, "commonOwnership": { "type": "boolean" }, "address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false }, "Address": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" } }, "additionalProperties": false }, "AgentContactDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AgentContactDtoIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentContactDto" }, "nullable": true } }, "additionalProperties": false }, "AgentContactShortDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiMessage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "httpStatus": { "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" }, "messageCode": { "type": "string", "nullable": true }, "messageType": { "enum": [ "0 = Info", "1 = Error" ], "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "internal": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "exception": { "$ref": "#/components/schemas/LogException" }, "isOk": { "type": "boolean" }, "needsSanitization": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ApiPageRequest": { "type": "object", "properties": { "skip": { "type": "integer", "format": "int32" }, "take": { "type": "integer", "format": "int32" }, "count": { "type": "boolean" } }, "additionalProperties": false }, "ApiPageResponse": { "type": "object", "properties": { "first": { "type": "string", "nullable": true }, "previous": { "type": "string", "nullable": true }, "current": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true }, "last": { "type": "string", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "count": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ApiPaging": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/ApiPageRequest" }, "response": { "$ref": "#/components/schemas/ApiPageResponse" } }, "additionalProperties": false }, "BadRequestError": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "httpStatus": { "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" }, "messageType": { "enum": [ "0 = Info", "1 = Error" ], "type": "integer", "format": "int32" }, "internal": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "exception": { "$ref": "#/components/schemas/LogException" }, "needsSanitization": { "type": "boolean", "readOnly": true }, "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", "readOnly": true }, "messageCode": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "detail": { "type": "string", "nullable": true, "readOnly": true }, "isOk": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BadRequestErrorIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/BadRequestError" } }, "additionalProperties": false }, "BalanceSummaryResponse": { "type": "object", "properties": { "quoteId": { "type": "integer", "format": "int32" }, "policyId": { "type": "integer", "format": "int32" }, "currentDueAmount": { "type": "number", "format": "double" }, "remainingDueAmount": { "type": "number", "format": "double" }, "canMakePayment": { "type": "boolean" } }, "additionalProperties": false }, "BalanceSummaryResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/BalanceSummaryResponse" } }, "additionalProperties": false }, "BasePaymentAmount": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "total": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BindResponse": { "type": "object", "properties": { "quoteID": { "type": "integer", "format": "int32" }, "policyId": { "type": "integer", "format": "int32" }, "policy": { "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "annualPremium": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BindResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/BindResponse" } }, "additionalProperties": false }, "BuildingResponseDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodeGetDto" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BuildingResponseDtoV2": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodeGetDto" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true }, "lessorLiability": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CarrierRequestDto": { "required": [ "hasPriorCarrier" ], "type": "object", "properties": { "hasPriorCarrier": { "type": "boolean" }, "priorCarrierName": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "nullable": true }, "effectiveDate": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "format": "date-time", "nullable": true }, "expirationDate": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "format": "date-time", "nullable": true }, "premium": { "type": "integer", "description": "Required if HasPriorCarrier set to true.", "format": "int32", "nullable": true }, "claimInformation": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimInfoDto" }, "description": "\nAll claims submitted in the last 3 years.\n\nCannot be sent if HasPriorCarrier is set to false.", "nullable": true } }, "additionalProperties": false }, "CarrierResponseDto": { "required": [ "hasPriorCarrier" ], "type": "object", "properties": { "hasPriorCarrier": { "type": "boolean" }, "priorCarrierName": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "nullable": true }, "effectiveDate": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "format": "date-time", "nullable": true }, "expirationDate": { "type": "string", "description": "Required if HasPriorCarrier set to true.", "format": "date-time", "nullable": true }, "premium": { "type": "integer", "description": "Required if HasPriorCarrier set to true.", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32" }, "hasPreviousClaimInLastThreeYears": { "type": "boolean" }, "claimInformation": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimResponseDto" }, "nullable": true }, "totalLossesInThreeYears": { "type": "integer", "description": "Sum of the number of claims in the last 3 years", "format": "int32" }, "totalIncurredinLastThreeYears": { "type": "integer", "description": "Sum of all the claim loss amounts in the last 3 years", "format": "int32" } }, "additionalProperties": false }, "CarrierResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/CarrierResponseDto" } }, "additionalProperties": false }, "ChildGetUnderwritingQuestionDto": { "type": "object", "properties": { "answer": { "type": "string", "nullable": true }, "questionId": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "potentialResponses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ChildGetUnderwritingQuestionDto" }, "nullable": true }, "requirementConditions": { "$ref": "#/components/schemas/RequirementConditions" } }, "additionalProperties": false }, "ClaimInfoDto": { "required": [ "atFault", "claimType", "dateOfLoss", "policyTermStartYear" ], "type": "object", "properties": { "dateOfLoss": { "type": "string", "description": "\nOnly claims within the last 3 years will be accepted\n\nMust be within PolicyTermStartYear and PolicyTermEndYear\n\nMust be between the EffectiveDate and the ExpirationDate for the Carrier", "format": "date-time" }, "lossDescription": { "type": "string", "nullable": true }, "lossAmount": { "type": "integer", "format": "int32" }, "policyTermStartYear": { "type": "integer", "description": "Must be between the EffectiveDate and the ExpirationDate for the Carrier", "format": "int32" }, "policyTermEndYear": { "type": "integer", "description": "\nMust be a year within the EffectiveDate and the ExpirationDate range for the Carrier\n\nMust be greater than the PolicyTermStartYear\n\nIf unsent, will be defaulted to the current year", "format": "int32" }, "atFault": { "type": "boolean" }, "claimType": { "enum": [ "0 = Liability", "1 = Property" ], "type": "integer", "description": "Must be \"Liability\" or \"Property\"", "format": "int32" } }, "additionalProperties": false }, "ClaimResponseDto": { "required": [ "atFault", "claimType", "dateOfLoss", "policyTermStartYear" ], "type": "object", "properties": { "dateOfLoss": { "type": "string", "description": "\nOnly claims within the last 3 years will be accepted\n\nMust be within PolicyTermStartYear and PolicyTermEndYear\n\nMust be between the EffectiveDate and the ExpirationDate for the Carrier", "format": "date-time" }, "lossDescription": { "type": "string", "nullable": true }, "lossAmount": { "type": "integer", "format": "int32" }, "policyTermStartYear": { "type": "integer", "description": "Must be between the EffectiveDate and the ExpirationDate for the Carrier", "format": "int32" }, "policyTermEndYear": { "type": "integer", "description": "\nMust be a year within the EffectiveDate and the ExpirationDate range for the Carrier\n\nMust be greater than the PolicyTermStartYear\n\nIf unsent, will be defaulted to the current year", "format": "int32" }, "atFault": { "type": "boolean" }, "claimType": { "enum": [ "0 = Liability", "1 = Property" ], "type": "integer", "description": "Must be \"Liability\" or \"Property\"", "format": "int32" }, "claimInfoID": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ClassCodeBaseDto": { "type": "object", "properties": { "classCodeId": { "type": "integer", "format": "int32" }, "classCode": { "type": "string", "nullable": true }, "classDescriptionCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "naics": { "type": "string", "nullable": true }, "sic": { "type": "string", "nullable": true }, "requiresPersonalPropertyCoverage": { "type": "boolean" }, "requiresBuildingCoverage": { "type": "boolean" } }, "additionalProperties": false }, "ClassCodeBaseDtoIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClassCodeBaseDto" }, "nullable": true } }, "additionalProperties": false }, "ClassCodeBaseDtoV2": { "type": "object", "properties": { "classCode": { "type": "string", "nullable": true }, "classDescriptionCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "naics": { "type": "string", "nullable": true }, "sic": { "type": "string", "nullable": true }, "requiresPersonalPropertyCoverage": { "type": "boolean" }, "requiresBuildingCoverage": { "type": "boolean" } }, "additionalProperties": false }, "ClassCodeBaseDtoV2IEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClassCodeBaseDtoV2" }, "nullable": true } }, "additionalProperties": false }, "ClassCodeCoverageGetDto": { "type": "object", "properties": { "coverageLimit": { "type": "integer", "format": "int32", "nullable": true }, "valuation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClassCodeCoveragePostDto": { "required": [ "coverageLimit", "valuation" ], "type": "object", "properties": { "coverageLimit": { "maximum": 999999999.0, "minimum": 0.0, "type": "integer", "format": "int32" }, "valuation": { "minLength": 1, "type": "string", "description": "Replacement Cost
Actual Cash Value" } }, "additionalProperties": false }, "ClassCodeDto": { "type": "object", "properties": { "classCodeId": { "type": "integer", "format": "int32" }, "classCode": { "type": "string", "nullable": true }, "classDescriptionCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "naics": { "type": "string", "nullable": true }, "sic": { "type": "string", "nullable": true }, "requiresPersonalPropertyCoverage": { "type": "boolean" }, "requiresBuildingCoverage": { "type": "boolean" }, "stateLimitation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClassCodeDtoIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClassCodeDto" }, "nullable": true } }, "additionalProperties": false }, "ClassCodeDtoV2": { "type": "object", "properties": { "classDescriptionCode": { "type": "string", "nullable": true }, "classCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "naics": { "type": "string", "nullable": true }, "sic": { "type": "string", "nullable": true }, "requiresPersonalPropertyCoverage": { "type": "boolean" }, "requiresBuildingCoverage": { "type": "boolean" }, "stateLimitation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClassCodeDtoV2IEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClassCodeDtoV2" }, "nullable": true } }, "additionalProperties": false }, "ClassCodeGetDto": { "type": "object", "properties": { "classCodeId": { "type": "integer", "format": "int32", "nullable": true }, "classCode": { "type": "string", "nullable": true }, "classDescriptionCode": { "type": "string", "nullable": true }, "personalPropertyCoverage": { "$ref": "#/components/schemas/ClassCodeCoverageGetDto" }, "buildingCoverage": { "$ref": "#/components/schemas/ClassCodeCoverageGetDto" } }, "additionalProperties": false }, "ClassCodePostDto": { "required": [ "classCodeId" ], "type": "object", "properties": { "classCodeId": { "type": "integer", "format": "int32" }, "personalPropertyCoverage": { "$ref": "#/components/schemas/ClassCodeCoveragePostDto" }, "buildingCoverage": { "$ref": "#/components/schemas/ClassCodeCoveragePostDto" } }, "additionalProperties": false }, "ClassCodePostDtoV1": { "type": "object", "properties": { "classCodeId": { "type": "integer", "description": "This is optional. It is NOT required if a class code with class description code are entered.", "format": "int32", "nullable": true }, "classCode": { "type": "string", "description": "This is optional at this time. This is required if not providing a classCodeId.", "nullable": true }, "classDescriptionCode": { "type": "string", "description": "This is only required if a classCode is included in the request body.", "nullable": true }, "personalPropertyCoverage": { "$ref": "#/components/schemas/ClassCodeCoveragePostDto" }, "buildingCoverage": { "$ref": "#/components/schemas/ClassCodeCoveragePostDto" } }, "additionalProperties": false }, "ClassUwQuestionAnswerDto": { "type": "object", "properties": { "answer": { "type": "string", "nullable": true }, "questionId": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "potentialResponses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ChildGetUnderwritingQuestionDto" }, "nullable": true }, "requirementConditions": { "$ref": "#/components/schemas/RequirementConditions" }, "includedStates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedStates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "classCode": { "type": "string", "nullable": true }, "classCodeDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Conditions": { "type": "object", "properties": { "qualifyingParentAnswer": { "type": "string", "nullable": true }, "qualifyingOperator": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConstructionDto": { "type": "object", "properties": { "categoryCode": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactInfo": { "required": [ "email", "name", "phoneNumber" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "phoneNumber": { "minLength": 1, "pattern": "^\\d{10}$", "type": "string" }, "email": { "minLength": 1, "pattern": "^.+@.+\\..+$", "type": "string" } }, "additionalProperties": false }, "CreatePaymentPlanRequest": { "required": [ "paymentPlanId" ], "type": "object", "properties": { "paymentPlanId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreditCard": { "type": "object", "properties": { "creditCardNumber": { "type": "string", "nullable": true }, "cardType": { "enum": [ "0 = Visa", "1 = Mastercard", "2 = Discover", "3 = Amex", "4 = DinersClub", "5 = Valid", "6 = JCB", "-1 = Invalid" ], "type": "integer", "format": "int32" }, "cvv": { "type": "string", "nullable": true }, "expirationMonth": { "type": "integer", "format": "int32" }, "expirationYear": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ECheck": { "type": "object", "properties": { "accountNumber": { "type": "string", "nullable": true }, "routingNumber": { "type": "string", "nullable": true }, "financialInstitution": { "type": "string", "nullable": true }, "accountType": { "enum": [ "1 = Checking", "2 = Savings" ], "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ForbiddenError": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "httpStatus": { "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" }, "messageType": { "enum": [ "0 = Info", "1 = Error" ], "type": "integer", "format": "int32" }, "detail": { "type": "string", "nullable": true }, "internal": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "exception": { "$ref": "#/components/schemas/LogException" }, "needsSanitization": { "type": "boolean", "readOnly": true }, "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", "readOnly": true }, "messageCode": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "isOk": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ForbiddenErrorIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/ForbiddenError" } }, "additionalProperties": false }, "GetAllUwQuestionsDto": { "type": "object", "properties": { "generalQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/StateUwQuestionAnswerDto" }, "nullable": true }, "classCodeQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ClassUwQuestionAnswerDto" }, "nullable": true } }, "additionalProperties": false }, "GetAllUwQuestionsDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetAllUwQuestionsDto" } }, "additionalProperties": false }, "GetContactInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetEligibilityResponseDto": { "type": "object", "properties": { "quoteStatus": { "type": "string", "nullable": true }, "eligibility": { "type": "string", "nullable": true }, "eligibilityReasons": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "GetEligibilityResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetEligibilityResponseDto" } }, "additionalProperties": false }, "GetQuestionsDto": { "type": "object", "properties": { "generalQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDto" }, "nullable": true }, "classCodeQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDto" }, "nullable": true } }, "additionalProperties": false }, "GetQuestionsDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetQuestionsDto" } }, "additionalProperties": false }, "GetQuoteDto": { "type": "object", "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation" }, "premiumDetails": { "$ref": "#/components/schemas/GetRateDto" }, "fein": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/GetContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "format": "date-time" }, "agentContactId": { "type": "integer", "format": "int32" }, "agentContactName": { "type": "string", "nullable": true }, "legalEntity": { "type": "string", "nullable": true }, "eligibility": { "type": "string", "nullable": true }, "eligibilityReasons": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasTerrorismCoverage": { "type": "boolean", "readOnly": true }, "companyWebsite": { "type": "string", "nullable": true }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationGetDto" }, "nullable": true } }, "additionalProperties": false }, "GetQuoteDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetQuoteDto" } }, "additionalProperties": false }, "GetQuoteDtoV3": { "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationGetDtoV2" }, "nullable": true }, "status": { "type": "string", "description": "Possible statuses - Not Submitted, BindEligiblePass, Bound, SystemDeclined, etc", "nullable": true }, "accountInformation": { "$ref": "#/components/schemas/AccountInformation" }, "premiumDetails": { "$ref": "#/components/schemas/GetRateDtoV3" }, "fein": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/GetContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "format": "date-time" }, "agentContactId": { "type": "integer", "format": "int32" }, "agentContactName": { "type": "string", "nullable": true }, "legalEntity": { "type": "string", "nullable": true }, "eligibility": { "type": "string", "nullable": true }, "eligibilityReasons": { "type": "array", "items": { "type": "string" }, "nullable": true }, "hasTerrorismCoverage": { "type": "boolean" }, "companyWebsite": { "type": "string", "nullable": true }, "additionalInsureds": { "type": "array", "items": { "$ref": "#/components/schemas/AdditionalInsuredGetDtoV2" }, "nullable": true } }, "additionalProperties": false }, "GetQuoteDtoV3IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetQuoteDtoV3" } }, "additionalProperties": false }, "GetRateDto": { "type": "object", "properties": { "taxes": { "type": "number", "format": "double" }, "totalPremium": { "type": "number", "format": "double" }, "totalCost": { "type": "number", "format": "double" } }, "additionalProperties": false }, "GetRateDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/GetRateDto" } }, "additionalProperties": false }, "GetRateDtoV3": { "type": "object", "properties": { "taxes": { "type": "integer", "format": "int32" }, "totalPremium": { "type": "integer", "format": "int32" }, "totalCost": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GetUnderwritingQuestionAnswerDto": { "type": "object", "properties": { "questionId": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "potentialResponses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ChildGetUnderwritingQuestionDto" }, "nullable": true }, "requirementConditions": { "$ref": "#/components/schemas/RequirementConditions" }, "answer": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GetUnderwritingQuestionAnswerDtoIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetUnderwritingQuestionAnswerDto" }, "nullable": true } }, "additionalProperties": false }, "IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "JsonPatchDocument": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" }, "description": "Array of operations to perform" }, "LocationDto": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "propertyDeductible": { "type": "string", "description": "\nIf unsent, the value will be defaulted to $500.\n\nAccepted values:\n", "nullable": true }, "propertyDeductable": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationGetDto": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "id": { "type": "integer", "format": "int32" }, "propertyDeductible": { "type": "string", "nullable": true }, "buildings": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingResponseDto" }, "nullable": true } }, "additionalProperties": false }, "LocationGetDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/LocationGetDto" } }, "additionalProperties": false }, "LocationGetDtoIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocationGetDto" }, "nullable": true } }, "additionalProperties": false }, "LocationGetDtoV2": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "id": { "type": "integer", "format": "int32" }, "propertyDeductible": { "type": "string", "nullable": true }, "buildings": { "type": "array", "items": { "$ref": "#/components/schemas/BuildingResponseDtoV2" }, "nullable": true } }, "additionalProperties": false }, "LocationGetDtoV2IEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocationGetDtoV2" }, "nullable": true } }, "additionalProperties": false }, "LocationPatchResponseDto": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "id": { "type": "integer", "format": "int32" }, "propertyDeductible": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationPatchResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/LocationPatchResponseDto" } }, "additionalProperties": false }, "LocationPostDto": { "required": [ "city", "line1", "postalCode", "territory" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "territory": { "minLength": 1, "type": "string" }, "postalCode": { "minLength": 1, "pattern": "^\\d{5}(-\\d{4})?$", "type": "string" }, "id": { "type": "integer", "format": "int32" }, "propertyDeductible": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LogException": { "type": "object", "properties": { "exceptionId": { "type": "string", "format": "uuid" }, "module": { "type": "string", "nullable": true }, "class": { "type": "string", "nullable": true }, "targetSite": { "type": "string", "nullable": true }, "httpWebEventCode": { "type": "integer", "format": "int32", "nullable": true }, "httpStatusValue": { "type": "integer", "format": "int32", "nullable": true }, "httpStatusCode": { "type": "string", "nullable": true }, "httpHtmlMessage": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "innerException": { "$ref": "#/components/schemas/LogException" }, "message": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "helpLink": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "data": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "baseException": { "$ref": "#/components/schemas/LogException" } }, "additionalProperties": false }, "LossHistoryPostRequestDto": { "required": [ "hasPriorCarrier", "lossApplication" ], "type": "object", "properties": { "hasPriorCarrier": { "type": "boolean" }, "hasZeroClaimsInLastThreeYears": { "type": "boolean" }, "lossApplication": { "maximum": 6.0, "minimum": 0.0, "type": "integer", "description": "1 - Single Loss < $5,000
2 - Single Non - Weather Loss $5, 000 - $10, 000
3 - Single Non - Weather Loss > $10, 000
4 - Single Weather Loss $5, 000 - $25, 000
5 - Single Weather Loss > 25, 000
6 - Two or More Losses", "format": "int32" } }, "additionalProperties": false }, "LossHistoryPostRequestDtoV2": { "required": [ "hasPriorCarrier", "lossApplication", "premium" ], "type": "object", "properties": { "hasPriorCarrier": { "type": "boolean" }, "hasZeroClaimsInLastThreeYears": { "type": "boolean" }, "lossApplication": { "maximum": 6.0, "minimum": 0.0, "type": "integer", "description": "1 - Single Loss < $5,000
2 - Single Non - Weather Loss $5, 000 - $10, 000
3 - Single Non - Weather Loss > $10, 000
4 - Single Weather Loss $5, 000 - $25, 000
5 - Single Weather Loss > 25, 000
6 - Two or More Losses", "format": "int32" }, "premium": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LossHistoryPostResponseDto": { "type": "object", "properties": { "hasPriorCarrier": { "type": "boolean" }, "hasZeroClaimsInLastThreeYears": { "type": "boolean" }, "lossApplication": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LossHistoryPostResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/LossHistoryPostResponseDto" } }, "additionalProperties": false }, "NotFoundError": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "httpStatus": { "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" }, "messageType": { "enum": [ "0 = Info", "1 = Error" ], "type": "integer", "format": "int32" }, "detail": { "type": "string", "nullable": true }, "internal": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "exception": { "$ref": "#/components/schemas/LogException" }, "needsSanitization": { "type": "boolean", "readOnly": true }, "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", "readOnly": true }, "messageCode": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "isOk": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "NotFoundErrorIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/NotFoundError" } }, "additionalProperties": false }, "Operation": { "type": "object", "properties": { "op": { "type": "string", "description": "Type of operation (add, replace, copy, or move)" }, "value": { "type": "string", "description": "Value to be patched (if performing an add, replace, copy, or move)" }, "path": { "type": "string", "description": "The name of the property to be patched, using this format: /propertyName" }, "from": { "type": "string", "description": "Copies a value from one location to another within the JSON document using format: /fromPropertyName" } } }, "PatchBuildingResponseV1": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodeGetDto" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true }, "premiumDetails": { "$ref": "#/components/schemas/PremiumDetails" } }, "additionalProperties": false }, "PatchBuildingResponseV1IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PatchBuildingResponseV1" } }, "additionalProperties": false }, "PatchBuildingResponseV2": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodeGetDto" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true }, "premiumDetails": { "$ref": "#/components/schemas/PremiumDetails" }, "lessorLiability": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PatchBuildingResponseV2IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PatchBuildingResponseV2" } }, "additionalProperties": false }, "PatchQuoteDto": { "required": [ "legalEntity" ], "type": "object", "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation" }, "fein": { "type": "string", "nullable": true }, "businessName": { "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/GetContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "format": "date-time" }, "agentContactId": { "type": "integer", "format": "int32" }, "legalEntity": { "minLength": 1, "type": "string", "description": "Allowed Legal Entities \r\n " }, "premiumDetails": { "$ref": "#/components/schemas/GetRateDto" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationGetDto" }, "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "digitalClientWorkflow": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PatchQuoteDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PatchQuoteDto" } }, "additionalProperties": false }, "PayerInfoRequest": { "required": [ "emailAddress" ], "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/PaymentAddress" }, "emailAddress": { "minLength": 1, "type": "string" }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentAddress": { "required": [ "city", "country", "line1", "state", "zip" ], "type": "object", "properties": { "line1": { "minLength": 1, "type": "string" }, "line2": { "type": "string", "nullable": true }, "city": { "minLength": 1, "type": "string" }, "state": { "minLength": 1, "type": "string" }, "zip": { "minLength": 1, "type": "string" }, "country": { "enum": [ "225 = US" ], "type": "integer", "format": "int32" }, "countryName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentPlan": { "type": "object", "properties": { "paymentPlanId": { "type": "integer", "format": "int32", "nullable": true }, "paymentPlanDescription": { "type": "string", "nullable": true }, "billType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentPlanPostResponse": { "type": "object", "additionalProperties": false }, "PaymentPlanPostResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PaymentPlanPostResponse" } }, "additionalProperties": false }, "PaymentPlanResponse": { "type": "object", "properties": { "agency": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" }, "nullable": true }, "direct": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentPlan" }, "nullable": true } }, "additionalProperties": false }, "PaymentPlanResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PaymentPlanResponse" } }, "additionalProperties": false }, "PaymentPostModel": { "required": [ "payerInfo", "paymentSystemInfo", "quoteId", "sendEmail" ], "type": "object", "properties": { "quoteId": { "type": "integer", "format": "int32" }, "sendEmail": { "type": "boolean" }, "payerInfo": { "$ref": "#/components/schemas/PayerInfoRequest" }, "eCheck": { "$ref": "#/components/schemas/ECheck" }, "creditCard": { "$ref": "#/components/schemas/CreditCard" }, "paymentSystemInfo": { "$ref": "#/components/schemas/PaymentSystemInfo" } }, "additionalProperties": false }, "PaymentResponse": { "type": "object", "properties": { "amountProcessed": { "type": "number", "format": "double" }, "remainingPolicyPayment": { "type": "number", "format": "double" }, "transactionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PaymentResponse" } }, "additionalProperties": false }, "PaymentSystemInfo": { "required": [ "amount", "paymentDescription" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "lob": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "payrollMonth": { "type": "string", "nullable": true }, "amount": { "$ref": "#/components/schemas/BasePaymentAmount" }, "taxAmount": { "$ref": "#/components/schemas/BasePaymentAmount" }, "feeAmount": { "$ref": "#/components/schemas/BasePaymentAmount" }, "paymentDescription": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PolicyDocumentResponse": { "type": "object", "properties": { "documentName": { "type": "string", "nullable": true }, "fileType": { "type": "string", "nullable": true }, "documentType": { "type": "string", "nullable": true }, "libraryIndex": { "type": "integer", "format": "int32" }, "dateReceived": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyDocumentResponseIEnumerableIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyDocumentResponse" }, "nullable": true } }, "additionalProperties": false }, "PostAcknowledgementDto": { "required": [ "isAcknowledged" ], "type": "object", "properties": { "isAcknowledged": { "minLength": 1, "type": "string", "description": "Accepted values: Yes, No, True, False" } }, "additionalProperties": false }, "PostAdditionalInsuredRequest": { "required": [ "form" ], "type": "object", "properties": { "form": { "enum": [ "0 = Mortgagee", "1 = MgrLsrPrem", "2 = MortAssgnRec", "3 = LandLeased", "4 = InsuredPrem", "6 = Designated", "7 = SchedPerson", "8 = LossPayable", "9 = EquipmentLeased", "10 = CompOperation", "11 = Permits", "12 = OtherInsurance", "13 = EXTOFNI" ], "type": "integer", "description": "Short name for Additional Insured Forms\n
Form NameDescription
MortageeBOP MORTGAGEE
MgrLsrPremADDITIONAL INSURED - MANAGERS OR LESSORS OF PREMISES
MortAssgnRecADDITIONAL INSURED - MORTGAGEE, ASSIGNEE OR RECEIVER
LandLeasedADDITIONAL INSURED - OWNERS OR OTHER INTERESTS FROM WHOM LAND HAS BEEN LEASED
InsuredPremADDITIONAL INSURED - CO-OWNER OF INSURED PREMISES
DesignatedADDITIONAL INSURED - DESIGNATED PERSON OR ORGANIZATION
SchedPersonADDITIONAL INSURED - OWNERS, LESSEES OR CONTRACTORS - SCHEDULED PERSON OR ORGANIZATION
LossPayableLOSS PAYABLE PROVISIONS
EquipmentLeasedADDITIONAL INSURED - LESSOR OF LEASED EQUIPMENTS
CompOperationADDITIONAL INSURED OWNERS LESSEES OR CONTRACTORS - COMPLETED OPERATIONS
PermitsADDITIONAL INSURED STATE OR POLITICAL SUBDIVISIONS - PERMITS RELATING TO PREMISES
OtherInsuranceADDITIONAL INSURED - OWNERS, LESSEES, OR CONTRACTORS WITH ADDITIONAL INSURED REQUIREMENT IN CONSTRUCTION CONTRACT PRIMARY AND NON-CONTRIBUTORY-OTHER INSURANCE CONDITION
", "format": "int32" }, "additionalInsuredName": { "type": "string", "description": "The name of additional insured.", "nullable": true }, "propertyDescription": { "type": "string", "description": "PropertyDescription - Only required for Mortgagee, Vendor, and LossPayable forms.", "nullable": true }, "clause": { "enum": [ "0 = NotApplicable", "1 = A", "2 = B", "3 = C" ], "type": "integer", "description": "Only Applicable for Loss Payable Forms; value will be ignored if submitted for other form types.\n
ClauseDescription
NotApplicable(Default) Clause Description is Not Applicable for Quote
ALoss Payable Clause
BLenders' Loss Payable Clause
CContract of Sale Clause
", "format": "int32" }, "locationId": { "type": "integer", "description": "Location ID - Only required for certain forms.", "format": "int32", "nullable": true }, "buildings": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Building IDs - Only required for Mortgagee, LossPayable, MgrLsrPrem.", "nullable": true }, "nameOfInsuredPersonOrganization": { "type": "string", "description": "NameOfInsuredPersonOrganization - Only required for EquipmentLeased and CompOperation forms.", "nullable": true }, "leasedEquipmentDescription": { "type": "string", "description": "LeasedEquipmentDescription - Only required for EquipmentLeased form.", "nullable": true }, "typeOfRisk": { "enum": [ "1 = ApartmentAndOffice", "2 = AllOther" ], "type": "integer", "description": "TypeOfRisk - Only required for EquipmentLeased form.", "format": "int32", "nullable": true }, "leasedEquipmentLocation": { "type": "string", "description": "LeasedEquipmentLocation - Only required for EquipmentLeased form.", "nullable": true }, "locationAndDescriptionOfCompletedOperations": { "type": "string", "description": "LocationAndDescriptionOfCompletedOperations - Only required for CompOperation form.", "nullable": true }, "stateOrPoliticalSubdivision": { "type": "string", "description": "StateOrPoliticalSubdivision - Only required for Permits form.", "nullable": true } }, "additionalProperties": false }, "PostAdditionalInsuredRequestV2": { "type": "object", "properties": { "form": { "enum": [ "0 = Mortgagee", "1 = MgrLsrPrem", "2 = MortAssgnRec", "3 = LandLeased", "4 = InsuredPrem", "6 = Designated", "7 = SchedPerson", "8 = LossPayable", "9 = EquipmentLeased", "10 = CompOperation", "11 = Permits", "12 = OtherInsurance", "13 = EXTOFNI" ], "type": "integer", "description": "Short name for Additional Insured Forms. When field NamedInsured is true any value entered will be ignored and default to EXTOFNI.\n
Form NameDescription
MortageeBOP MORTGAGEE
MgrLsrPremADDITIONAL INSURED - MANAGERS OR LESSORS OF PREMISES
MortAssgnRecADDITIONAL INSURED - MORTGAGEE, ASSIGNEE OR RECEIVER
LandLeasedADDITIONAL INSURED - OWNERS OR OTHER INTERESTS FROM WHOM LAND HAS BEEN LEASED
InsuredPremADDITIONAL INSURED - CO-OWNER OF INSURED PREMISES
DesignatedADDITIONAL INSURED - DESIGNATED PERSON OR ORGANIZATION
SchedPersonADDITIONAL INSURED - OWNERS, LESSEES OR CONTRACTORS - SCHEDULED PERSON OR ORGANIZATION
LossPayableLOSS PAYABLE PROVISIONS
EquipmentLeasedADDITIONAL INSURED - LESSOR OF LEASED EQUIPMENTS
CompOperationADDITIONAL INSURED OWNERS LESSEES OR CONTRACTORS - COMPLETED OPERATIONS
PermitsADDITIONAL INSURED STATE OR POLITICAL SUBDIVISIONS - PERMITS RELATING TO PREMISES
OtherInsuranceADDITIONAL INSURED - OWNERS, LESSEES, OR CONTRACTORS WITH ADDITIONAL INSURED REQUIREMENT IN CONSTRUCTION CONTRACT PRIMARY AND NON-CONTRIBUTORY-OTHER INSURANCE CONDITION
", "format": "int32", "nullable": true }, "additionalInsuredName": { "type": "string", "description": "The name of additional insured.", "nullable": true }, "propertyDescription": { "type": "string", "description": "PropertyDescription - Only required for Mortgagee, Vendor, and LossPayable forms.", "nullable": true }, "clause": { "enum": [ "0 = NotApplicable", "1 = A", "2 = B", "3 = C" ], "type": "integer", "description": "Only Applicable for Loss Payable Forms; value will be ignored if submitted for other form types.\n
ClauseDescription
NotApplicable(Default) Clause Description is Not Applicable for Quote
ALoss Payable Clause
BLenders' Loss Payable Clause
CContract of Sale Clause
", "format": "int32" }, "locationId": { "type": "integer", "description": "Location ID - Only required for certain forms.", "format": "int32", "nullable": true }, "buildings": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Building IDs - Only required for Mortgagee, LossPayable, MgrLsrPrem.", "nullable": true }, "nameOfInsuredPersonOrganization": { "type": "string", "description": "NameOfInsuredPersonOrganization - Only required for EquipmentLeased and CompOperation forms.", "nullable": true }, "leasedEquipmentDescription": { "type": "string", "description": "LeasedEquipmentDescription - Only required for EquipmentLeased form.", "nullable": true }, "typeOfRisk": { "enum": [ "1 = ApartmentAndOffice", "2 = AllOther" ], "type": "integer", "description": "TypeOfRisk - Only required for EquipmentLeased form.", "format": "int32", "nullable": true }, "leasedEquipmentLocation": { "type": "string", "description": "LeasedEquipmentLocation - Only required for EquipmentLeased form.", "nullable": true }, "locationAndDescriptionOfCompletedOperations": { "type": "string", "description": "LocationAndDescriptionOfCompletedOperations - Only required for CompOperation form.", "nullable": true }, "stateOrPoliticalSubdivision": { "type": "string", "description": "StateOrPoliticalSubdivision - Only required for Permits form.", "nullable": true }, "namedInsured": { "type": "boolean", "description": "Indicates whether this is a Named Insured. When true, DBA and CommonOwnership fields are required.\nThe remaining fields will be ignored, and Form field will default to EXTOFNI." }, "dba": { "type": "string", "description": "The DBA (Doing Business As) name. Required when NamedInsured is true.", "nullable": true }, "commonOwnership": { "type": "boolean", "description": "Common Ownership should be selected for entities which share 51% or greater ownership interest. \nTo add an additional named insured common ownership must be TRUE.\nRequired when NamedInsured is true, and must be true to save a Named Insured." } }, "additionalProperties": false }, "PostAdditionalInsuredResponse": { "type": "object", "properties": { "quoteId": { "type": "integer", "format": "int32" }, "masterAccountID": { "type": "integer", "format": "int32" }, "additionalInsured": { "$ref": "#/components/schemas/AdditionalInsuredDto" }, "address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false }, "PostAdditionalInsuredResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostAdditionalInsuredResponse" } }, "additionalProperties": false }, "PostAdditionalInsuredResponseV2": { "type": "object", "properties": { "quoteId": { "type": "integer", "format": "int32" }, "masterAccountID": { "type": "integer", "format": "int32" }, "additionalInsured": { "$ref": "#/components/schemas/AdditionalInsuredDtoV2" }, "address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false }, "PostAdditionalInsuredResponseV2IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostAdditionalInsuredResponseV2" } }, "additionalProperties": false }, "PostBuildingRequestV2": { "required": [ "classCode", "constructionCategoryCode", "hasCentralStationBurglarAlarm", "hasCentralStationFireAlarm", "highestStoryOccupied", "isSprinkleredBuilding", "totalSquareFootage", "totalStories", "yearBuilt" ], "type": "object", "properties": { "roofType": { "type": "string", "description": "AsphaltShingles
BuiltUpRoofing
ClayTiles
MetalRoofPanels
ConcretePaver
RubberMembrane
StoneBallast", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDtoV1" }, "annualSales": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "constructionCategoryCode": { "maximum": 6.0, "minimum": 1.0, "type": "integer", "description": "1 --> Frame
2 --> Joisted Masonry
3 --> Noncombustible
4 --> Masonry Noncombustible
5 --> Modified Fire Resistive
6 --> Fire Resistive", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearBuilt": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" } }, "additionalProperties": false }, "PostBuildingRequestV3": { "required": [ "classCode", "constructionCategoryCode", "hasCentralStationBurglarAlarm", "hasCentralStationFireAlarm", "highestStoryOccupied", "isSprinkleredBuilding", "totalSquareFootage", "totalStories", "yearBuilt" ], "type": "object", "properties": { "roofType": { "type": "string", "description": "AsphaltShingles
BuiltUpRoofing
ClayTiles
MetalRoofPanels
ConcretePaver
RubberMembrane
StoneBallast", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDtoV1" }, "annualSales": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "constructionCategoryCode": { "maximum": 6.0, "minimum": 1.0, "type": "integer", "description": "1 --> Frame
2 --> Joisted Masonry
3 --> Noncombustible
4 --> Masonry Noncombustible
5 --> Modified Fire Resistive
6 --> Fire Resistive", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearBuilt": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "lessorLiability": { "type": "boolean", "description": "-Is required for the state of WA
-If select True you must include Building Coverage", "nullable": true } }, "additionalProperties": false }, "PostBuildingResponseV2": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDtoV1" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true }, "premiumDetails": { "$ref": "#/components/schemas/PremiumDetails" } }, "additionalProperties": false }, "PostBuildingResponseV2IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostBuildingResponseV2" } }, "additionalProperties": false }, "PostBuildingResponseV3": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDtoV1" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "type": "integer", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "squareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "format": "int32" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32", "nullable": true }, "lessorLiability": { "type": "boolean", "nullable": true }, "premiumDetails": { "$ref": "#/components/schemas/PremiumDetails" } }, "additionalProperties": false }, "PostBuildingResponseV3IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostBuildingResponseV3" } }, "additionalProperties": false }, "PostDirectDebitDocRequest": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "windowsFileType": { "type": "string", "nullable": true }, "fileData": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "PostDirectDebitDocResponse": { "type": "object", "properties": { "libraryId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PostDirectDebitDocResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostDirectDebitDocResponse" } }, "additionalProperties": false }, "PostDirectDebitRequest": { "required": [ "accountNumber", "email", "nameOnAccount", "routingNumber" ], "type": "object", "properties": { "nameOnAccount": { "minLength": 1, "type": "string" }, "routingNumber": { "minLength": 1, "type": "string" }, "accountNumber": { "minLength": 1, "type": "string" }, "email": { "minLength": 1, "type": "string" }, "accountType": { "type": "string", "description": "1 = Checking , 2 = Savings", "nullable": true } }, "additionalProperties": false }, "PostDirectDebitResponse": { "type": "object", "properties": { "nameOnAccount": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "routingNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "accountType": { "enum": [ "1 = Checking", "2 = Savings" ], "type": "integer", "format": "int32" }, "bankName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PostDirectDebitResponseIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostDirectDebitResponse" } }, "additionalProperties": false }, "PostFileModel": { "required": [ "fileData", "windowsFileType" ], "type": "object", "properties": { "windowsFileType": { "minLength": 1, "type": "string" }, "fileData": { "type": "string", "format": "byte" }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PostInsuredClearanceRequestDto": { "required": [ "address", "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "address": { "$ref": "#/components/schemas/Address" } }, "additionalProperties": false }, "PostInsuredClearanceResponseDto": { "type": "object", "properties": { "isAvailable": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PostInsuredClearanceResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostInsuredClearanceResponseDto" } }, "additionalProperties": false }, "PostQuoteRateDtoV3": { "type": "object", "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation" }, "businessName": { "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/GetContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "format": "date-time" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationPostDto" }, "nullable": true }, "fein": { "type": "string", "nullable": true }, "agentContact": { "$ref": "#/components/schemas/AgentContactShortDto" }, "eligibility": { "type": "string", "nullable": true }, "eligibilityReasons": { "type": "array", "items": { "type": "string" }, "nullable": true }, "legalEntity": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "classCode": { "$ref": "#/components/schemas/ClassCodeGetDto" }, "premiumDetails": { "$ref": "#/components/schemas/PremiumDetailsV2" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "construction": { "$ref": "#/components/schemas/ConstructionDto" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "totalSquareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "type": "integer", "format": "int32" }, "yearBuilt": { "$ref": "#/components/schemas/YearBuiltBase" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "hasTerrorismCoverage": { "type": "boolean", "readOnly": true }, "roofType": { "type": "string", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32" }, "digitalClientWorkflow": { "type": "string", "nullable": true }, "lessorLiability": { "type": "boolean" }, "status": { "type": "string", "description": "Examples of Statuses - Not Submitted, BindEligilePass, Bound, etc", "nullable": true } }, "additionalProperties": false }, "PostQuoteRateDtoV3IApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/PostQuoteRateDtoV3" } }, "additionalProperties": false }, "PremiumDetails": { "type": "object", "properties": { "priceIndication": { "type": "number", "format": "double" }, "generalLiabilityLimits": { "type": "string", "nullable": true }, "medicalPayments": { "type": "string", "nullable": true }, "damagesToPremisesLiabilityLimit": { "type": "string", "nullable": true }, "businessPersonalProperty": { "type": "string", "nullable": true }, "propertyDeductible": { "type": "string", "nullable": true }, "expansionEndorsement": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PremiumDetailsV2": { "type": "object", "properties": { "priceIndication": { "type": "number", "format": "double" }, "generalLiabilityLimits": { "type": "string", "nullable": true }, "medicalPayments": { "type": "string", "nullable": true }, "damagesToPremisesLiabilityLimit": { "type": "string", "nullable": true }, "businessPersonalProperty": { "type": "string", "nullable": true }, "propertyDeductible": { "type": "string", "nullable": true }, "expansionEndorsement": { "type": "string", "nullable": true }, "totalCost": { "type": "number", "format": "double" }, "taxes": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PutContactInfo": { "required": [ "email", "name", "phoneNumber" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string" }, "phoneNumber": { "minLength": 1, "pattern": "^\\d{10}$", "type": "string" }, "email": { "minLength": 1, "pattern": "^.+@.+\\..+$", "type": "string" } }, "additionalProperties": false }, "QuoteRatePostRequestV1": { "required": [ "businessName", "classCode", "constructionCategoryCode", "effectiveDate", "hasCentralStationBurglarAlarm", "hasCentralStationFireAlarm", "highestStoryOccupied", "isSprinkleredBuilding", "legalEntity", "lossHistory", "mailingAddress", "numberOfEmployees", "primaryAddress", "primaryContactInformation", "totalSquareFootage", "totalStories", "underwritingQuestions" ], "type": "object", "properties": { "skipUWQuestions": { "type": "boolean" }, "expandedResponse": { "type": "boolean" }, "skipRate": { "type": "boolean" }, "skipEval": { "type": "boolean" }, "dba": { "type": "string", "nullable": true }, "lessorLiability": { "type": "boolean", "nullable": true }, "propertyDeductible": { "type": "string", "description": "\nIf unsent, the value will be defaulted to 500.\n\nAccepted values (All states except WA):\n\n\nAccepted values (WA state):\n", "nullable": true }, "roofType": { "type": "string", "description": "AsphaltShingles
BuiltUpRoofing
ClayTiles
MetalRoofPanels
ConcretePaver
RubberMembrane
StoneBallast", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32" }, "digitalClientWorkflow": { "type": "string", "nullable": true }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDtoV1" }, "annualSales": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "annualPayroll": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32", "nullable": true }, "numberOfEmployees": { "type": "integer", "description": "This field is required if the class code included is one of the following: 74111, 74231, 74511, 74541, 74601, 74661, 74751, 74781, 74841, 74901, 75641, 75791, 75821, and 75881", "format": "int32" }, "constructionCategoryCode": { "maximum": 6.0, "minimum": 1.0, "type": "integer", "description": "1 --> Frame
2 --> Joisted Masonry
3 --> Noncombustible
4 --> Masonry Noncombustible
5 --> Modified Fire Resistive
6 --> Fire Resistive", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "totalSquareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearBuilt": { "$ref": "#/components/schemas/YearBuiltDto" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "underwritingQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/AddUnderwritingQuestionAnswerDto" } }, "lossHistory": { "$ref": "#/components/schemas/LossHistoryPostRequestDtoV2" }, "masterAccountId": { "type": "integer", "format": "int32" }, "newMasterAccountId": { "type": "boolean" }, "businessName": { "maxLength": 90, "minLength": 1, "type": "string" }, "fein": { "pattern": "^\\d{9}$", "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/ContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "description": "Cannot be before today or more than 110 days in the future", "format": "date-time" }, "agentContactId": { "type": "integer", "format": "int32", "nullable": true }, "legalEntity": { "minLength": 1, "type": "string", "description": "Individual
Joint Venture
Limited Liability Company
Organization including a Corporation
Partnership
Trust
Other
Other - Financial Institution
Other - Non-Profit" }, "companyWebsite": { "type": "string", "nullable": true } }, "additionalProperties": false }, "QuoteRatePutRequest": { "required": [ "businessName", "classCode", "constructionCategoryCode", "effectiveDate", "hasCentralStationBurglarAlarm", "hasCentralStationFireAlarm", "highestStoryOccupied", "isSprinkleredBuilding", "legalEntity", "lossHistory", "mailingAddress", "numberOfEmployees", "primaryAddress", "primaryContactInformation", "totalSquareFootage", "totalStories", "underwritingQuestions" ], "type": "object", "properties": { "skipUWQuestions": { "type": "boolean" }, "expandedResponse": { "type": "boolean" }, "skipRate": { "type": "boolean" }, "skipEval": { "type": "boolean" }, "dba": { "type": "string", "nullable": true }, "masterAccountId": { "maximum": 79228162514264337593543950335, "minimum": 100.0, "type": "integer", "format": "int32" }, "numberOfEmployees": { "type": "integer", "format": "int32" }, "businessName": { "maxLength": 90, "minLength": 1, "type": "string" }, "fein": { "pattern": "^\\d{9}$", "type": "string", "nullable": true }, "primaryContactInformation": { "$ref": "#/components/schemas/PutContactInfo" }, "primaryAddress": { "$ref": "#/components/schemas/Address" }, "mailingAddress": { "$ref": "#/components/schemas/Address" }, "effectiveDate": { "type": "string", "description": "Cannot be before today or more than 110 days in the future", "format": "date-time" }, "agentContactId": { "type": "integer", "format": "int32", "nullable": true }, "legalEntity": { "minLength": 1, "type": "string", "description": "Individual
Joint Venture
Limited Liability Company
Organization including a Corporation
Partnership
Trust
Other
Other - Financial Institution
Other - Non-Profit" }, "companyWebsite": { "type": "string", "nullable": true }, "lessorLiability": { "type": "boolean", "description": "Required for the state of WA.\nFor non-WA quotes, the value will be defaulted to false if not submitted.", "nullable": true }, "propertyDeductible": { "type": "string", "description": "\nIf unsent, the value will be defaulted to 500.\n\nAccepted values (All states except WA):\n\n\nAccepted values (WA state):\n", "nullable": true }, "classCode": { "$ref": "#/components/schemas/ClassCodePostDto" }, "annualSales": { "type": "integer", "format": "int32", "nullable": true }, "constructionCategoryCode": { "maximum": 6.0, "minimum": 1.0, "type": "integer", "description": "1 --> Frame
2 --> Joisted Masonry
3 --> Noncombustible
4 --> Masonry Noncombustible
5 --> Modified Fire Resistive
6 --> Fire Resistive", "format": "int32" }, "totalSquareFootage": { "type": "integer", "format": "int32" }, "totalSquareFootageOccupied": { "type": "integer", "format": "int32", "nullable": true }, "totalStories": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearBuilt": { "$ref": "#/components/schemas/YearBuiltDto" }, "hasCentralStationFireAlarm": { "type": "boolean" }, "hasCentralStationBurglarAlarm": { "type": "boolean" }, "isSprinkleredBuilding": { "type": "boolean" }, "underwritingQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/AddUnderwritingQuestionAnswerDto" } }, "lossHistory": { "$ref": "#/components/schemas/LossHistoryPostRequestDtoV2" }, "roofType": { "type": "string", "description": "AsphaltShingles
BuiltUpRoofing
ClayTiles
MetalRoofPanels
ConcretePaver
RubberMembrane
StoneBallast", "nullable": true }, "highestStoryOccupied": { "type": "integer", "format": "int32" }, "digitalClientWorkflow": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequirementConditions": { "type": "object", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Conditions" }, "nullable": true } }, "additionalProperties": false }, "StateUwQuestionAnswerDto": { "type": "object", "properties": { "answer": { "type": "string", "nullable": true }, "questionId": { "type": "string", "nullable": true }, "questionType": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "potentialResponses": { "type": "array", "items": { "type": "string" }, "nullable": true }, "childQuestions": { "type": "array", "items": { "$ref": "#/components/schemas/ChildGetUnderwritingQuestionDto" }, "nullable": true }, "requirementConditions": { "$ref": "#/components/schemas/RequirementConditions" }, "includedStates": { "type": "array", "items": { "type": "string" }, "nullable": true }, "excludedStates": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StringIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TermsOfAgreementDto": { "type": "object", "properties": { "isAcknowledged": { "type": "boolean" } }, "additionalProperties": false }, "TermsOfAgreementDtoApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "isOk": { "type": "boolean" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "data": { "$ref": "#/components/schemas/TermsOfAgreementDto" } }, "additionalProperties": false }, "TermsOfAgreementRequest": { "type": "object", "properties": { "isAcknowledged": { "type": "boolean" } }, "additionalProperties": false }, "UnauthorizedError": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "httpStatus": { "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" }, "messageType": { "enum": [ "0 = Info", "1 = Error" ], "type": "integer", "format": "int32" }, "detail": { "type": "string", "nullable": true }, "internal": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "exception": { "$ref": "#/components/schemas/LogException" }, "needsSanitization": { "type": "boolean", "readOnly": true }, "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", "readOnly": true }, "messageCode": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "isOk": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UnauthorizedErrorIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/UnauthorizedError" } }, "additionalProperties": false }, "UploadFileResponseDto": { "type": "object", "properties": { "libraryId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UploadFileResponseDtoIApiResponse": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "correlationID": { "type": "string", "nullable": true }, "httpStatus": { "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" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMessage" }, "nullable": true }, "paging": { "$ref": "#/components/schemas/ApiPaging" }, "maxMsgIndex": { "type": "integer", "format": "int32", "readOnly": true }, "maxErrIndex": { "type": "integer", "format": "int32", "readOnly": true }, "isOk": { "type": "boolean" }, "apiResponseVersion": { "type": "string", "nullable": true, "readOnly": true }, "data": { "$ref": "#/components/schemas/UploadFileResponseDto" } }, "additionalProperties": false }, "YearBuiltBase": { "required": [ "yearBuilt" ], "type": "object", "properties": { "yearBuilt": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "YearBuiltDto": { "required": [ "yearBuilt" ], "type": "object", "properties": { "yearBuilt": { "maximum": 2147483647.0, "minimum": 1.0, "type": "integer", "format": "int32" }, "yearRoofUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearElectricalUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearPlumbingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" }, "yearHeatingUpdated": { "type": "integer", "description": "Only required if building is over 20 years old", "format": "int32" } }, "additionalProperties": false } }, "securitySchemes": { "apiKeyHeader": { "type": "apiKey", "name": "subscriber_id", "in": "header" }, "apiKeyQuery": { "type": "apiKey", "name": "subscription-key", "in": "query" } } }, "security": [ { "apiKeyHeader": [] }, { "apiKeyQuery": [] } ], "tags": [ { "name": "Location" }, { "name": "Quotes" }, { "name": "Policy" }, { "name": "Payments" }, { "name": "Document" }, { "name": "Agent Contacts" }, { "name": "Reference Resources" }, { "name": "Bind" }, { "name": "Payment Plans" }, { "name": "Insured Clearance" }, { "name": "Loss History" }, { "name": "Underwriting Questions" }, { "name": "Terms of Agreement" } ] }