{"openapi":"3.0.1","info":{"title":"HO6 Policy Quote","description":"Allows partner agencies quote and bind policies across HO6 lines. It also provides metadata about the services.","contact":{"name":"API Support","url":"https://developer.mercuryinsurance.com","email":"apisupport@mercuryinsurance.com"},"version":""},"servers":[{"url":"https://api.mercuryinsurance.com/api","description":"Production Environment"},{"url":"https://sandbox-api.mercuryinsurance.com/api","description":"Sandbox Environment"}],"security":[{"BearerAuth":[]}],"tags":[{"name":"Quote"},{"name":"Quote Additional Insured"},{"name":"Quote Dwelling"},{"name":"Quote Dwelling Additional Interest"},{"name":"Quote Dwelling Construction"},{"name":"Quote Dwelling Coverages"},{"name":"Quote Dwelling Losses"},{"name":"Quote Dwelling Qualifications"},{"name":"Quote Dwelling Resident"},{"name":"Quote Payments"}],"paths":{"/ho6-policy-quote/v1/bridge/{quoteNumber}":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to bridge a quote created via our ACORD XML RC1 API offering","operationId":"bridgeQuote","parameters":[{"name":"quoteNumber","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Successfully retrieved job informations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BridgeResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/initiate/crossSell":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to create a cross sell quote and will return a unique ID representing a specific quote to be in used in other endpoints.","operationId":"initiateCrossSellQuote","parameters":[{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateCrossSellQuoteRequest"}}},"required":true},"responses":{"201":{"description":"Represents the successful response for creating a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateCrossSellQuoteResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/transaction/{quoteNumber}":{"get":{"tags":["Quote"],"summary":"This API allows a consumer to retrieve transaction id for a Quote","operationId":"getTransactionIdByQuoteNumber","parameters":[{"name":"quoteNumber","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"zipCode","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents a successful Retrieval of Transaction Id for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteSearchResponse"}}}},"404":{"description":"Represents when quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/initiate":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to create a new HO6 quote and will return a unique ID representing a specific quote to be in used in other endpoints.","operationId":"initiateQuote","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateQuoteHO6Request"}}},"required":true},"responses":{"201":{"description":"Represents the successful response for creating a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateQuoteHO6Response"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/quickQuote":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to create a new HO6 quote and will return a unique ID representing a specific quote to be in used in other endpoints.","operationId":"quickQuote","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickQuoteHO6"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for retrieving policy coverages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickQuoteResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/bind":{"post":{"tags":["Quote"],"summary":"This API provides the consumer the ability to bind an HO6 quote.","operationId":"bind","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for binding the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BindQuoteResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling":{"get":{"tags":["Quote Dwelling"],"summary":"This API allows a consumer to retrieve Dwellings on an HO6 quote.","operationId":"getDwellings","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving dwellings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}":{"put":{"tags":["Quote Dwelling"],"summary":"This API allows a consumer to update a Dwelling on an HO6 quote.","operationId":"updateDwelling","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dwelling"}}},"required":true},"responses":{"200":{"description":"Indicates the Dwelling was updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/construction":{"get":{"tags":["Quote Dwelling Construction"],"summary":"This API allows a consumer to retrieve the construction details on a Dwelling on an HO6 quote.","operationId":"getDwellingConstruction","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Indicates the dwelling construction details were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingConstruction"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Quote Dwelling Construction"],"summary":"This API allows a consumer to update construction details on a dwelling on an HO6 quote.","operationId":"updateDwellingConstruction","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingConstruction"}}},"required":true},"responses":{"200":{"description":"Indicates the dwelling construction details were updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/coverage":{"get":{"tags":["Quote Dwelling Coverages"],"summary":"This API allows a consumer to retrieve quote coverages on an HO6 quote.","operationId":"getQuoteCoverages","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving policy coverages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverages"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Quote Dwelling Coverages"],"summary":"This API allows a consumer to update quote coverages on an HO6 quote.","operationId":"updateQuoteCoverages","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverages"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for retrieving policy coverages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/interest":{"get":{"tags":["Quote Dwelling Additional Interest"],"summary":"This API allows a consumer to retrieve Dwelling Additional Interests on an HO6 quote.","operationId":"getAdditionalInterest","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving additional interests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInterestArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"post":{"tags":["Quote Dwelling Additional Interest"],"summary":"This API allows a consumer to add Dwelling Additional Interest on an HO6 quote.","operationId":"addAdditionalInterest","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInterest"}}},"required":true},"responses":{"201":{"description":"Represents the successful response for creating an interest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/interest/{interestId}":{"put":{"tags":["Quote Dwelling Additional Interest"],"summary":"This API allows a consumer to update Dwelling Additional Interest on an HO6 quote.","operationId":"updateAdditionalInterest","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"interestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInterest"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for updating an interest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"delete":{"tags":["Quote Dwelling Additional Interest"],"summary":"This API allows a consumer to delete Dwelling Additional Interest on an HO6 quote.","operationId":"deleteAdditionalInterest","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"interestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for deleting an interest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/loss":{"get":{"tags":["Quote Dwelling Losses"],"summary":"This API allows a consumer to retrieve losses on an HO6 quote.","operationId":"getLosses","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Indicates the losses were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Losses"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"post":{"tags":["Quote Dwelling Losses"],"summary":"Allows a user to add a Homeowner loss.  User cannot add an auto loss","operationId":"addLoss","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoLoss"}}},"required":true},"responses":{"201":{"description":"Indicates the loss were added successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/loss/{lossId}":{"put":{"tags":["Quote Dwelling Losses"],"summary":"Allows a user to update a user entered loss","operationId":"updateLoss","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"lossId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoLoss"}}},"required":true},"responses":{"200":{"description":"Indicates the loss were updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"delete":{"tags":["Quote Dwelling Losses"],"summary":"Allows a user to update a user entered loss","operationId":"deleteLoss","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"lossId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Indicates the loss were deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/qualification":{"get":{"tags":["Quote Dwelling Qualifications"],"summary":"This API allows a consumer to retrieve qualification questions for a dwelling on an HO6 quote.","operationId":"getQualifications","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Indicates the qualification questions were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Qualification"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Quote Dwelling Qualifications"],"summary":"This API allows a consumer to update qualification questions for a dwelling on an HO6 quote.","operationId":"updateQualifications","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Qualification"}}},"required":true},"responses":{"200":{"description":"Indicates the qualification questions were updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/resident":{"get":{"tags":["Quote Dwelling Resident"],"summary":"This API allows a consumer to retrieve dwelling residents on an HO6 quote.","operationId":"getResidents","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving dwelling residents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingResidentArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"post":{"tags":["Quote Dwelling Resident"],"summary":"This API allows a consumer to add a resident to an existing dwelling on an HO6 quote.","operationId":"addResident","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingResident"}}},"required":true},"responses":{"201":{"description":"Represents the successful response for creating a resident","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/dwelling/{dwellingId}/resident/{residentId}":{"put":{"tags":["Quote Dwelling Resident"],"summary":"This API allows a consumer to update a dwelling resident on an HO6 quote.","operationId":"updateResident","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"residentId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellingResident"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for updating a resident","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"delete":{"tags":["Quote Dwelling Resident"],"summary":"This API allows a consumer to delete a dwelling resident on an HO6 quote.","operationId":"deleteResident","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"dwellingId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"residentId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for deleting a resident","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/insured":{"get":{"tags":["Quote Additional Insured"],"summary":"This API allows a consumer to retrieve Insureds on an HO6 quote.","operationId":"getAdditionalInsured","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving additional insured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInsuredArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"post":{"tags":["Quote Additional Insured"],"summary":"This API allows a consumer to add an Insured to an existing Quote.","operationId":"addAdditionalInsured","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInsured"}}},"required":true},"responses":{"201":{"description":"Represents the successful response for creating an Insured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/insured/{insuredId}":{"put":{"tags":["Quote Additional Insured"],"summary":"This API allows a consumer to update an Insured on an HO6 quote.","operationId":"updateAdditionalInsured","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"insuredId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdditionalInsured"}}},"required":true},"responses":{"200":{"description":"Indicates the Insured was updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"delete":{"tags":["Quote Additional Insured"],"summary":"Deletes an existing Insured","operationId":"deleteAdditionalInsured","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"insuredId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for deleting the Insured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/paymentMethod":{"get":{"tags":["Quote Payments"],"summary":"Retrieves the latest embedded payment methods that have been set up.","operationId":"getPaymentMethods","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response to retrieve payment methods on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentMethodResponseArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}},"post":{"tags":["Quote Payments"],"summary":"Allows user to establish a payment method for down payment and if applicable, installment payments","operationId":"postPaymentMethods","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentMethodRequest"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for creating a payment method","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentMethodResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}},"/ho6-policy-quote/v1/{state}/{id}/paymentOption":{"get":{"tags":["Quote Payments"],"summary":"Provides details of pay plan  options after successful rate such as installment amounts and installment dates.","operationId":"getPayPlanOptions","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response to retrieve pay plan options on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDetailArrayComponents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Quote Payments"],"summary":"Allows a user to update to a different pay plan option from what is currently used to rate. 'paymentOptionId' can be obtained from the 'Retrieve Pay Plan Options' API","operationId":"putPayPlan","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOption"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for setting the payment option","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}}},"/ho6-policy-quote/v1/{state}/{id}/policyinfo":{"get":{"tags":["Quote"],"summary":"This API allows a consumer to retrieve an existing HO6 quote info information.","operationId":"getQuoteInfo","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","in":"query","description":"Controls which fields are returned/validated: \"all\" (default), \"changeRequestOnly\" (change-request fields), \"quoteRequestOnly\" (quote-request fields), \"skipValidation\" (skip field validations)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["all","changeRequestOnly","quoteRequestOnly","skipValidation"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for retrieving a quotes policy info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyInfo"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Quote"],"summary":"This API allows a consumer to update an existing HO6 quote information.","operationId":"updateQuoteInfo","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyInfo"}}},"required":true},"responses":{"200":{"description":"Represents the successful response for updating a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}}}},"/ho6-policy-quote/v1/{state}/{id}/rate":{"get":{"tags":["Quote"],"summary":"This API provides the consumer the ability to rate an HO6 quote.","operationId":"rate","parameters":[{"name":"state","in":"path","description":"Two-letter state code. Valid values depend on the line of business.","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["AZ","CA","TX"]}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"rateType","in":"query","description":"Rating call type: \"1\" (RC1 - initial rating) or \"2\" (RC2 - final rating)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["1","2"]}},{"name":"partner-username","in":"header","description":"Represents the authorized username of the consumer/person invoking this service","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"bob@something.com"}},{"name":"partner-transaction-id","in":"header","description":"Represents a meaningful transaction id to the partner system","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"99563ab4-c1fa-4972-97f8-b2b45c30957d"}},{"name":"user-application-name","in":"header","description":"Represents name of the user application","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"MyAgentApp"}},{"name":"user-application-type","in":"header","description":"Represents type of the user application, allowed values are Consumer, Agent or Other","required":false,"style":"simple","explode":false,"schema":{"type":"string","example":"Agent"}}],"responses":{"200":{"description":"Represents the successful response for rating a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRateResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a request is made for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the operation cannot be completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"AccountDetail":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The account number captured. Value will be masked when retrieved displaying hte last 4 digits only","readOnly":true,"example":"*****5656"},"bankName":{"type":"string","description":"The name of the bank the account information applies to","readOnly":true,"example":"My Bank"},"routingNumber":{"type":"string","description":"The routing number captured","readOnly":true,"example":"123456789"}},"description":"Details of captured account information","readOnly":true},"AdditionalDetail":{"type":"object","properties":{"key":{"type":"string","description":"The Key of the Additional Detail"},"value":{"type":"string","description":"The Value of the Additional Detail"}},"description":"Represents a single Additional Detail in the Message"},"AdditionalInsured":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/AdditionalInsuredAddress"},"companyName":{"type":"string","description":"The name of the trust or other company","readOnly":true},"firstName":{"type":"string","description":"The first name of the additional insured"},"id":{"type":"string","description":"Unique numeric number for each additional insured","readOnly":true},"lastName":{"type":"string","description":"The last name of the additional insured"},"middleInitial":{"type":"string","description":"The middle initial of the additional insured"},"otherRelationship":{"type":"string","description":"when relationship to insured is 'Other'"},"relationshipToInsured":{"type":"string","description":"Identifies the relationship of the additional named insured or additional insured to the Named Insured"},"suffix":{"type":"string","description":"The suffix to the last name of the additional insured"},"type":{"type":"string","description":"Indicates if person being added is an additional named insured or an additional insured"}}},"AdditionalInsuredAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one of the additional named insured or additional insured"},"addressLineTwo":{"type":"string","description":"Address line two of the additional named insured or additional insured"},"city":{"type":"string","description":"City of of the additional named insured or additional insured"},"state":{"type":"string","description":"State of of the additional named insured or additional insured"},"zipCode":{"type":"string","description":"Zipcode of of the additional named insured or additional insured"}}},"AdditionalInsuredArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInsured"}},"AdditionalInterest":{"type":"object","properties":{"additionalInterestType":{"type":"string","description":"Indicates if the additional interest is a mortgage, trust, vesting, or certificate holder."},"certificateHolder":{"$ref":"#/components/schemas/AdditionalInterestCertificateHolder"},"id":{"type":"string","description":"A unique value that represents an additional interest.","readOnly":true},"mortgage":{"$ref":"#/components/schemas/AdditionalInterestMortgage"},"trust":{"$ref":"#/components/schemas/AdditionalInterestTrust"},"vesting":{"$ref":"#/components/schemas/AdditionalInterestVesting"}}},"AdditionalInterestArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInterest"}},"AdditionalInterestCertificateHolder":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/AdditionalInterestCertificateHolderAddress"},"name":{"type":"string","description":"The name of the certificate holder."}}},"AdditionalInterestCertificateHolderAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"AdditionalInterestMortgage":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/AdditionalInterestMortgageAddress"},"impound":{"type":"string","description":"Indicates if you wish to impound the account"},"loanNumber":{"type":"string","description":"The loan number for the mortgage"},"name":{"type":"string","description":"The name of the mortgage company."},"nameLineThree":{"type":"string","description":"The third name or third line needed of the mortgage company. Must send a nameTwo value before or with this value to add this value. Applies to mortgage only"},"nameLineTwo":{"type":"string","description":"The second name or second line needed of the mortgage company. Must send a name value before or with this value to add this value. Applies to mortgage only"},"number":{"type":"string","description":"Indicates if mortgage is first, second, or third."}}},"AdditionalInterestMortgageAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"AdditionalInterestTrust":{"type":"object","properties":{"companyInformation":{"$ref":"#/components/schemas/AdditionalInterestTrustCompanyInformation"},"trusteeInformation":{"$ref":"#/components/schemas/AdditionalInterestTrustTrusteeInformation"}}},"AdditionalInterestTrustCompanyInformation":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/AdditionalInterestTrustCompanyInformationAddress"},"nameOfTrust":{"type":"string","description":"The name of the trust."}}},"AdditionalInterestTrustCompanyInformationAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"AdditionalInterestTrustTrusteeInformation":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/AdditionalInterestTrustTrusteeInformationAddress"},"firstName":{"type":"string","description":"The first name of the trustee."},"lastName":{"type":"string","description":"The last name of the trustee."},"middleInitial":{"type":"string","description":"The middle initial of the trustee."},"suffix":{"type":"string","description":"The suffix of the trustee."}}},"AdditionalInterestTrustTrusteeInformationAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"AdditionalInterestVesting":{"type":"object","properties":{"otherDescription":{"type":"string","description":"Required if Vesting name is OTHER"},"vesting":{"type":"string","description":"Indicates how property will be/is vested"}}},"Agent":{"type":"object","properties":{"agency":{"type":"string","description":"Name of the agency that sold and services the policy. This can be the same as the organization or can be different."},"agencyEmail":{"type":"string","description":"The email address of the agency that sold and services the policy.","readOnly":true},"agencyPhoneNumber":{"type":"string","description":"The main phone number of the agency that sold and services the policy. Must be numeric.","readOnly":true},"organization":{"type":"string","description":"Name of the agency that sold and services the policy. This is the main or master agency name.","readOnly":true},"partnershipLevel":{"type":"string","description":"","readOnly":true},"subAgentCode":{"type":"string","description":"Optional value that indicates something or someone more specific inside an agency."}}},"AutoInformation":{"type":"object","properties":{"autoAtFaultCount":{"type":"integer","description":"The number of at-fault accidents on the primary named insured's most recent private passenger policy.","format":"int32"},"autoBiLimits":{"type":"string","description":"The BI Limits on your most recent private passenger policy."}}},"AutoLoss":{"type":"object","properties":{"description":{"type":"string","description":"A brief description of the loss.","readOnly":true},"driver":{"type":"string","description":"The name of the driver for auto based losses. This is either the named insured or unassigned. This field cannot be used to POST or Add an auto loss as users cannot add auto losses","readOnly":true},"id":{"type":"string","description":"A unique ID that represents a specific prior loss","readOnly":true},"lossDetail":{"$ref":"#/components/schemas/LossDetail"},"reason":{"type":"string","description":"The reason for the auto loss","readOnly":true},"source":{"type":"string","description":"Indicates the source of the loss record","readOnly":true},"status":{"type":"string","description":"Indicates the chargeable status of the loss for Auto based losses","readOnly":true},"violationDate":{"type":"string","description":"The date the loss occurred","format":"date","readOnly":true}},"readOnly":true},"BillingDetail":{"type":"object","properties":{"billingType":{"type":"string","description":"The bill plan used for rate","readOnly":true,"example":"Automatic Bank Account"},"billingTypeCode":{"type":"string","description":"An indicator that represents the billing type","readOnly":true,"example":"EFT"},"downPaymentMethods":{"type":"array","description":"Indicates how the down payment will be paid based on allowed options","items":{"$ref":"#/components/schemas/DownPaymentMethod"}},"payPlanOptions":{"type":"array","description":"Pay Plan options available for Billing Type","items":{"$ref":"#/components/schemas/PayPlan"}},"totalPremium":{"type":"number","description":"The total premium for the quote based on billing option","format":"double","readOnly":true,"example":1073.22}}},"BillingDetailArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/BillingDetail"}},"BindQuoteResponse":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"policyNumber":{"type":"string","description":"The policy number of the bound policy","readOnly":true,"example":"CAAP0000000000"},"policyStatus":{"type":"string","description":"The policy status of the bound policy","readOnly":true,"example":"In Force"},"termEffDate":{"type":"string","description":"The term effective date of the policy","format":"date","readOnly":true,"example":"2024-12-19"},"termExpDate":{"type":"string","description":"The term expiration date of the policy","format":"date","readOnly":true,"example":"2024-12-19"}},"description":"Represents the Response for the Bind Quote API"},"BridgeResponse":{"type":"object","properties":{"agentURL":{"type":"string"},"consumerURL":{"type":"string"},"id":{"type":"string","description":"Unique identifier for the quote entity","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"description":"Response for bridging endpoint"},"CancellationInformation":{"type":"object","properties":{"cancelFinalDate":{"type":"string","description":"The date a policy was officially cancelled final.","format":"date","readOnly":true},"cancellationEffectiveDate":{"type":"string","description":"The effective date a policy will cancel.","format":"date","readOnly":true},"cancellationMailDate":{"type":"string","description":"The date the cancellation notice was mailed to named insured.","format":"date","readOnly":true}},"readOnly":true},"CardDetail":{"type":"object","properties":{"cardNumber":{"type":"string","description":"The card number captured. Value will be masked when retrieved displaying the last 4 digits only","readOnly":true,"example":"*****5656"},"cardType":{"type":"string","description":"The type of credit card provided","readOnly":true,"example":"Visa"},"expirationDate":{"type":"string","description":"The expiration date of the captured card","format":"mm/yyyy","readOnly":true,"example":"12/2025"}},"description":"Details of captured card information","readOnly":true},"CoveragePayoutInformation":{"type":"object","properties":{"coverageCode":{"type":"string","description":"Vendor provided two digit coverage code indicating what coverage the payment is being made under","readOnly":true},"coverageStatus":{"type":"string","description":"Indicates if the payments for the coverage are still open or if payments have ceased under this coverage","readOnly":true},"paymentAmount":{"type":"string","description":"The amount the reporting carrier has paid out under a specific coverage","readOnly":true}},"readOnly":true},"Coverages":{"type":"object","properties":{"additionalCoverages":{"$ref":"#/components/schemas/CoveragesAdditionalCoverages"},"enhancedHomePackage":{"type":"string","description":"A Yes or No value indicating if the Enhanced Home Package is desired"},"optionalCoverages":{"$ref":"#/components/schemas/CoveragesOptionalCoverages"},"policyDeductibles":{"$ref":"#/components/schemas/PolicyDeductibles"},"sectionIandII":{"$ref":"#/components/schemas/CoveragesSectionIandII"},"specialLimitsOfLiability":{"$ref":"#/components/schemas/CoveragesSpecialLimitsOfLiability"},"valuableItemsPlus":{"type":"array","description":"Indicates if optional blanket coverage on jewelry, silverware, fine arts, furs, cameras, firearms, computers, musical instruments, and china/crystal as provided under Section I by endorsement is desired","items":{"$ref":"#/components/schemas/CoveragesValuableItemsPlus"}}}},"CoveragesAdditionalCoverages":{"type":"object","properties":{"businessPropIncLimit":{"type":"string","description":"Indicates the limit for Business Property Increased Limits On/Off Premises"},"creditCardEFTForgery":{"type":"string","description":"Indicates the limit for Credit Card, EFT Card, Forgery, Etc. NOTE: Coverage does not apply if property/occupancy is Secondary/Seasonal"},"damageToPropertyOfOthers":{"type":"string","description":"Indicates the limit for Damage to Property of Others. NOTE: Coverage does not apply if property/occupancy is Secondary/Seasonal"},"homeCyberProtection":{"$ref":"#/components/schemas/CoveragesHomeCyberProtection"},"homeSystemProtection":{"type":"string","description":"A YyNn value indicates if Home Systems Protection coverage (50,000/500) is desired"},"identityFraudExpenseResolutionServices":{"type":"string","description":"A YyNn value indicates if coverage to cover expenses incurred by the insured as a result of the fraudulent use of the insured's identity by a third party is desired. NOTE: Coverage does not apply if property/occupancy is Secondary/Seasonal"},"limitedHiddenWaterSteamSeepageOrLeakageLimit":{"type":"string","description":"Indicates if coverage for hidden damage, including deterioration or rot, to covered property caused by constant or repeated seepage or leakage of hidden water or steam from within a plumbing, heating, air conditioning, sprinkler system, or household appliance is desired"},"lossAssessment":{"type":"string","description":"Indicates the limit for Loss Assessment Coverage - Residence Premises Limit"},"personalInjury":{"type":"string","description":"A YyNn value indicating if the additional coverage Personal Injury is desired. NOTE: Coverage does not apply if propertyOccupancy is Secondary/Seasonal"},"personalPropReplacementCost":{"type":"string","description":"A YyNn value indicates if the additional coverage Personal Property Replacement Cost is desired"},"refrigeratedProducts":{"type":"string","description":"Indicates the limit for Refrigerated Products Coverage"},"specialPersonalProperty":{"type":"string","description":"A YyNn value indicates if coverage against risks of direct physical loss for Coverage C – Personal Property"},"waterBackupSumpDischargeLimit":{"type":"string","description":"Indicates if coverage for property loss resulting from water or waterborne material which backs up through sewers or drains or which overflows or is discharged from a sump, sump pump or related equipment is desired"}}},"CoveragesHomeCyberProtection":{"type":"object","properties":{"deductible":{"type":"string","description":"The deductible that applies to Home Cyber Protection coverage","readOnly":true},"limit":{"type":"string","description":"The limit of Home Cyber Protection desired"}}},"CoveragesOptionalCoverages":{"type":"object","properties":{"liability":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiability"},"property":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesProperty"}}},"CoveragesOptionalCoveragesLiability":{"type":"object","properties":{"additionalResidenceRentedToOthers":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthers"},"businessPursuits":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityBusinessPursuits"},"otherInsuredLocationsOccupiedNamedInsured":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOtherInsuredLocationsOccupiedNamedInsured"},"permittedIncidentalOccupanciesCoverages":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityPermittedIncidentalOccupanciesCoverages"},"watercraftLiability":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityWatercraftLiability"}}},"CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthers":{"type":"object","properties":{"additionalResidenceRentedToOthersRecord":{"type":"array","description":"If coverage is desired, enter at least one type of residence and the address record. Required if coverageSelected=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthersRecord"}},"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthersRecord":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthersRecordAddress"},"id":{"type":"string","description":"Unique ID that identifies an additional residence rented to others record"},"locationType":{"type":"string","description":"Location Type"}}},"CoveragesOptionalCoveragesLiabilityAdditionalResidenceRentedToOthersRecordAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"CoveragesOptionalCoveragesLiabilityBusinessPursuits":{"type":"object","properties":{"businessType":{"type":"string","description":"Business Type"},"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidences":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"offPremisesOtherResidencesRecord":{"type":"array","description":"If coverage is desired, enter at least one other residence record. Required if coverageSelected=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidencesRecord"}}}},"CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidencesRecord":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidencesRecordAddress"},"businessDescription":{"type":"string","description":"Description of the on premises other structure"},"id":{"type":"string","description":"Unique ID that identifies an off premises other residence record"}}},"CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidencesRecordAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"CoveragesOptionalCoveragesLiabilityOnPremisesOtherStructures":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if On-Premises Residence Premises coverage is desired"},"onPremisesOtherStructuresRecord":{"type":"array","description":"If coverage is desired, enter at least one other structure record. Required if coverageRequested=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOnPremisesOtherStructuresRecord"}}}},"CoveragesOptionalCoveragesLiabilityOnPremisesOtherStructuresRecord":{"type":"object","properties":{"businessDescription":{"type":"string","description":"Description of the on premises other structure"},"coverageBTotalLimit":{"type":"integer","description":"Indicates Coverage B total limit","format":"int32"},"id":{"type":"string","description":"Unique ID that identifies a on premises other structures record"},"structureDescription":{"type":"string","description":"Description of the on premises other structure structure"}}},"CoveragesOptionalCoveragesLiabilityOnPremisesResidencePremises":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if On-Premises Residence Premises coverage is desired"},"description":{"type":"string","description":"Unique description of on-premises residence"}}},"CoveragesOptionalCoveragesLiabilityOtherInsuredLocationsOccupiedNamedInsured":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"otherInsuredLocationsOccupiedNamedInsuredRecord":{"type":"array","description":"If coverage is desired, enter at least one other insured location occupied by the named insured. Required if coverageSelected=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOtherInsuredLocationsOccupiedNamedInsuredRecord"}}}},"CoveragesOptionalCoveragesLiabilityOtherInsuredLocationsOccupiedNamedInsuredRecord":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/OtherInsuredLocationsOccupiedNamedInsuredRecordAddress"},"id":{"type":"string","description":"Unique ID that identifies an other insured location occupied by the named insured record"},"locationType":{"type":"string","description":"Location Type"}}},"CoveragesOptionalCoveragesLiabilityPermittedIncidentalOccupanciesCoverages":{"type":"object","properties":{"offPremisesOtherResidences":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOffPremisesOtherResidences"},"onPremisesOtherStructures":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOnPremisesOtherStructures"},"onPremisesResidencePremises":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityOnPremisesResidencePremises"}}},"CoveragesOptionalCoveragesLiabilityWatercraftLiability":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"watercraftLiabilityRecord":{"type":"array","description":"If coverage is desired, enter at least one watercraft record. Required if coverageSelected=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftRecord"}}}},"CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwner":{"type":"object","properties":{"contactEmails":{"type":"array","description":"Email addresses of the contact","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwnerContactEmail"}},"contactPhones":{"type":"array","description":"Phone numbers of the contact","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwnerContactPhone"}},"dateOfBirth":{"type":"string","description":"Date of birth","format":"date"},"firstName":{"type":"string","description":"First Name"},"id":{"type":"string","description":"A unique ID that identifies an contact record"},"lastName":{"type":"string","description":"Last Name"},"maritalStatus":{"type":"string","description":"The marital status"},"middleInitial":{"type":"string","description":"middleInitial"},"suffix":{"type":"string","description":"Optional suffix of the named insured."}}},"CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwnerContactEmail":{"type":"object","properties":{"emailAddress":{"type":"string","description":"The primary email address for the contact"},"type":{"type":"string","description":"Indicates if email is primary or secondary"}}},"CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwnerContactPhone":{"type":"object","properties":{"countryCode":{"type":"string","description":"If phone number is not based in the United States, the country the phone number provided is associated with"},"phoneExtension":{"type":"string","description":"Any extension to the phone number if needed."},"phoneNumber":{"type":"string","description":"A unique 10 digit phone number."},"phoneType":{"type":"string","description":"Indicates if the phone number is a home number, work number, or mobile number."},"primary":{"type":"string","description":"A Y/N value indicating if the number is to be the primary number to be used for contact."}}},"CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftRecord":{"type":"object","properties":{"horsepower":{"type":"integer","description":"The number of horsepower in the watercrafts motor(s)","format":"int32"},"id":{"type":"string","description":"A unique ID that identifies a watercraft liability record"},"length":{"type":"integer","description":"The length in feet of the watercraft","format":"int32"},"modelYear":{"type":"string","description":"Model year of watercraft"},"owner":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesLiabilityWatercraftLiabilityWatercraftOwner"},"typeOfWaterCraft":{"type":"string","description":"The type of watercraft"},"watercraftDescription":{"type":"string","description":"Description of the watercraft"}}},"CoveragesOptionalCoveragesMotorizedGolfCart":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"limit":{"type":"string","description":"Limit of coverage set by system","readOnly":true}}},"CoveragesOptionalCoveragesOtherMembersNamedInsuredHousehold":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"otherMembersNamedInsuredHouseholdRecord":{"type":"array","description":"If coverage is desired, enter at least one other member of named insured household record. Required if coverageRequested=Y. Maximum 6 entries.","items":{"$ref":"#/components/schemas/OtherMembersNamedInsuredHouseholdRecord"}}}},"CoveragesOptionalCoveragesProperty":{"type":"object","properties":{"assistedLivingCare":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCare"},"buildingAddAlterationsOtherResidences":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidences"},"greenHomeAdditionalCoverage":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyGreenHomeAdditionalCoverage"},"motorizedGolfCart":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesMotorizedGolfCart"},"otherMembersNamedInsuredHousehold":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesOtherMembersNamedInsuredHousehold"},"personalPropIncreasedLimitOtherResidences":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyPersonalPropIncreasedLimitOtherResidences"},"residenceGlassCoverage":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyResidenceGlassCoverage"},"residenceHeldInTrust":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyResidenceHeldInTrust"},"residenceRentalTheft":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyResidenceRentalTheft"},"specifiedStructuresAwayFromResidence":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidence"},"structuresRentedToOthers":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyStructuresRentedToOthers"},"studentsLivingAwayFromResidence":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesStudentsLivingAwayFromResidence"},"unitOwnersUnitsRegularlyRentedToOthers":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyUnitOwnersUnitsRegularlyRentedToOthers"},"watercraftHullCoverage":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyWatercraftHullCoverage"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCare":{"type":"object","properties":{"assistedLivingCareRecord":{"type":"array","description":"Information regarding name of relative or contact for Assisted Living Care and other details. Required if coverageRequested=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareRecord"}},"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareContactEmail":{"type":"object","properties":{"emailAddress":{"type":"string","description":"The primary email address for the contact"},"type":{"type":"string","description":"Indicates if email is primary or secondary"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareContactPhone":{"type":"object","properties":{"countryCode":{"type":"string"},"phoneExtension":{"type":"string","description":"Any extension to the phone number if needed"},"phoneNumber":{"type":"string","description":"A unique 10 digit phone number"},"phoneType":{"type":"string","description":"Indicates if the phone number is a home number, work number or mobile number"},"primary":{"type":"string","description":"A Y/N value indicating if the number is to be the primary number to be used for contact"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareFacility":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareFacilityAddress"},"nameOfFacility":{"type":"string","description":"Name of the Assisted Living Care facility"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareFacilityAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one"},"addressLineTwo":{"type":"string","description":"Address line two"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State"},"zipCode":{"type":"string","description":"Zip Code of the dwelling. Must be 5 or 5 + 4 format"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareNameOfRelativeOrContact":{"type":"object","properties":{"contactEmails":{"type":"array","description":"Email addresses of the contact","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareContactEmail"}},"contactPhones":{"type":"array","description":"Phone numbers of the contact","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareContactPhone"}},"dateOfBirth":{"type":"string","description":"Date of Birth","format":"date"},"firstName":{"type":"string","description":"First Name"},"id":{"type":"string","description":"A unique ID that identifies an contact record"},"lastName":{"type":"string","description":"Last Name"},"maritalStatus":{"type":"string","description":"Marital status"},"middleInitial":{"type":"string","description":"If phone number is not based in the United States, the country the phone number provided is associated with"},"suffix":{"type":"string","description":"Suffix"}}},"CoveragesOptionalCoveragesPropertyAssistedLivingCareRecord":{"type":"object","properties":{"covCBaseLimit":{"type":"string","description":"The base limit for Coverage C","readOnly":true},"covCTotalLimit":{"type":"integer","description":"The Coverage C total limit desired. Defaults to covCBaseLimit but can be up to $999,999","format":"int32"},"facility":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareFacility"},"id":{"type":"string","description":"A unique ID that identifies an assisted living care record"},"nameOfRelativeOrContact":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyAssistedLivingCareNameOfRelativeOrContact"}}},"CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidences":{"type":"object","properties":{"buildingAddAlterationsOtherResidencesRecord":{"type":"array","description":"If coverage is desired, enter at least one building addition and alteration record. Required if coverageRequested=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidencesRecord"}},"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidencesRecord":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidencesRecordAddress"},"id":{"type":"string","description":"A unique ID that identifies a building addition and alteration record"},"totalLimit":{"type":"integer","description":"The total limit of coverage for building additions and alterations","format":"int32"}}},"CoveragesOptionalCoveragesPropertyBuildingAddAlterationsOtherResidencesRecordAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one"},"addressLineTwo":{"type":"string","description":"Address line two"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State"},"zipCode":{"type":"string","description":"Zip Code of the dwelling. Must be 5 or 5 + 4 format"}}},"CoveragesOptionalCoveragesPropertyGreenHomeAdditionalCoverage":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesPropertyPersonalPropIncreasedLimitOtherResidences":{"type":"object","properties":{"baseLimit":{"type":"string","description":"Base Limit","readOnly":true},"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"totalLimit":{"type":"number","description":"Total Limit","format":"double"}}},"CoveragesOptionalCoveragesPropertyResidenceGlassCoverage":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesPropertyResidenceHeldInTrust":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"}}},"CoveragesOptionalCoveragesPropertyResidenceRentalTheft":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired."}}},"CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidence":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"specifiedStructuresAwayFromResidenceRecord":{"type":"array","description":"If coverage is desired, enter at least one specified structures away from residence record. Required if coverageRequested=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidenceRecord"}}}},"CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidenceRecord":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidenceRecordAddress"},"description":{"type":"string","description":"Description of the specified structure away from residence"},"id":{"type":"string","description":"A unique ID that identifies a specified structures away from residence record"},"totalLimit":{"type":"integer","description":"The total limit of coverage for the specified structure away from residence","format":"int32"}}},"CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidenceRecordAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one"},"addressLineTwo":{"type":"string","description":"Address line two"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State"},"zipCode":{"type":"string","description":"Zip Code of the dwelling. Must be 5 or 5 + 4 format"}}},"CoveragesOptionalCoveragesPropertyStructuresRentedToOthers":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"structuresRentedToOthersRecord":{"type":"array","description":"If coverage is desired, enter at least one structures rented to others record. Required if coverageRequested=Y","items":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyStructuresRentedToOthersRecord"}}}},"CoveragesOptionalCoveragesPropertyStructuresRentedToOthersRecord":{"type":"object","properties":{"description":{"type":"string","description":"Description of the structure rented to others"},"id":{"type":"string","description":"A unique ID that identifies a structures rented to others record"},"occupancyType":{"type":"string","description":"Indicates the occupancy type of the structure rented to others"},"totalLimit":{"type":"integer","description":"The total limit of coverage for the structure rented to others","format":"int32"}}},"CoveragesOptionalCoveragesPropertyUnitOwnersUnitsRegularlyRentedToOthers":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired."}}},"CoveragesOptionalCoveragesPropertyWatercraftHullCoverage":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"totalLimit":{"type":"string","description":"Indicates the limit of coverage for owned watercraft, their furnishings, equipment and outboard motors may be provided on a non-specified peril basis is desired"}}},"CoveragesOptionalCoveragesStudentsLivingAwayFromResidence":{"type":"object","properties":{"coverageRequested":{"type":"string","description":"A YyNn value indicates if coverage is desired"},"studentsLivingAwayFromResidenceRecord":{"type":"array","description":"If coverage is desired, enter at least one student living away from the residence record.\nRequired if coverageRequested=Y","items":{"$ref":"#/components/schemas/StudentsLivingAwayFromResidenceRecord"}}}},"CoveragesSectionIandII":{"type":"object","properties":{"coverageADwelling":{"type":"integer","description":"The dollar amount to be covered as the dwelling limit","format":"int32"},"coverageCPersonalProperty":{"type":"integer","description":"The desired Coverage C Personal Property limit","format":"int32"},"coverageDLossOfUse":{"type":"integer","description":"The desired Coverage D Loss of Use limit","format":"int32"},"coverageEPersonalLiability":{"type":"string","description":"The desired Coverage E Personal Liability limit. NOTE: Coverage does not apply if property/occupancy is Secondary/Seasonal"},"coverageFMedicalPayments":{"type":"string","description":"The desired Coverage F Medical Payments limit. NOTE: Coverage does not apply if property/occupancy is Secondary/Seasonal"}}},"CoveragesSpecialLimitsOfLiability":{"type":"object","properties":{"electronicApparatusInOnVehicle":{"type":"integer","description":"Limit of coverage desired for Electronic Apparatus in or upon a motor vehicle.  Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"firearms":{"type":"integer","description":"Limit of coverage desired for Firearms  Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"homeComputers":{"type":"integer","description":"Limit of coverage desired for Home Computers.  Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"jewelryAndFurs":{"type":"integer","description":"Limit of coverage desired for Jewelry, Watches and Furs. Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"moneyCoins":{"type":"integer","description":"Limit of coverage desired for Money and Coins. Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"securitiesStamps":{"type":"integer","description":"Limit of coverage desired for Securities and Stamps. Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"silverwareGoldwarePewterware":{"type":"integer","description":"Limit of coverage desired for Silverware, Goldware and Pewterware.  Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"},"tapesRecordsOtherMediaInOnVehicle":{"type":"integer","description":"Limit of coverage desired for Tapes, records, discs or other media in or upon a motor vehicle.  Must be within the minimum and maximum range values. Must be a whole number.  System may round to a specific dollar","format":"int32"}}},"CoveragesValuableItemsPlus":{"type":"object","properties":{"articleOrPropertyType":{"type":"string","description":"The name of the article or property type value"},"description":{"type":"string","description":"Description (must be unique)"},"id":{"type":"string","description":"A unique ID that identifies a valuable items record","readOnly":true},"typeOfCoverage":{"type":"string","description":"Type of Coverage desired"},"value":{"type":"integer","description":"Value of the article or property","format":"int32"}}},"Discount":{"type":"object","properties":{"name":{"type":"string","description":"Discount Name","example":"Good Driver"}}},"DogsAndPets":{"type":"object","properties":{"anyDogsOrPetsInHousehold":{"type":"string","description":"Indicates if household has any dogs or pets"},"dogsPetsDetails":{"$ref":"#/components/schemas/DogsPetsDetails"}}},"DogsPetsDetails":{"type":"object","properties":{"anyAnimalsHaveHistoryOfBiting":{"type":"string","description":"Do any animals have a history of biting?"},"anyPetsWolfHybridZooOrExoticAnimal":{"type":"string","description":"Indicates if any of the pets are a wolf hybrid, zoo animal, or exotic animal"},"dogOrPetOnUnacceptableList":{"type":"string","description":"If household contains an dog breed or pet that is unacceptable. See Unacceptable Pets and Dog Breeds document in Developer Portal - Docs for a state specific list."},"numberOfDogsInHousehold":{"type":"string","description":"The number of dogs in the household"}}},"DownPaymentMethod":{"type":"object","properties":{"paymentMethod":{"type":"string","description":"Name of the payment method","readOnly":true,"example":"CreditDebit"}},"description":"Indicates how the down payment will be paid based on allowed options","readOnly":true},"Dwelling":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/DwellingAddress"},"details":{"$ref":"#/components/schemas/DwellingDetails"},"discountQuestions":{"$ref":"#/components/schemas/DwellingDiscountQuestions"},"homePurchaseDate":{"type":"string","description":"The date the current owner purchased the property","format":"date"},"id":{"type":"string","description":"Unique numeric number for the property","readOnly":true},"locationInformation":{"$ref":"#/components/schemas/DwellingLocationInformation"}}},"DwellingAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one of the dwelling"},"addressLineTwo":{"type":"string","description":"Address line two of the dwelling"},"city":{"type":"string","description":"city of the dwelling"},"county":{"type":"string","description":"The county the address belongs to"},"state":{"type":"string","description":"state of the dwelling"},"zipCode":{"type":"string","description":"Zip Code of the dwelling. Must be 5 or 5 + 4 format"}}},"DwellingArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/Dwelling"}},"DwellingConstruction":{"type":"object","properties":{"constructionType":{"type":"string","description":"A value that indicates how the property was constructed"},"numberOfStories":{"type":"string","description":"Number of stories for the dwelling"},"roofType":{"type":"string","description":"A value that indicates what type of roof the dwelling has"},"yearBuilt":{"type":"integer","description":"The year the dwelling was built","format":"int32"}}},"DwellingDetails":{"type":"object","properties":{"continuouslyInsuredTwelveMonths":{"type":"string","description":"If property has been foreclosed, has the property been continuously insured for the past twelve months?"},"homeSharingActivities":{"type":"string","description":"Indicates if the dwelling is used for home-sharing activities such as renting the home or a portion of the home to others"},"intendToPurchaseCeaPolicy":{"type":"string","description":"Indicates if the insured intends to purchase or currently has a CEA policy"},"isPropertyFenced":{"type":"string","description":"Indicates if property is fenced"},"poolsJacuzzisHotTubsSpasOnPremise":{"type":"string","description":"Indicates if the dwelling has any swimming pools, jacuzzis, hot tubs or spas on the premises"},"propertyForeclosedLastThreeYears":{"type":"string","description":"Indicates if the dwelling has  been foreclosed in the last three years"},"trampolineHaveSafetyNet":{"type":"string","description":"If there is a trampoline on premises,indicates if the trampoline has a safety net"},"trampolineOnPremises":{"type":"string","description":"Indicates if the property has a trampoline on the premises"},"woodCoalPelletStovesOnPremise":{"type":"string","description":"Indicates if the dwelling has Wood, Coal, and Pellet Stoves that includes stoves located in the main dwelling as well as located in other structures on the residence premises"}}},"DwellingDiscountQuestionOtherPolicies":{"type":"object","properties":{"policyNumber":{"type":"string","description":"The Auto or Umbrella Mercury policy number"},"typeOfPolicy":{"type":"string","description":"Indicates if other policy with Mercury is an Auto policy or Umbrella policy"}}},"DwellingDiscountQuestions":{"type":"object","properties":{"homeownersAssociation":{"type":"string","description":"Indicates if the property is part of a homeowner's association"},"otherMercuryPolicies":{"type":"array","description":"Indicates if insured has an Auto or Umbrella policy currently inforce with Mercury","items":{"$ref":"#/components/schemas/DwellingDiscountQuestionOtherPolicies"}},"protectionDevices":{"$ref":"#/components/schemas/DwellingDiscountQuestionsProtectionDevices"},"wildfireMitigation":{"$ref":"#/components/schemas/DwellingDiscountQuestionsWildfireMitigation"}}},"DwellingDiscountQuestionsProtectionDevices":{"type":"object","properties":{"burglarAlarm":{"type":"string","description":"Indicates if dwelling has a burglar alarm installed"},"deadbolts":{"type":"string","description":"Indicates if dwelling has dead bolts on the doors"},"fireAlarm":{"type":"string","description":"Indicates the the property has a fire alarm"},"fireExtinguisher":{"type":"string","description":"Indicates the the property has a fire extinguisher"},"fireSprinklerSystem":{"type":"string","description":"Indicates the the property has a fire sprinkler system"},"gatedCommunity":{"type":"string","description":"Indicates if the dwelling is inside a gated community"},"smokeDetectors":{"type":"string","description":"Indicates the the property has smoke detectors"},"waterLeakDetection":{"type":"string","description":"Indicates if the dwelling is equipped with a qualifying water leak detection system"}}},"DwellingDiscountQuestionsWildfireMitigation":{"type":"object","properties":{"activeIBHSWildfire":{"type":"string","description":"Indicates if the property has an active IBHS Wildfire Prepared Home certification or qualifies for Mercury's Wildfire Mitigation Discount"},"allExteriorVentsFireResistant":{"type":"string","description":"Indicates if all exterior vents are fire-resistant"},"classAFireRatedRoof":{"type":"string","description":"Indicates if the home has a Class A fire rated roof, which includes materials such as asphalt composition shingles, metal, clay or concrete tile, or slate"},"combustibleStructureClearing":{"type":"string","description":"Indicates if all vegetation, debris, mulch, stored combustible materials, and movable combustible objects are cleared within 5 feet of the dwelling"},"communityWildfireMitigation":{"type":"string","description":"Indicates if your community proactively engages in wildfire mitigation activities"},"defensibleSpace":{"type":"string","description":"Indicates if the home meets window, vent, and defensible space requirements for the Fire Resistive Construction Type Discount"},"exteriorWindowsMultiPaneOrHaveFunctionalShutters":{"type":"string","description":"Indicates if all exterior windows are multi-pane windows or if functional shutters are installed on all exterior windows that, when closed, cover the entire window without openings"},"haveEnclosedEaves":{"type":"string","description":"Indicates if the home has enclosed eaves"},"ibcConstructionType":{"type":"string","description":"The International Building Code (IBC) construction type of the dwelling"},"noncombustVertClearance":{"type":"string","description":"Indicates if the home has at least 6 inches of noncombustible vertical clearance at the bottom of the exterior surface of the building"},"outbuildingsCombustible":{"type":"string","description":"Indicates if the area within 30 feet of the dwelling, up to the area under the applicant's control, is clear of any combustible structures"},"propertyComplyPublicResourceCode":{"type":"string","description":"Indicates if the property complies with Section 4291 of the Public Resources Code and any applicable local ordinances governing defensible space"},"shortestDistanceDwelling":{"type":"string","description":"The shortest distance between the dwelling and the closest building or accessory structure"},"vegetationDebrisClearedDwelling":{"type":"string","description":"Indicates if the area within 5 feet of the dwelling is clear of combustible vegetation and materials, or if not clear, that the area is covered with noncombustible material such as concrete, stone, or gravel"},"vegetationDebrisClearedUnderDeck":{"type":"string","description":"Indicates if all vegetation and debris are cleared from under decks"}}},"DwellingLocationInformation":{"type":"object","properties":{"aonScore":{"type":"string","description":"AON wildfire risk score for the property","readOnly":true},"distanceToCoast":{"type":"string","description":"Indicates the distance of the dwelling from the nearest coast"},"distanceToFireStation":{"type":"string","description":"The distance of the dwelling to the nearest fire station in miles"},"fireProtectionArea":{"type":"string","description":"The Public Protection Classification indicated applies in a municipality or classified area where a single classification of fire protection is available","readOnly":true},"firewiseCommunityFlag":{"type":"string","description":"Indicates if the property is located in a Firewise community","readOnly":true},"inWindpool":{"type":"string","description":"Indicates if the property is located in a windpool area"},"lessThousandFeetFireHydrant":{"type":"string","description":"TIs the dwelling less than 1,000 feet from the nearest fire hydrant?"},"protectionClassCode":{"type":"string","description":"The Public Protection Classification listings in the ISO Community Mitigation Classification Manual apply to risks insured under Homeowners Program policies"}}},"DwellingResident":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/ResidentAddress"},"dateOfBirth":{"type":"string","description":"Date of birth of the Resident"},"employment":{"$ref":"#/components/schemas/ResidentEmployment"},"firstName":{"type":"string","description":"First Name of the Resident"},"id":{"type":"string","description":"The unique identifier of the Resident"},"lastName":{"type":"string","description":"Last Name of the Resident"},"middleInitial":{"type":"string","description":"Middle Initial of the Resident"},"otherRelationship":{"type":"string","description":"when relationship to insured is 'Other'"},"relationshipToInsured":{"type":"string","description":"The Resident's relationship to the insured as returned by PolicyCenter"},"suffix":{"type":"string","description":"Suffix of the Resident"}}},"DwellingResidentArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/DwellingResident"}},"EffectiveDates":{"type":"object","properties":{"termEffDate":{"type":"string","description":"The date a policy term took effect.","format":"date"},"termExpDate":{"type":"string","description":"The date a policy term will expire.","format":"date","readOnly":true}}},"FairPlan":{"type":"object","properties":{"fairPlanOrEquivalentPolicy":{"type":"string","description":"Indicates if the insured currently has a FAIR Plan or equivalent policy"},"purchaseBothExtendedAndVandalismCoverage":{"type":"string","description":"Indicates if the insured purchased both extended coverage and vandalism coverage with the FAIR Plan"}}},"GetPaymentMethodResponse":{"type":"object","properties":{"accountDetail":{"$ref":"#/components/schemas/AccountDetail"},"cardDetail":{"$ref":"#/components/schemas/CardDetail"},"paymentMethod":{"type":"string","description":"Indicates the payment method to be used for down payment or future installment.  Agency Sweep is only available for down payment. Paper Bill for installments are not applicable","readOnly":true,"example":"CreditDebit"},"paymentType":{"type":"string","description":"Provides detailed payment information for payment option and payment plan combination"},"status":{"type":"string","description":"The status of a submitted payment method for a quote","readOnly":true,"example":"Validated"}}},"GetPaymentMethodResponseArrayComponents":{"type":"array","items":{"$ref":"#/components/schemas/GetPaymentMethodResponse"}},"HoLoss":{"type":"object","properties":{"chargeable":{"type":"string","description":"Indicates if the claim is chargeable","readOnly":true},"claimant":{"type":"string","description":"A Homeowner only field that lists the name of the claimant","readOnly":true},"claimCause":{"type":"string","description":"The cause of the loss requiring a claim to be made if claim type is Other /Designated Serial Numbered Catastrophe /Non-Designated Serial Numbered Catastrophe"},"claimType":{"type":"string","description":"The type of Claim"},"clueType":{"type":"string","description":"The type of CLUE ordered","readOnly":true},"dateOfLoss":{"type":"string","description":"The date the loss occurred","format":"date"},"description":{"type":"string","description":"A brief description of the loss. This value can be updated if the source of the record is CLUE or User"},"id":{"type":"string","description":"A unique ID that represents a specific prior loss","readOnly":true},"informationSource":{"type":"string","description":"The source from which the loss information was obtained","readOnly":true},"lossLocation":{"type":"string","description":"The location of the loss","readOnly":true},"namedInsured":{"type":"string","description":"The named insured for the loss","readOnly":true},"occupiedByHomeSharingOccupant":{"type":"string","description":"Indicates if the home was occupied by a home sharing occupant at the time of the loss","readOnly":true},"policyType":{"type":"string","description":"A Homeowner only field that indicates the type of policy under which the loss occurred","readOnly":true},"status":{"type":"string","description":"Indicates the status of the loss for Home based losses"},"totalIncurred":{"type":"integer","description":"The total amount paid out for the loss. Sum of all coverages under which monies were paid","format":"int32"}}},"InitiateCrossSellQuoteEffectiveDates":{"required":["termEffDate"],"type":"object","properties":{"termEffDate":{"type":"string","description":"The Effective Date of the Cross Sell Quote","format":"date"}}},"InitiateCrossSellQuoteRequest":{"required":["effectiveDates"],"type":"object","properties":{"baseQuoteNumber":{"type":"string","description":"The base policy that initiates the cross sell quote"},"effectiveDates":{"$ref":"#/components/schemas/InitiateCrossSellQuoteEffectiveDates"},"lob":{"type":"string","description":"Indicates the policy type of the cross sell quote"}},"description":"Represents the Request for the Initiate Cross Sell Quote API"},"InitiateCrossSellQuoteResponse":{"type":"object","properties":{"agentURL":{"type":"string","description":"The URL for agents/underwriters to view the quote in the PolicyCenter (PC) application"},"consumerURL":{"type":"string","description":"The URL for the consumer to continue the quote in the Direct Sales Channel (DSC) application"},"id":{"type":"string","description":"Represents the Quote Id that is used to pass to subsequent operations for the Quote","format":"uuid"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"quoteNumber":{"type":"string","description":"The Quote Number from the System that represents the Quote Number in the Policy Administration System"}},"description":"Represent the response to the Initiate Cross Sell Quote API"},"InitiateQuoteHO6Address":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one of the property address"},"addressLineTwo":{"type":"string","description":"Address line two of the property address"},"addressType":{"type":"string","description":"The Address Type.  Must be \"Property\" for Initiate endpoint"},"city":{"type":"string","description":"City of the property address"},"county":{"type":"string","description":"County of the property address"},"state":{"type":"string","description":"State of the property address"},"zipCode":{"type":"string","description":"Zip Code of the property address"}}},"InitiateQuoteHO6EffectiveDates":{"type":"object","properties":{"termEffDate":{"type":"string","description":"The Effective Date of the Quote","format":"date"}}},"InitiateQuoteHO6NamedInsured":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Date of Birth of the named insured"},"firstName":{"type":"string","description":"First name of the named insured"},"lastName":{"type":"string","description":"Last name of the named insured"},"middleInitial":{"type":"string","description":"Middle initial of the named insured"},"occupationIndustry":{"type":"string","description":"Occupation industry of the named insured."},"occupationType":{"type":"string","description":"Occupation type of the named insured."},"primary":{"type":"string","description":"A Y/N value indicating if this person is the primary named insured"},"suffix":{"type":"string","description":"Suffix of the named insured"}}},"InitiateQuoteHO6PolicyInfo":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/InitiateQuoteHO6Address"},"effectiveDates":{"$ref":"#/components/schemas/InitiateQuoteHO6EffectiveDates"},"namedInsured":{"type":"array","items":{"$ref":"#/components/schemas/InitiateQuoteHO6NamedInsured"}}}},"InitiateQuoteHO6Request":{"type":"object","properties":{"agencyCode":{"type":"string","description":"The Agency Code submitting the Request"},"policyInfo":{"$ref":"#/components/schemas/InitiateQuoteHO6PolicyInfo"},"propertyOccupancy":{"type":"string","description":"Indicates if property is Primary or Secondary/Seasonal. This applies only for property address not mailing address"}},"description":"Represents the Request for the Initiate Quote API"},"InitiateQuoteHO6Response":{"type":"object","properties":{"agentURL":{"type":"string","description":"The URL for agents/underwriters to view the quote in the PolicyCenter (PC) application"},"id":{"type":"string","description":"Represents the Quote Id that is used to pass to subsequent operations for the Quote","format":"uuid"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"quoteNumber":{"type":"string","description":"The Quote Number from the System that represents the Quote Number in the Policy Administration System"}},"description":"Represent the response to the Create Quote API"},"InstallmentPayment":{"type":"object","properties":{"amountDue":{"type":"number","description":"The dollar amount due for the payment","format":"double","readOnly":true,"example":1073.22},"dueDate":{"type":"string","description":"Date down payment or installment payment will be due","format":"date","readOnly":true,"example":"2024-12-19"},"paymentType":{"type":"string","description":"Indicates if payment is a down payment or installment payment","readOnly":true,"example":"Down Payment"}},"description":"An array of payment information when applicable","readOnly":true},"LossDetail":{"type":"object","properties":{"address":{"type":"string","description":"The address one data provided by the reporting carrier","readOnly":true},"chargeable":{"type":"string","description":"Indicates if the claim is chargeable","readOnly":true},"claimDate":{"type":"string","description":"The date the claim occurred","format":"date","readOnly":true},"claimDescription":{"type":"string","description":"The description of claim","readOnly":true},"claimStatus":{"type":"string","description":"Indicates the claim status","readOnly":true},"claimType":{"type":"string","description":"The type of claim","readOnly":true},"coveragePayoutInformation":{"$ref":"#/components/schemas/CoveragePayoutInformation"},"faultIndicator":{"type":"string","description":"Indicates if the loss was at fault or not at fault","readOnly":true},"licenseNumber":{"type":"string","description":"The driver's license number of the driver involved in the loss","readOnly":true},"licenseState":{"type":"string","description":"The state that issued the driver's license","readOnly":true},"operatorGender":{"type":"string","description":"The gender of the vehicle operator","readOnly":true},"orderDate":{"type":"string","description":"The date the CLUE report was ordered","format":"date","readOnly":true},"paymentDate":{"type":"string","description":"The date the payment was made for the loss","format":"date","readOnly":true},"policyHolderName":{"type":"string","description":"The holder name of the companion policy where the loss is obtain from","readOnly":true},"vehicleOperator":{"type":"string","description":"Name of the person who was driving the vehicle for the incident reported","readOnly":true},"vehicleOperatorDateOfBirth":{"type":"string","description":"The date of birth of the vehicle operator","format":"date","readOnly":true},"vin":{"type":"string","description":"The Vehicle Identification Number of the vehicle involved in the incident","readOnly":true},"yearMakeModel":{"type":"string","description":"A concatenation of the Year, Make and Model of the vehicle involved in the incident","readOnly":true}},"readOnly":true},"Losses":{"type":"object","properties":{"autoLoss":{"type":"array","description":"A collection of data elements presenting for Auto prior loss records","readOnly":true,"items":{"$ref":"#/components/schemas/AutoLoss"}},"hoLoss":{"type":"array","description":"A collection of data elements presenting for HO prior loss records","items":{"$ref":"#/components/schemas/HoLoss"}}}},"Message":{"type":"object","properties":{"additionalDetails":{"type":"array","description":"Additional information that is specific to this API","items":{"$ref":"#/components/schemas/AdditionalDetail"}},"category":{"type":"string","description":"Represents a category that can be used to associate similar messages"},"code":{"type":"string","description":"A code to represent the message"},"description":{"type":"string","description":"Provides a text description of the Informational, Warning or Error message"},"type":{"type":"string","description":"Indicates the Message Type","enum":["Error","Info","Warn"]}},"description":"Represents a single message"},"MessagesResponse":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"description":"Represents a response of Message Entities"},"NamedInsured":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Date of birth of the named insured.","format":"date"},"employerOrSchool":{"type":"string","description":"The Name of Employer or School for the Resident"},"firstName":{"type":"string","description":"First name of the named insured."},"lastName":{"type":"string","description":"Last Name of the named insured."},"middleInitial":{"type":"string","description":"Optional middle initial of the named insured."},"occupationIndustry":{"type":"string","description":"The Occupation Industry for the Resident"},"occupationType":{"type":"string","description":"The Occupation Industry for the Resident"},"primary":{"type":"string","description":"A Y/N value indicating if driver is the primary named insured."},"suffix":{"type":"string","description":"Optional suffix of the named insured."}}},"OtherInsuredLocationsOccupiedNamedInsuredRecordAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"OtherMemberNamedInsuredHouseholdName":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name"},"id":{"type":"string","description":"A unique ID that identifies an contact record"},"lastName":{"type":"string","description":"Last Name"},"middleInitial":{"type":"string","description":"Middle Initial"},"suffix":{"type":"string","description":"Suffix"}}},"OtherMembersNamedInsuredHouseholdRecord":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID that identifies an other member of household record"},"memberName":{"$ref":"#/components/schemas/OtherMemberNamedInsuredHouseholdName"},"relationToInsured":{"type":"string","description":"Other members relation to named insured"}}},"PaymentMethod":{"type":"object","properties":{"installmentFee":{"type":"number","description":"The dollar amount of the fee that will be applied to each installment","format":"double","readOnly":true,"example":6.0},"paymentMethod":{"type":"string","description":"A string that represents the payment method","example":"CreditDebit"},"paymentSchedule":{"type":"array","description":"An array of payment information when applicable","readOnly":true,"items":{"$ref":"#/components/schemas/InstallmentPayment"}},"totalPremiumWithInstallmentFees":{"type":"number","description":"The total premium including installments fees","format":"double","readOnly":true,"example":1073.22}},"description":"Indicates how the installment payments and renewal payment will be paid based on allowed options","readOnly":true},"PaymentOption":{"type":"object","properties":{"paymentOptionId":{"type":"string","description":"A unique ID that represents a specific payment option. This value will be used when updating to a different pay plan","example":"PIF-pplan:23"}}},"PaymentSchedule":{"type":"object","properties":{"downPaymentAmount":{"type":"string","description":"The down payment amount for the Pay Plan"},"installmentAmount":{"type":"string","description":"The payment amount for future installments for the Pay Plan"},"payPlanName":{"type":"string","description":"Represents the name of the Pay Plan"},"totalPremiumAmount":{"type":"number","description":"The total premium for the Pay Plan","format":"double"}}},"PayPlan":{"type":"object","properties":{"downPaymentPercentage":{"type":"number","description":"The percentage of the total premium that is due as the down payment","format":"double","readOnly":true,"example":16.67},"installmentRenewalPaymentMethods":{"type":"array","description":"Indicates how the installment payments and renewal payment will be paid based on allowed options","readOnly":true,"items":{"$ref":"#/components/schemas/PaymentMethod"}},"paymentFrequency":{"type":"integer","description":"The number of installment payments for pay plan","format":"int32","readOnly":true,"example":2},"paymentOptionId":{"type":"string","description":"A unique ID that represents a specific payment option. This value will be used when updating to a different pay plan","readOnly":true,"example":"PIF-pplan:23"},"payPlan":{"type":"string","description":"The name of the pay plan","readOnly":true,"example":"Two Pay"},"selectedPaymentOption":{"type":"boolean","description":"Indicates if this is the currently selected pay plan option that the rate is based on","readOnly":true,"example":true}},"description":"Pay Plan options available for Billing Type","readOnly":true},"PolicyDeductibles":{"type":"object","properties":{"allOtherPerils":{"type":"string","description":"Indicates the desired limit of coverage"}}},"PolicyInfo":{"type":"object","properties":{"address":{"type":"array","description":"A collection of values that contain information on policy address.","items":{"$ref":"#/components/schemas/PolicyInfoAddress"}},"agent":{"$ref":"#/components/schemas/Agent"},"associationGroup":{"type":"string","description":"A list of associations/groups that an insured's can be a member of that may provide a discount. The list of associations/groups can be different per state."},"autoInformation":{"$ref":"#/components/schemas/AutoInformation"},"effectiveDates":{"$ref":"#/components/schemas/EffectiveDates"},"emailAddress":{"type":"string","description":"The primary email address where insured would like Mercury to deliver communications."},"employerOrSchoolName":{"type":"string","description":"Name of the employer or school of the primary named insured"},"esignOptIn":{"type":"string","description":"A Y/N or y/n that indicates if user intends to esign application and other documents"},"liveCurrentAddressSixMonths":{"type":"string","description":"Applicant must indicate if they have lived at the entered mailing address at least six months.  If no, a prior address must be provided.  See address entity with address.type = Prior"},"mailingPropertyAddressSame":{"type":"string","description":"A Y/N value indicating if the mailing address is the same as the property address"},"namedInsured":{"type":"array","description":"The full name and other data related to a named insured.","items":{"$ref":"#/components/schemas/NamedInsured"}},"orderCreditAtQuote":{"type":"string","description":"A Y/N or y/n that indicates if applicant has granted permission for Mercury to order their credit score."},"otherReason":{"type":"string","description":"If reason why mailing address is different than property address is OTHER, enter reason"},"paperlessOptin":{"type":"string","description":"A Y/N or y/n that indicates if user intends to esign application and other documents. This is not long term paperless opt-in. See paperless opt in option to take advantage of that process."},"policyPhones":{"type":"array","description":"A collection of phone numbers that apply to the policy.","items":{"$ref":"#/components/schemas/PolicyPhone"}},"priorPolicies":{"type":"array","description":"Prior policies information for the property.","items":{"$ref":"#/components/schemas/PriorPolicies"}},"questions":{"$ref":"#/components/schemas/PolicyInfoQuestions"},"reasonMailingAddressDifferent":{"type":"string","description":"Reason why mailing address is different than property address"},"residenceEmployees":{"type":"string","description":"Number of employees who work from the residence"},"selectedCreditLevel":{"type":"string","description":"If user does not allow Mercury to order their credit score, provide credit score level."},"selfEmployedFromHome":{"$ref":"#/components/schemas/PolicyInfoSelfEmployedFromHome"},"socialSecurityNumber":{"type":"string","description":"The social security number of the named insured, spouse or person designated with relation to insured as civil union or domestic partner if needed when ordering credit."},"thirdPartyDesignees":{"type":"array","description":"An optional section that allows for an insured to designate one person to receive information on the status of the policy. This person does not need to be listed on the policy. Minimum Named Insured age restrictions may apply.","items":{"$ref":"#/components/schemas/ThirdPartyDesignee"}},"transactionInfo":{"$ref":"#/components/schemas/TransactionInfo"}}},"PolicyInfoAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the address"},"addressLineTwo":{"type":"string","description":"The second line of the address for the address"},"addressType":{"type":"string","description":"Address type can be mailing or prior.  If mailing address is different than property, send address type as mailing.  If have not lived at current address for at least 6 months, send address type as prior.  Property address can be modified under Dwelling"},"city":{"type":"string","description":"The city for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address.  Must be 5 or 5 + 4 format"}}},"PolicyInfoQuestions":{"type":"object","properties":{"dogsAndPets":{"$ref":"#/components/schemas/DogsAndPets"},"rejectedCancelledRefusedThreeYears":{"$ref":"#/components/schemas/RejectedCancelledRefusedThreeYears"}}},"PolicyInfoSelfEmployedFromHome":{"type":"object","properties":{"anyHouseholdMembersSelfEmployedFromHome":{"type":"string","description":"For any household members who are self-employed from the home"},"selfEmployedFromHomeDetails":{"$ref":"#/components/schemas/SelfEmployedFromHomeDetails"}}},"PolicyPhone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Country code of the phone number."},"phoneExtension":{"type":"string","description":"Any extension to the phone number if needed."},"phoneNumber":{"type":"string","description":"A unique 10 digit phone number."},"phoneType":{"type":"string","description":"Indicates if the phone number is a home number, work number, or mobile number."},"primary":{"type":"string","description":"A Y/N value indicating if the number is to be the primary number to be used for contact."}}},"PriorPolicies":{"type":"object","properties":{"annualPremium":{"type":"integer","format":"int32"},"carrier":{"type":"string"},"expirationDate":{"type":"string","format":"date"},"id":{"type":"string","description":"Unique Id for the prior policy"},"policyNumber":{"type":"string"},"source":{"type":"string","readOnly":true},"yearsInsured":{"type":"integer","format":"int32"}}},"Qualification":{"type":"object","properties":{"fairPlan":{"$ref":"#/components/schemas/FairPlan"},"mercuryPrimaryPolicyNumber":{"type":"string","description":"The primary Mercury rental policy number that is required to have a secondary/seasonal rental policy"},"numberOfMonthsUnoccupied":{"type":"string","description":"Number of months the property is unoccupied. Required when property type is secondary/seasonal."},"numberOfUnitsInBuilding":{"type":"string","description":"Indicates the number of units the property has. If you send a mismatch, backend system will correct. Ex send 2 units for Townhouse or Rowhouse"},"occupancyType":{"type":"string","description":"Indicates how property is occupied. Non-owner occupation may result in ineligibility"},"propertyOccupancy":{"type":"string","description":"Indicates if property is Primary or Secondary/Seasonal. This applies only for property address not mailing address"},"propertyQuestions":{"$ref":"#/components/schemas/QualificationQuestions"},"residenceType":{"type":"string","description":"Describes the type of property. Certain residence types may result in ineligibility"}}},"QualificationQuestions":{"type":"object","properties":{"brushLandslideMudslideRequirements":{"type":"string","description":"Does the property meet brush, landslide and mudslide requirements?"},"daycareLongTermCareOnPremises":{"type":"string","description":"Is any daycare, assisted living, or rehabilitation business conducted on the premises?"},"distanceToCoastHalfMile":{"type":"string","description":"Is the property located within a half mile of a sea, bay, tidal water or sound?"},"skateRampsBikeJumpsOnPremises":{"type":"string","description":"Any skateboard ramps or bicycle jumps on premises?"},"unacceptableRoofTypes":{"type":"string","description":"A YyNn value that indicates if the property has asbestos shingles, tin, T-lock shingles, wood shakes, wood shingles, or more than 1 layer of roofing material"},"underConstructionVacantUnoccupiedForSale":{"type":"string","description":"Is the property under construction, vacant, unoccupied or for sale?"},"waterDamageMoldClaimRequirements":{"type":"string","description":"A YyNn value that indicates does the property meet water damage and mold claim requirements?"}}},"QuickQuoteDetail":{"type":"object","properties":{"additionalInterests":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInterest"}},"construction":{"$ref":"#/components/schemas/DwellingConstruction"},"coverages":{"$ref":"#/components/schemas/Coverages"},"dwelling":{"$ref":"#/components/schemas/Dwelling"},"losses":{"type":"array","items":{"$ref":"#/components/schemas/HoLoss"}},"qualification":{"$ref":"#/components/schemas/Qualification"}}},"QuickQuoteHO6":{"type":"object","properties":{"additionalInsureds":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalInsured"}},"dwellings":{"type":"array","description":"Required information for policy info dwelling list.","items":{"$ref":"#/components/schemas/QuickQuoteDetail"}},"policyInfo":{"$ref":"#/components/schemas/PolicyInfo"}}},"QuickQuoteResponse":{"type":"object","properties":{"agentURL":{"type":"string","description":"The URL for agents/underwriters to view the quote in the PolicyCenter (PC) application"},"consumerURL":{"type":"string","description":"The URL for the consumer to continue the quote in the Direct Sales Channel (DSC) application"},"discounts":{"type":"array","description":"Lists the Discounts applicable on the quote","items":{"$ref":"#/components/schemas/Discount"}},"id":{"type":"string","description":"Represents the Quote Id that is used to pass to subsequent operations for the Quote","format":"uuid"},"messages":{"type":"array","description":"Array of Messages being returned from the Rate","items":{"$ref":"#/components/schemas/Message"}},"paymentSchedule":{"$ref":"#/components/schemas/PaymentSchedule"},"premiums":{"type":"array","description":"Represents a list of Coverage Premiums for the vehicles on the Quote","items":{"$ref":"#/components/schemas/QuoteRatePremium"}},"quoteNumber":{"type":"string","description":"The Quote Number from the System that represents the Quote Number in the Policy Administration System"},"success":{"type":"boolean","description":"Indicates if the Request to rate was successful"},"totalTermWrittenPremium":{"type":"number","description":"Represents the Total Premium for the Quote","format":"double"}},"description":"Represent the response to the Create Quote API"},"QuoteRateCoverage":{"type":"object","properties":{"coverageName":{"type":"string"},"coveragePremium":{"type":"string"},"coverageValue":{"type":"string"}}},"QuoteRatePremium":{"type":"object","properties":{"coverages":{"type":"array","items":{"$ref":"#/components/schemas/QuoteRateCoverage"}},"dwellingId":{"type":"string"}}},"QuoteRateResponse":{"type":"object","properties":{"agentURL":{"type":"string","description":"The URL for agents/underwriters to view the quote in the PolicyCenter (PC) application"},"consumerURL":{"type":"string","description":"The URL for the consumer to continue the quote in the Direct Sales Channel (DSC) application"},"discounts":{"type":"array","description":"Lists the Discounts applicable on the quote","items":{"$ref":"#/components/schemas/Discount"}},"messages":{"type":"array","description":"Array of Messages being returned from the Rate","items":{"$ref":"#/components/schemas/Message"}},"paymentSchedule":{"$ref":"#/components/schemas/PaymentSchedule"},"premiums":{"type":"array","description":"Represents a list of Coverage Premiums for the vehicles on the Quote","items":{"$ref":"#/components/schemas/QuoteRatePremium"}},"success":{"type":"boolean","description":"Indicates if the Request to rate was successful"},"totalTermWrittenPremium":{"type":"number","description":"Represents the Total Premium for the Quote","format":"double"}},"description":"Represents the Response for the Quote Rate Operation"},"QuoteSearchResponse":{"type":"object","properties":{"quoteNumber":{"type":"string"},"transactionId":{"type":"string"}}},"RejectedCancelledRefusedRenewalDetails":{"type":"object","properties":{"reasonRejectedCancelledRefusedRenewal":{"type":"string","description":"If any insurer has rejected, cancelled or refused to renew similar insurance during the past 3 years, provide a reason why"},"reasonRejectedCancelledRefusedRenewalOther":{"type":"string","description":"If reason selected for rejected, canceled or refused is Other"}}},"RejectedCancelledRefusedThreeYears":{"type":"object","properties":{"beenRejectedCancelledRefusedRenewalLastThreeYears":{"type":"string","description":"Has any insurer rejected, cancelled or refused to renew similar insurance during the past 3 years?"},"rejectedCancelledRefusedRenewalDetails":{"$ref":"#/components/schemas/RejectedCancelledRefusedRenewalDetails"}}},"ResidentAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address","readOnly":true},"addressLineTwo":{"type":"string","description":"Additional information on the address such as suite or apt.","readOnly":true},"city":{"type":"string","description":"Name of the city for the address.","readOnly":true},"county":{"type":"string","description":"The name of county the address resides in.","readOnly":true},"state":{"type":"string","description":"The full name of the state that was provided as part of the address.","readOnly":true},"zipCode":{"type":"string","description":"This is the five or nine digit number that represents a specific area that was provided for the address.","readOnly":true}},"readOnly":true},"ResidentEmployment":{"type":"object","properties":{"nameOfEmployerOrSchool":{"type":"string","description":"The Name of Employer or School for the Resident"},"occupationIndustry":{"type":"string","description":"The Occupation Industry for the Resident"},"occupationType":{"type":"string","description":"The Occupation Industry for the Resident"}}},"SelfEmployedFromHomeDetails":{"type":"object","properties":{"anyEmployees":{"type":"string","description":"Indicates if any employees exist and if so, are they related or unrelated to the named insured"},"footTraffic":{"type":"string","description":"Due to self-employment from the home, is there any foot traffic at the home"},"isItPrimaryNamedInsured":{"type":"string","description":"Is the self-employed household member the primary named insured?"},"occupationIndustry":{"type":"string","description":"A value that indicates the industry the driver works in"},"occupationType":{"type":"string","description":"A value that represents the occupation type for the given occupation industry"}}},"SetPaymentMethodRequest":{"type":"object","properties":{"methodName":{"type":"string","description":"The name of the payment method to be used","example":"CreditDebit"},"paymentType":{"type":"string","description":"Indicates if payment method is to be used for the down payment or for installment payments  NOTE: IF payment method name is 'agency_sweep' payment type must be 'down_payment","example":"DownPayment"},"redirectURL":{"type":"string","description":"User provided URL where payment IFrame information is to be sent allowing end users to submit required payment information based on payment method being provided in request. If payment method name does require providing card or account information, a redirect URL will not be returned.  Note must use <b>HTTPS</b> in URL path","example":"https://agentcallbackURL.com"}}},"SetPaymentMethodResponse":{"type":"object","properties":{"messages":{"type":"array","description":"Array of Messages being returned.","items":{"$ref":"#/components/schemas/Message"}},"url":{"type":"string","description":"If payment method provided requires providing credit card or bank account information, a response URL will be provided","readOnly":true,"example":"https://{someurl}/P3Embedded/payment/render?token=e96a8af3-38b0-432d-809f-63bd7a33d2cd"}}},"StudentsLivingAwayFromResidenceRecord":{"type":"object","properties":{"city":{"type":"string","description":"City the school is located"},"id":{"type":"string","description":"A unique ID that identifies a student living away record"},"name":{"$ref":"#/components/schemas/StudentsLivingAwayFromResidenceRecordName"},"school":{"type":"string","description":"Name of school student attends"},"state":{"type":"string","description":"State the school is located"}}},"StudentsLivingAwayFromResidenceRecordName":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name"},"id":{"type":"string","description":"A unique ID that identifies an contact record"},"lastName":{"type":"string","description":"Last Name"},"middleInitial":{"type":"string","description":"Middle Initial"},"suffix":{"type":"string","description":"Suffix"}}},"ThirdPartyDesignee":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address that insured has provided as their third party designee address."},"addressLineTwo":{"type":"string","description":"The optional second line of that address that insured has provided as their third party designee address."},"city":{"type":"string","description":"Name of the city that the insured has provided as part of their third party designee address."},"designeeId":{"type":"string","description":"A unique numeric value that identifies one unique individual.","readOnly":true},"firstName":{"type":"string","description":"The first name of the third party designee. Only required if adding a third party designee being added."},"lastName":{"type":"string","description":"The last name of the third party designee. Only required if adding a third party designee being added."},"middleInitial":{"type":"string","description":"Optional entry of Middle Initial."},"state":{"type":"string","description":"The full name of the state that the insured has provided as part of their third party designee address."},"suffix":{"type":"string","description":"Optional entry of Suffix."},"zipCode":{"type":"string","description":"This is the five or nine digit number that represents a specific area that the insured has provided as part of their third party designee address."}}},"TransactionInfo":{"type":"object","properties":{"bindingDate":{"type":"string","description":"Indicates date policy was bound.","format":"date","readOnly":true},"cancellationInformation":{"$ref":"#/components/schemas/CancellationInformation"},"currentFullTermPremium":{"type":"number","description":"The full term premium for a policy as a specific point in time.","format":"double","readOnly":true},"originalQuoteStartDate":{"type":"string","description":"The original date this policy was quoted.","format":"date","readOnly":true},"originalTermEffDate":{"type":"string","description":"The first effective date for a policy number.","format":"date","readOnly":true},"policyNumber":{"type":"string","description":"The assigned policy number.","readOnly":true},"status":{"type":"string","description":"Indicates if Draft, rated, inforce, renewal.","readOnly":true},"termNumber":{"type":"integer","description":"A numeric value indicating how many terms this policy number has been through.","format":"int32","readOnly":true},"transactionType":{"type":"string","description":"Indicates if a quote, application, policy change, renewal","readOnly":true},"underwritingCompany":{"type":"string","description":"The name of the company under which the policy is written.","readOnly":true}},"readOnly":true}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}