{"openapi":"3.0.1","info":{"title":"Personal Auto Policy Quote","description":"Allows partner agencies quote and bind policies across Personal Auto lines. It also provides metadata about the services.","contact":{"name":"API Support","url":"https://developer.mercuryinsurance.com","email":"apiportal@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 Discovered Residents"},{"name":"Quote Discovered Vehicles"},{"name":"Quote Driver"},{"name":"Quote Driver Incident"},{"name":"Quote Non-Driver"},{"name":"Quote Payments"},{"name":"Quote Vehicle"},{"name":"Quote Vehicle Assignment"},{"name":"Quote Vehicle Interest"},{"name":"Unassigned Incidents"},{"name":"Vin"}],"paths":{"/personal-auto-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","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"}}],"responses":{"200":{"description":"Successfully retrieved job information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MercuryRelationshipResponse"}}}},"400":{"description":"Invalid QuoteNumber parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Quote not found for the specified QuoteNumber or missing QuoteNumber parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Internal server error occurred while processing the 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":[]}]}},"/personal-auto-policy-quote/v1/vin/makes":{"get":{"tags":["Vin"],"summary":"Retrieves a list of Vehicle Makes from the Personal Auto Vin Database for the vehicle year provided","parameters":[{"name":"year","in":"query","description":"The Vehicle Year for which a list of makes is requested","required":true,"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"}}],"responses":{"200":{"description":"Indicates the Vehicle Makes list was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpaVinMakesResponse"}}}},"400":{"description":"Represents a response when the Vehicle Year is not provided as input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents a response when no results are found for the given Year","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Vehicle Makes cannot be retrieved","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":[]}]}},"/personal-auto-policy-quote/v1/vin/models":{"get":{"tags":["Vin"],"summary":"Retrieves the list of acceptable Vehicle Models from the Personal Auto Vin Database for the vehicle year and vehicle make provided","parameters":[{"name":"make","in":"query","description":"The Vehicle Make to look up the Vehicle Models for","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"The Vehicle Year to look up the Vehicle Models for","required":true,"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"}}],"responses":{"200":{"description":"Indicates the Vehicles Models list was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpaVinModelsResponse"}}}},"400":{"description":"Represents a response when the Vehicle Year or Vehicles Make is not provided as input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents a response when no results are found for the given Year and/or Make","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Vehicle Models cannot be retrieved","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":[]}]}},"/personal-auto-policy-quote/v1/vin/retrieve":{"get":{"tags":["Vin"],"summary":"Retrieves the list of Vins from the Personal Auto Vin Database for the Vehicle Year, Vehicle Make, and Vehicle Model provided","parameters":[{"name":"effectiveDate","in":"query","description":"The effective Date (in milliseconds) for when to try and find the vehicle as of","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int64"}},{"name":"make","in":"query","description":"The Vehicle Make to look up the VIN numbers for","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"model","in":"query","description":"The Vehicle Model to look up the VIN numbers for","required":true,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"year","in":"query","description":"The Vehicle Year to look up the VIN numbers for","required":true,"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"}}],"responses":{"200":{"description":"Indicates the VIN number list was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpaVinRetrieveResponse"}}}},"400":{"description":"Represents a response when the Vehicle Year, Vehicle Make or Vehicle Model is not provided as input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents a response when the Vehicle Year, Vehicle Make or Vehicle Model combination finds no Vin Records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the VIN number list cannot be retrieved","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":[]}]}},"/personal-auto-policy-quote/v1/vin/years":{"get":{"tags":["Vin"],"summary":"Retrieves the list of acceptable Vehicle Years from the Personal Auto Vin Database","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"}}],"responses":{"200":{"description":"Indicates the Vehicle Years list was retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpaVinYearsResponse"}}}},"500":{"description":"Represents a response when the Vehicle Years cannot be retrieved","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/initiate":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to create a new PPA quote and will return a unique ID representing a specific quote to be in used in other endpoints.","parameters":[{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateQuoteRequest"}}}},"responses":{"201":{"description":"Represents the successful response for creating a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateQuoteResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote is trying to be created 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 Quote cannot be created","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/quickQuote":{"post":{"tags":["Quote"],"summary":"This API allows a consumer to create a new PPA quote and will return a unique ID representing a specific quote to be in used in other endpoints.","parameters":[{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickQuotePPA"}}}},"responses":{"201":{"description":"Represents the successful response for creating a quote","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 Quote is trying to be created 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 Quote cannot be created","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/assignment":{"get":{"tags":["Quote Vehicle Assignment"],"summary":"This API allows a consumer to retrieve a vehicle and see the drivers assigned to that vehicle on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents the successful response for retrieving a vehicle assignment on a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleAssignment"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a Quote or vehicle id cannot be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the vehicle assignment cannot be retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Vehicle Assignment"],"summary":"This API allows a consumer to assign a driver to vehicle on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleAssignment"}}}},"responses":{"201":{"description":"Represents the successful response for creating a vehicle assignment on 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 Quote is trying to be created 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 vehicle assignment cannot be created","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/bind":{"post":{"tags":["Quote"],"summary":"This API provides the consumer the ability to bind a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot bind the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/coverage":{"get":{"tags":["Quote"],"summary":"This API allows a consumer to retrieve quote coverages on a quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Indicates the policy coverages were retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverages"}}}},"400":{"description":"Represents a failure response for retrieving policy coverages because of invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a transaction is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the transaction encountered an error while attempting to retrieve","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 quote coverages on a quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coverages"}}}},"responses":{"200":{"description":"Indicates the policy coverages were updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"400":{"description":"Represents a failure response for updating policy coverages because of invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a transaction is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the transaction encountered an error while attempting to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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"}}}}}}},"/personal-auto-policy-quote/v1/{state}/{id}/discoveredresident":{"get":{"tags":["Quote Discovered Residents"],"summary":"This API retrieves a list of discovered residents that were found from the reports ordered on the quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents the successful response for discovered residents on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveredResidents"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot retrieve the discovered residents","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/discoveredresident/{residentId}":{"put":{"tags":["Quote Discovered Residents"],"summary":"This API updates the information about a discovered driver for a given Id","parameters":[{"name":"id","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":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveredResident"}}}},"responses":{"200":{"description":"Represents the successful response for update of the discovered driver  on the 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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot update the discovered driver","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/discoveredvehicle":{"get":{"tags":["Quote Discovered Vehicles"],"summary":"This API retrieves a list of discovered vehicles that were found from the reports ordered on the quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents the successful response for discovered vehicles on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoveredVehicles"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot retrieve the discovered vehicles","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/driver":{"get":{"tags":["Quote Driver"],"summary":"This API allows a consumer to retrieve all drivers on a PPA Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Represents a successful submission of a Driver for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Drivers"}}}},"403":{"description":"Represents when a quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the submission of a driver cannot be completed for the transaction Id","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"}}}},"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 Driver"],"summary":"This API allows a consumer to add a Driver to a PPA Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Driver"}}}},"responses":{"201":{"description":"Represents a successful Retrieval of Drivers for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityResponse"}}}},"403":{"description":"Represents when a quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the retrieval of drivers cannot be completed for the transaction Id","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/driver/{driverId}":{"put":{"tags":["Quote Driver"],"summary":"This API allows a consumer to update driver information on a driver on a PPA quote.","parameters":[{"name":"driverId","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":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Driver"}}}},"responses":{"200":{"description":"Represents a successful update of a Driver for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the update of a driver cannot be completed for the transaction Id","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"}}}},"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 Driver"],"summary":"This API allows a consumer to delete an existing driver on a PPA quote.","parameters":[{"name":"driverId","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":"state","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"}}],"responses":{"200":{"description":"Represents a successful delete of a Driver for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the delete of a driver cannot be completed for the transaction Id","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/driver/{driverId}/incident":{"get":{"tags":["Quote Driver Incident"],"summary":"This API allows a consumer to retrieve incidents assigned to a driver on a PPA quote.","parameters":[{"name":"driverId","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":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Represents a successful Retrieval of Driver Incidents for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incidents"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the retrieval of driver incidents cannot be completed for the transaction Id","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"}}}},"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 Driver Incident"],"summary":"This API allows a consumer to add an incident to a Driver on a PPA Quote","parameters":[{"name":"driverId","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":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incident"}}}},"responses":{"201":{"description":"Represents a successful submission of a Driver Incident for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the submission of the driver incident cannot be completed for the transaction Id","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/driver/{driverId}/incident/{incidentId}":{"put":{"tags":["Quote Driver Incident"],"summary":"This API allows a consumer to update incident information on a driver for a PPA quote.","parameters":[{"name":"driverId","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":"incidentId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incident"}}}},"responses":{"200":{"description":"Represents a successful update of a Driver Incident for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the update of the driver incident cannot be completed for the transaction Id","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"}}}},"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 Driver Incident"],"summary":"This API allows a consumer to delete an incident assigned to a driver on a PPA quote.","parameters":[{"name":"driverId","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":"incidentId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents a successful delete of a Driver Incident for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a quote is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the delete of the driver incident cannot be completed for the transaction Id","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"}}}},"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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/incident":{"get":{"tags":["Unassigned Incidents"],"summary":"This API allows a consumer to retrieve unassigned incidents for a Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Represents a successful Retrieval of Unassigned Incidents for a Quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Incidents"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a policy does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a transaction is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the retrieval of unassigned incidents cannot be completed for the transaction Id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/incident/{incidentId}":{"put":{"tags":["Unassigned Incidents"],"summary":"This API allows a consumer to update unassigned incidents by assigning to a driver or indicating to leave as unassigned.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"incidentId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnassignedIncident"}}}},"responses":{"200":{"description":"Represents the successful response for update unassigned incidents on the 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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot update unassigned incidents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/nondriver":{"get":{"tags":["Quote Non-Driver"],"summary":"This API allows a consumer to retrieve a list of all non-drivers on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Returns all the non-drivers on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonDrivers"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that there are no non-drivers on the Policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Get non-drivers 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"}}}}}},"post":{"tags":["Quote Non-Driver"],"summary":"This API allows a consumer to add a non-driver to a PPA Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonDriver"}}}},"responses":{"201":{"description":"Indicates the non-driver was created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the non-driver Request","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/nondriver/{nonDriverId}":{"put":{"tags":["Quote Non-Driver"],"summary":"This API allows a consumer to update a non-driver on a PPA Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"nonDriverId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NonDriver"}}}},"responses":{"200":{"description":"Indicates the non-driver 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 quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that non-driver Id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the non-driver Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Non-Driver"],"summary":"This API allows a consumer to delete a non-driver on a PPA Quote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"nonDriverId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Indicates the non-driver was 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 quote does not belong to requesting consumer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that non-driver Id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the non-driver Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/orderReports":{"get":{"tags":["Quote"],"summary":"This API retrieves the status of reports that have been ordered for a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Represents the successful response for requesting ordering report status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderReports"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot retrieve the order reports status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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"],"summary":"This API allows a consumer to initiate a request for reports to be ordered for a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"reportGroup","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"}}],"responses":{"201":{"description":"Represents the successful response for requesting ordering reports","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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot order reports","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/paymentMethod":{"get":{"tags":["Quote Payments"],"summary":"Retrieves the latest embedded payment methods that have been set up","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents the successful response to retrieve payment methods on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentMethodResponses"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot retrieve the discovered residents","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"}}}},"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","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPaymentMethodRequest"}}}},"responses":{"201":{"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 Quote is trying to be created 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 Quote cannot be created","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":[]}]}},"/personal-auto-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","description":"Provides details of pay plan  options after successful rate such as installment amounts and installment dates","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"responses":{"200":{"description":"Represents the successful response to retrieve pay plan options on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayPlanOptions"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot retrieve the discovered residents","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"}}}},"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 user to change to a different pay plan option","description":"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","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentOption"}}}},"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 Quote is trying to be created 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 Quote cannot be created","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"}}}}}}},"/personal-auto-policy-quote/v1/{state}/{id}/policyinfo":{"get":{"tags":["Quote"],"summary":"This API allows a consumer to retrieve an existing PPA quote info information.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot be retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 PPA quote information.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyInfo"}}}},"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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot be updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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"}}}}}}},"/personal-auto-policy-quote/v1/{state}/{id}/rate":{"get":{"tags":["Quote"],"summary":"This API provides the consumer the ability to rate a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"rateType","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"}}],"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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Represents a response when the Quote cannot be rated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/vehicle":{"get":{"tags":["Quote Vehicle"],"summary":"This API allows a consumer to retrieve a list of vehicles on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Returns all the Vehicles on a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicles"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that there are no Vehicle on the quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Vehicle Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Vehicle"],"summary":"This API allows a consumer to add a vehicle to a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}},"responses":{"201":{"description":"Represents a successful addition of a vehicle on on a quote","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that the quote id doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the add Vehicle Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/vehicle/{vehicleId}":{"put":{"tags":["Quote Vehicle"],"summary":"This API allows a consumer to update vehicle information on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}},"responses":{"200":{"description":"Represents a successful update of a vehicle on 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 Quote doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that the quote id doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the update Vehicle Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Vehicle"],"summary":"This API allows a consumer to delete a vehicle from a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","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"}}],"responses":{"200":{"description":"Represents a successful delete of a vehicle on 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 Quote doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that the quote id or vehicle id doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the deletem Vehicle Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/vehicle/{vehicleId}/interest":{"get":{"tags":["Quote Vehicle Interest"],"summary":"This API allows a consumer to retrieve all interests associated with a vehicle on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"viewSet","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"}}],"responses":{"200":{"description":"Returns all the Vehicle Interest on a Vehicle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOwnershipInterests"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that there are no Vehicle Interests on the Vehicle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Vehicle Interest Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Vehicle Interest"],"summary":"This API allows a consumer to add an interest to a vehicle on a PPA quote.","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOwnershipInterest"}}}},"responses":{"201":{"description":"Indicates the Vehicle Interest was created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntityResponse"}}}},"400":{"description":"Indicates that the Request was malformed or failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"403":{"description":"Represents when a Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a Quote or vehicle id cannot be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Vehicle Interest Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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":[]}]}},"/personal-auto-policy-quote/v1/{state}/{id}/vehicle/{vehicleId}/interest/{interestId}":{"put":{"tags":["Quote Vehicle Interest"],"summary":"This API allows a consumer to update existing vehicle interest information on a PPA quote.","parameters":[{"name":"id","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":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOwnershipInterest"}}}},"responses":{"200":{"description":"Indicates the Vehicle Interest 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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that the quote or Vehicle Interest Id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Vehicle Interest Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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 Vehicle Interest"],"summary":"This API allows a consumer to delete an existing vehicle interest on a PPA quote.","parameters":[{"name":"id","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":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"vehicleId","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"}}],"responses":{"200":{"description":"Indicates the Vehicle Interest was 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 Quote is trying to be created for an Agency that doesn't belong to the caller","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Indicates that quote or Vehicle Interest Id was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Indicates an error in processing the Vehicle Interest Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","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"},"AdditionalPip":{"type":"object","properties":{"additionalPipLimit":{"type":"string","description":"Indicates the limit of coverage selected."},"options":{"$ref":"#/components/schemas/AdditionalPipOptions"}}},"AdditionalPipNj":{"type":"object","properties":{"aPIP":{"type":"string","description":"A Y/N or y/n value that indicates if insured selects this coverage."},"deathBenefit":{"type":"string","description":"If Additional PIP is requested, the system will set this limit and it is not editable.","readOnly":true},"essentialServices":{"type":"string","description":"If Additional PIP is requested, the system will set this limit and it is not editable.","readOnly":true},"extensionOfAPIPtoResidentRelatives":{"type":"string","description":"An optional coverage that relates to Additional PIP. If selected, Additional PIP coverage wil lbe extended specified resident relatives. Application of this coverage on a driver level wil be noted in Driver section."},"funeralExpense":{"type":"string","description":"If Additional PIP is requested, the system will set this limit and it is not editable.","readOnly":true},"incomeContinuation":{"type":"string","description":"If Additional PIP is requested, this will display the limit selected for this coverage."}}},"AdditionalPipOptions":{"type":"object","properties":{"nj":{"$ref":"#/components/schemas/AdditionalPipNj"}}},"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.","readOnly":true},"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},"agentOptions":{"$ref":"#/components/schemas/AgentOptions"},"organization":{"type":"string","description":"Name of the agency that sold and services the policy. This is the main or master agency name.","readOnly":true},"subAgentCode":{"type":"string","description":"Optional value that indicates something or someone more specific inside an agency."}}},"AgentOptions":{"type":"object","properties":{"fl":{"$ref":"#/components/schemas/AgentOptionsFl"}}},"AgentOptionsFl":{"type":"object","properties":{"agentLicenseNumber":{"type":"string","description":"The license number of the selling agent"}}},"AnnualMileage":{"type":"object","properties":{"annualMileageProgram":{"type":"string","description":"Indicates what type of Annual Mileage program the insured has selected."},"noAnnualMileageProgramChange":{"type":"string","description":"If insured was in the RealDrive program then opted out of the program, changed Annual Mileage program to Estimated, system will populate this date and insured will not be able to be back in RealDrive program until this date.","format":"date","readOnly":true},"optInDate":{"type":"string","description":"The date that indicates when the insured opted into the Annual Mileage program. Program must be RealDrive for this date to be populated.","format":"date"}}},"AntiTheftDevices":{"type":"object","properties":{"name":{"type":"string","description":"Name(s) of the anti-theft devices applied to the vehicle or trailer."}}},"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}}},"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"},"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},"Company":{"type":"object","properties":{"companyName":{"type":"string","description":"The name of the finance or leasing company."}}},"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":{"additionalPip":{"$ref":"#/components/schemas/AdditionalPip"},"incomeLossBenefit":{"type":"string","description":"This coverage provides for loss of earnings and other expenses due to inability to work due to injuries up to the limit selected."},"liability":{"$ref":"#/components/schemas/Liability"},"medicalPayments":{"type":"string","description":"Indicates the level of Medical Expense/Payments coverage."},"optionalBasicEconomicLoss":{"type":"string","description":"An optional insurance coverage that supplements PIP coverage up to the limit selected."},"pip":{"$ref":"#/components/schemas/Pip"},"umCoverage":{"$ref":"#/components/schemas/UmCoverage"},"workLossReductionForPIP":{"type":"string","description":"A Y/N or yn value that can apply a discount if the principal operator of a motor vehicle or such operator's spouse is eligible for payment of work loss through an eligible contract or voluntary Plan with their employer because of personal injury arising out of the use of a motor vehicle."}}},"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"},"motorizedGolfCart":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesMotorizedGolfCart"},"otherMembersNamedInsuredHousehold":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesOtherMembersNamedInsuredHousehold"},"personalPropIncreasedLimitOtherResidences":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyPersonalPropIncreasedLimitOtherResidences"},"residenceRentalTheft":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyResidenceRentalTheft"},"specifiedStructuresAwayFromResidence":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertySpecifiedStructuresAwayFromResidence"},"structuresRentedToOthers":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesPropertyStructuresRentedToOthers"},"studentsLivingAwayFromResidence":{"$ref":"#/components/schemas/CoveragesOptionalCoveragesStudentsLivingAwayFromResidence"},"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"}}},"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"}}},"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"}}},"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.  Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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. Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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.  Note: Dollar amount will be rounded","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"}}},"CovOptions":{"type":"object","properties":{"fl":{"$ref":"#/components/schemas/FlCovOptions"},"ga":{"$ref":"#/components/schemas/GaCovOptions"},"va":{"$ref":"#/components/schemas/VaCovOptions"}}},"CreateEntityResponse":{"type":"object","properties":{"id":{"type":"string","description":"A unique numeric value that represents a specific request to make a change to a policy. This value must be provided in the update policy request.","example":"ac314f9d-97a7-43e4-84ed-e016af1c6a55"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"description":"Represents a response when an Entity is created"},"DamageType":{"type":"object","properties":{"type":{"type":"string","description":"A value indicating what type of existing damage that poses a safety hazard if  \"existingDamageSafetyHazardDamageTypes\" is Y/y"}}},"Discount":{"type":"object","properties":{"name":{"type":"string","description":"Discount Name","example":"Good Driver"}}},"DiscoveredResident":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"the date of birth of potential resident","format":"date","readOnly":true},"driverId":{"type":"string","description":"If the potential resident was added to the policy as a driver, provide the driver ID to indicate updated status of potential resident.  If added as a driver, non-driver ID and reason not in household must null"},"firstName":{"type":"string","description":"The first name of the potential resident","readOnly":true},"gender":{"type":"string","description":"The gender of the potential resident","readOnly":true},"lastName":{"type":"string","description":"The last name of the potential resident","readOnly":true},"licenseInformation":{"$ref":"#/components/schemas/DiscoveredResidentLicenseInformation"},"maritalStatus":{"type":"string","description":"The marital status of the potential resident","readOnly":true},"middleInitial":{"type":"string","description":"The middle initial of the potential resident","readOnly":true},"nonDriverId":{"type":"string","description":"If the potential resident was added to the policy as a non-driver, provide the driver ID to indcate updated status of potential resident. If added as a non-driver, driver ID and reason not in household must null"},"reasonNotInHousehold":{"type":"string","description":"If the potential resident is no longer in household, provide the reason that explains why they are no longer in household. If no longer in the household, driver ID and non-driver ID must null"},"relationship":{"type":"string","description":"The relationship of the potential resident","readOnly":true},"residentId":{"type":"string","description":"A unique ID that identifies the discovered driver. If added as a driver or non-driver, a new, unique driver or non-driver ID will be generated","readOnly":true},"suffix":{"type":"string","description":"The suffix of the potential resident","readOnly":true}}},"DiscoveredResidentLicenseInformation":{"type":"object","properties":{"licenseExpiryDate":{"type":"string","description":"The date the license will or has expired on for the potential resident","readOnly":true},"licenseIssueDate":{"type":"string","description":"The date the license was issued for the potential resident","readOnly":true},"licenseNumber":{"type":"string","description":"The License number of the potential resident","readOnly":true},"licenseState":{"type":"string","description":"The state the license was issued in","readOnly":true},"licenseType":{"type":"string","description":"Indicates what type of license the potential resident has","readOnly":true}},"readOnly":true},"DiscoveredResidents":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveredResident"}},"DiscoveredVehicle":{"type":"object","properties":{"discoveredVehicleId":{"type":"string","description":"A unique ID that identifies the discovered vehicle","readOnly":true},"make":{"type":"string","description":"The make of the discovered vehicle","readOnly":true},"model":{"type":"string","description":"The model of the discovered vehicle","readOnly":true},"vin":{"type":"string","description":"The VIN number of the discovered vehicle","readOnly":true},"year":{"type":"string","description":"The year of the discovered vehicle","readOnly":true}},"readOnly":true},"DiscoveredVehicles":{"type":"array","items":{"$ref":"#/components/schemas/DiscoveredVehicle"}},"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?"},"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"}},"readOnly":true},"Driver":{"type":"object","properties":{"age":{"type":"integer","description":"Age of driver at time of adding to policy.","format":"int32","readOnly":true},"dateAdded":{"type":"string","description":"Date driver was added to policy.","format":"date","readOnly":true},"dateFirstLicensed":{"type":"string","description":"The date a driver was first licensed.","format":"date"},"dateOfBirth":{"type":"string","description":"Date of birth of Driver.","format":"date"},"defensiveMatureDrivingCompletionDate":{"type":"string","description":"Date driver has completed the mature/defensive driving program.","format":"date"},"defensiveMatureDrivingCourse":{"type":"string","description":"Indicates if driver has completed a mature/defensive driving program."},"doesDriverOperatePolicyVehiclesLessThanFiftyPercent":{"type":"string","description":"Indicates if driver driver policy vehicle less than 50 % of the time."},"driverDiscounts":{"type":"array","description":"A list of discounts that apply to the driver.","readOnly":true,"items":{"$ref":"#/components/schemas/DriverDiscount"}},"employment":{"$ref":"#/components/schemas/Employment"},"extendAPIPToResidentRelatives":{"type":"string","description":"Indicates if additional personal injury protection has been extended to this driver."},"financialResponsibilityFiling":{"$ref":"#/components/schemas/FinancialResponsibilityFiling"},"firstName":{"type":"string","description":"The first name of the driver."},"gender":{"type":"string","description":"The gender of the driver."},"goodStudent":{"type":"string","description":"A Y/N or y/n value that indicates if a driver is a good student."},"goodStudentExpirationDate":{"type":"string","description":"The system derived date good student discount will expire if not reapproved.","readOnly":true},"group":{"type":"array","description":"A list of groups user belongs too that might apply a discount.","items":{"type":"string"}},"id":{"type":"string","description":"Unique numeric number for each Driver."},"lastName":{"type":"string","description":"The last name of the driver."},"levelOfEducation":{"type":"string","description":"The level of education the driver has obtained or is obtaining."},"licenseInformation":{"$ref":"#/components/schemas/LicenseInformation"},"maritalStatus":{"type":"string","description":"The marital status of the driver."},"middleInitial":{"type":"string","description":"The middle initial of the driver."},"mvrOrderResponseInfo":{"$ref":"#/components/schemas/MvrOrderResponseInfo"},"numberOfPIPClaimsLastThreeYears":{"type":"string","description":"A numeric value representing the number of PIP claims a driver has incurred in the last three years. For application, there should be a matching number of PIP claims on the driver Incident record."},"relationshipToInsured":{"type":"string","description":"Identifies the relationship of the driver to the Named Insured."},"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."},"studentAwayAtSchool":{"type":"string","description":"Question that indicates if student is away at school and if so with or without a vehicle."},"suffix":{"type":"string","description":"The suffix to the last name of the driver."},"telematics":{"$ref":"#/components/schemas/Telematics"},"totalPointsAssigned":{"type":"integer","description":"The number of points charged to a specific driver based on their list of moving violations.","format":"int32","readOnly":true},"yearsLicenseExperience":{"type":"integer","description":"Number of years the driver has been licensed to drive a vehicle.","format":"int32","readOnly":true}}},"DriverDiscount":{"type":"object","properties":{"name":{"type":"string","description":"The name of the discount.","readOnly":true}},"readOnly":true},"Drivers":{"type":"array","items":{"$ref":"#/components/schemas/Driver"}},"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}}},"EmployerOrSchool":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/EmployerOrSchoolAddress"},"name":{"type":"string","description":"The name of the employer or school."},"worksFromHome":{"type":"string","description":"A Y/N or y/n value that indicates if the driver works from home."}}},"EmployerOrSchoolAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address of employer or school."},"city":{"type":"string","description":"City of employer or school."},"state":{"type":"string","description":"State of employer or school."},"zipCode":{"type":"string","description":"ZipCode of employer or school."}}},"Employment":{"type":"object","properties":{"employerOrSchool":{"$ref":"#/components/schemas/EmployerOrSchool"},"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."},"selfEmployedEmployeesDrivePolicyVehicle":{"type":"string","description":"A Y/N or y/n value that indicates if a self employed driver has employees that drive a vehicle on this policy."},"usePolicyVehicleForBusinessTravel":{"type":"string","description":"A Y/N or y/n value that indicates if the driver has uses a policy vehicle reason related to their business or profession."},"useVehicleToTransportPatientsOrClients":{"type":"string","description":"A Y/N or y/n value that indicates if the driver uses a policy vehicle to transport patients for clients related to their business or profession."}}},"FinancialResponsibilityFiling":{"type":"object","properties":{"filingExpirationDate":{"type":"string","description":"Filing Expiration Date of filing.","format":"date"},"filingNumber":{"type":"string","description":"Number assigned to the filing with the state."},"type":{"type":"string","description":"If needed, the type of filing required or if no filing is required for this driver. This varies by state."}}},"Fl":{"type":"object","properties":{"wageLoss":{"type":"string","description":"This option allows for insured to indicate if coverage is desired and if so, what limit."}}},"FlCovOptions":{"type":"object","properties":{"stacked":{"type":"string","description":"A yes|no value indicating if the stacked version of the coverage is desired. If no, coverage will be non-stacked."}}},"GaCovOptions":{"type":"object","properties":{"umCoverageOption":{"type":"string","description":"Indicates if the \"Added-On\" version of Uninsured/Underinsured coverage was selected."}}},"GaragingAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"Address line one of where vehicle is garaged."},"addressLineTwo":{"type":"string","description":""},"city":{"type":"string","description":"City of where vehicle is garaged."},"county":{"type":"string","description":"County of where vehicle is garaged."},"instateZipCode":{"type":"string","description":"A zipcode in the state the policy is written in to be used to rate the out of state vehicle."},"state":{"type":"string","description":"State of where vehicle is garaged."},"zipCode":{"type":"string","description":"Zipcode of where vehicle is garaged."}}},"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"},"paymentTypes":{"type":"array","description":"Provides detailed payment information for payment option and payment plan combination","items":{"$ref":"#/components/schemas/PaymentType"}},"status":{"type":"string","description":"The status of a submitted payment method for a quote","readOnly":true,"example":"Validated"}}},"GetPaymentMethodResponses":{"type":"array","items":{"$ref":"#/components/schemas/GetPaymentMethodResponse"}},"Incident":{"type":"object","properties":{"aboveThreshold":{"type":"string","description":"A Y/N or y/n field that indicates if a specific loss was above or below the $1000 damage threshold."},"applied":{"type":"string","description":"Indicates if the incident was applied to the risk/policy.","readOnly":true},"chargeability":{"type":"string","description":"Indicates if a violation is chargeable. Note: Agents need to provide for user entered violations and \"Charge at Renewal\" and \"Waived\" are system derived values that a user cannot select."},"convictionDate":{"type":"string","description":"The date the assigned driver was convicted. This is also used to show when a license suspension or revocation was reinstated.","format":"date"},"id":{"type":"string","description":"ID of a specific incident.","readOnly":true},"incidentClaimNumber":{"type":"string","description":"The Mercury assigned claim number for the incident.","readOnly":true},"incidentComments":{"type":"string","description":"Information regarding a change to a CLUE incident. Note, a comment can only be entered when a CLUE loss assigned to a driver by the system is unassigned from that driver."},"incidentDescription":{"type":"string","description":"A description of the incident."},"incidentPoints":{"type":"integer","description":"A response value indicating how many points have been applied against this incident.","format":"int32","readOnly":true},"incidentSource":{"type":"string","description":"Indicates where the incident was sourced from.","readOnly":true},"incidentType":{"type":"string","description":"An internal value that indicates what kind of incident occurred.","readOnly":true},"lossDetail":{"$ref":"#/components/schemas/LossDetail"},"mvrDetail":{"$ref":"#/components/schemas/MvrDetail"},"violationDate":{"type":"string","description":"The date the incident occurred. When creating a manual incident this field is required.","format":"date"}}},"Incidents":{"type":"array","items":{"$ref":"#/components/schemas/Incident"}},"InitiateQuoteAddress":{"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":"The Address Type (either Prior or Mailing)"},"city":{"type":"string","description":"The city for the address"},"county":{"type":"string","description":"The county for the address"},"state":{"type":"string","description":"The state for the address"},"zipCode":{"type":"string","description":"The zip for the address"}}},"InitiateQuoteEffectiveDates":{"type":"object","properties":{"termEffDate":{"type":"string","description":"The date the policy is desired to take effect.","format":"date"}}},"InitiateQuoteNamedInsured":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Date of birth of the named insured","format":"date"},"firstName":{"type":"string","description":"First name of the named insured"},"gender":{"type":"string","description":"Gender of the primary insured"},"lastName":{"type":"string","description":"Last Name of the named insured"},"middleInitial":{"type":"string","description":"Middle initial 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."}}},"InitiateQuotePolicyInfo":{"type":"object","properties":{"address":{"type":"array","items":{"$ref":"#/components/schemas/InitiateQuoteAddress"}},"effectiveDates":{"$ref":"#/components/schemas/InitiateQuoteEffectiveDates"},"namedInsured":{"type":"array","description":"List of Named Insureds for the policy","items":{"$ref":"#/components/schemas/InitiateQuoteNamedInsured"}}}},"InitiateQuoteRequest":{"required":["agencyCode","policyInfo"],"type":"object","properties":{"agencyCode":{"type":"string","description":"The Agency Code submitting the Request"},"policyInfo":{"$ref":"#/components/schemas/InitiateQuotePolicyInfo"}},"description":"Represents the Request for the Initiate Quote API"},"InitiateQuoteResponse":{"type":"object","properties":{"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"}},"readOnly":true},"Liability":{"type":"object","properties":{"bodilyInjuryPropertyDamageLimits":{"type":"string","description":"The bodily injury per person/per accident coverage limit and the property damage coverage limit for the policy"},"covOptions":{"$ref":"#/components/schemas/LiabilityCovOptions"},"supplementalSpousalLiability":{"type":"string","description":"A yes/no value to indicate this coverage is selected. Note: This coverage only applies to the state of NY."}}},"LiabilityCovOptions":{"type":"object","properties":{"nj":{"$ref":"#/components/schemas/NjCovOptions"}}},"LicenseInformation":{"type":"object","properties":{"country":{"type":"string","description":"If license is a foreign license. What country the license is from."},"licenseNumber":{"type":"string","description":"If license is is a US license and is a valid license or permit, what the issued licensed number is."},"licenseState":{"type":"string","description":"If license is a US license, what state the licensed was issued."},"licenseStatus":{"type":"string","description":"The current status of the driver license.","readOnly":true},"type":{"type":"string","description":"Indicates what type of license the driver is presenting."}}},"LossCarrierInformation":{"type":"object","properties":{"address":{"type":"string","description":"The address one data provided by the reporting carrier.","readOnly":true},"cityStateZip":{"type":"string","description":"A concatenation of the city, state and zip code for the address one provided by the reporting carrier.","readOnly":true},"insurer":{"type":"string","description":"the name of the carrier that reported the loss.","readOnly":true},"licenseNumber":{"type":"string","description":"The license number of the policyholder.","readOnly":true},"licenseState":{"type":"string","description":"The license state of the policyholder.","readOnly":true},"operatorGender":{"type":"string","description":"The gender of the person who was driving the vehicle for the incident reported.","readOnly":true},"policyholderName":{"type":"string","description":"Name of the policyholder under which the loss occurred.","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 person who was driving the vehicle for the incident reported.","readOnly":true},"vin":{"type":"string","description":"The VIN 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},"LossDetail":{"type":"object","properties":{"chargeable":{"type":"string","description":"Indicates if the loss was charged against the risk/policy.","readOnly":true},"claimDate":{"type":"string","description":"The date the incident occurred.","format":"date","readOnly":true},"claimDescription":{"type":"string","description":"A description of the loss.","readOnly":true},"claimStatus":{"type":"string","description":"","readOnly":true},"claimType":{"type":"string","description":"Indicates what type of loss this is.","readOnly":true},"coveragePayoutInformation":{"type":"array","description":"A collection of information regarding the payments made for this incident.","readOnly":true,"items":{"$ref":"#/components/schemas/CoveragePayoutInformation"}},"faultIndicator":{"type":"string","description":"Indicates if the loss was at fault or not at fault.","readOnly":true},"lossCarrierInformation":{"$ref":"#/components/schemas/LossCarrierInformation"},"orderDate":{"type":"string","description":"The date the CLUE was ordered.","format":"date","readOnly":true},"paymentDate":{"type":"string","description":"Date payment on the loss was made.","format":"date","readOnly":true}},"readOnly":true},"MercuryRelationshipResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the quote/policy entity","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"description":"Response for Mercury Relationship bridging endpoint that mimics the MercuryRelationshipResponse structure"},"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"},"Motorhome":{"type":"object","properties":{"length":{"type":"string","description":"The length of the motorhome in feet."}}},"MvrDetail":{"type":"object","properties":{"convictionDate":{"type":"string","description":"The date the vendor indicates the the driver was convicted of the incident.","format":"date","readOnly":true},"description":{"type":"string","description":"The Mercury provided description of the loss.","readOnly":true},"dmvVendorPointCount":{"type":"string","description":"The point count retrieved by the vendor from the state DMV.","readOnly":true},"enhancedDescription":{"type":"string","description":"A combination of Mercury loss description and vendor provided description.","readOnly":true},"reason":{"type":"string","description":"Vendor assigned Reason text.","readOnly":true},"source":{"type":"string","description":"The vendor from whom the data was sourced.","readOnly":true},"stateViolationCode":{"type":"string","description":"The state code cited for the violation.","readOnly":true},"svcCode":{"type":"string","description":"The vendor assigned proprietary code.","readOnly":true},"svcSuffix":{"type":"string","description":"The vendor assigned proprietary suffix code.","readOnly":true},"violationCategory":{"type":"string","description":"System derived value that indicates what category the incident is in per Mercury.","readOnly":true},"violationDate":{"type":"string","description":"The date the vendor indicates the incident occurred.","format":"date","readOnly":true},"violationNumber":{"type":"string","description":"An internal ID for the incident.","readOnly":true},"violationType":{"type":"string","description":"An internal value that indicates what kind of incident occurred.","readOnly":true}},"readOnly":true},"MvrOrderResponseInfo":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"The date of birth of the person the MVR was ordered for.","format":"date","readOnly":true},"expirationDate":{"type":"string","description":"For the MVR ordered, the date the license expires or expired.","format":"date","readOnly":true},"fullName":{"type":"string","description":"The name of the person the MVR was ordered for.","readOnly":true},"gender":{"type":"string","description":"The gender of the person the MVR was ordered for.","readOnly":true},"issueDate":{"type":"string","description":"For the MVR ordered, the date the license was issued.","format":"date","readOnly":true},"licenseClass":{"type":"string","description":"The class of license.","readOnly":true},"licenseNumber":{"type":"string","description":"The license # of the person the MVR was ordered for.","readOnly":true},"licenseStatus":{"type":"string","description":"The license status of the person the MVR was ordered for.","readOnly":true},"mvrOrderedDate":{"type":"string","description":"The date the MVR was ordered","format":"date","readOnly":true},"mvrStatus":{"type":"string","description":"The status of the MVR order","readOnly":true},"restrictions":{"type":"string","description":"A list of restrictions that exist on the license.","readOnly":true}},"readOnly":true},"NamedInsured":{"type":"object","properties":{"dateOfBirth":{"type":"string","description":"Date of birth of the named insured","format":"date"},"firstName":{"type":"string","description":"First name of the named insured"},"gender":{"type":"string","description":"Gender of the primary insured"},"lastName":{"type":"string","description":"Last Name of the named insured"},"middleInitial":{"type":"string","description":"Middle initial 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."}}},"NjCovOptions":{"type":"object","properties":{"tortThreshold":{"type":"string","description":"Indicates if application of Tort to Bodily Injury coverage will have a limitation or no limitation."}}},"NjPip":{"type":"object","properties":{"addHealthInsurerName":{"type":"string","description":"If Health Insurance options is Primary, insured has the option to provide an additional Health Insurance name."},"addPolicyGroupNumber":{"type":"string","description":"If Health Insurance options is Primary, and insured has selected to provide and additional Health Insurer, an additional policy group number is required."},"extendedMedicalBenefits":{"type":"string","description":"Indicates the limit of coverage selected."},"healthInsurance":{"type":"string","description":"Indicates what type of Health Insurance insured selects."},"healthInsurerName":{"type":"string","description":"If Health Insurance options is Primary, the name of their Health Insurer is required."},"medicalExpenseOnly":{"type":"string","description":"A Y/N value that indicates if this coverage is selected."},"policyGroupCertNumber":{"type":"string","description":"If Health Insurance options is Primary, the policy number for your policy group number is required."}}},"NonDriver":{"type":"object","properties":{"dateAdded":{"type":"string","description":"Date nondriver was added to the policy.","format":"date","readOnly":true},"dateOfBirth":{"type":"string","description":"Date of Birth of the additional household member.","format":"date"},"excluded":{"type":"string","description":"Indicates if additional household member is excluded from the policy.","readOnly":true},"extendAPIPToResidentRelatives":{"type":"string","description":"Indicates if additional personal injury protection has been extended to this driver."},"firstName":{"type":"string","description":"First name of the additional household member."},"gender":{"type":"string","description":"The gender of the non-driver."},"id":{"type":"string","description":"Id of additional household member.","readOnly":true},"lastName":{"type":"string","description":"Last Name  of the additional household member."},"licenseNumber":{"type":"string","description":"The license number of the excluded driver."},"licenseState":{"type":"string","description":"The license state of the excluded driver."},"middleInitial":{"type":"string","description":"Optional middle initial  of the additional household member."},"otherMercuryPolicyNumber":{"type":"string","description":"If Mercury finds the policy number for additional household member when reason for nondriver is \"has other insurance with Mercury - same address\".","readOnly":true},"reasonForNonDriver":{"type":"string","description":"Reason why person is being listed as an additional household member."},"relationshipToInsured":{"type":"string","description":"Value that indicates the additional household members relationship to the named insured."},"suffix":{"type":"string","description":"Optional suffix  of the additional household member."}}},"NonDrivers":{"type":"array","items":{"$ref":"#/components/schemas/NonDriver"}},"NonFactoryEquipment":{"type":"object","properties":{"description":{"type":"string","description":"A description of the non factory or excess equipment."},"typeOfEquipment":{"type":"string","description":"Indicates what type of non factory or excess equipment is on the vehicle"},"value":{"type":"string","description":"The dollar value of the non factory or excess equipment."}}},"Ny":{"type":"object","properties":{"deathBenefits":{"type":"string","description":"The limit of the benefit applied to the policy.","readOnly":true},"monthlyWorkLoss":{"type":"string","description":"The limit of the benefit applied to the policy.","readOnly":true},"otherExpenses":{"type":"string","description":"The limit of the benefit applied to the policy","readOnly":true}},"readOnly":true},"OdometerHistory":{"type":"object","properties":{"odometer":{"type":"integer","description":"This is the numeric odometer reading.","format":"int32","readOnly":true},"odometerReadingDate":{"type":"string","description":"This is the date the odometer reading was obtained.","format":"date","readOnly":true},"source":{"type":"string","description":"This indicates the source of the odometer reading.","readOnly":true},"usedInAnnualMileageCalculation":{"type":"string","description":"Indicates if the odometer reading was used to qualify the vehicle for RealDrive Verified program.","readOnly":true}},"readOnly":true},"Options":{"type":"object","properties":{"fl":{"$ref":"#/components/schemas/Fl"},"nj":{"$ref":"#/components/schemas/NjPip"},"ny":{"$ref":"#/components/schemas/Ny"}}},"OrderReportRecord":{"type":"object","properties":{"entity":{"type":"string","description":"The value on which the report was ordered.","readOnly":true},"name":{"type":"string","description":"Name of the report ordered.","readOnly":true},"orderDate":{"type":"string","description":"The date that the report was ordered.","readOnly":true},"referenceId":{"type":"string","description":"System provided numeric ID that is specific to a report order.","readOnly":true},"reportGroup":{"type":"string","description":"The report group to which the report belongs.","readOnly":true},"status":{"type":"string","description":"Status of the report ordered.","readOnly":true}},"readOnly":true},"OrderReports":{"type":"object","properties":{"reportOrderingComplete":{"type":"boolean","description":"Indicates if requested report order set was successfully ordered.","readOnly":true},"reports":{"type":"array","description":"Collection of data regarding the status of individual reports ordered within a requested report set.","readOnly":true,"items":{"$ref":"#/components/schemas/OrderReportRecord"}}},"readOnly":true},"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"}}},"OtherMercuryPolicies":{"type":"object","properties":{"policyNumber":{"type":"string","description":"Policy Number if applicant has an existing policy with Mercury."},"typeOfPolicy":{"type":"string","description":"Indicates what type of policy is desired or applicant currently has."}}},"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}}},"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"}}},"PaymentType":{"type":"object","properties":{"paymentType":{"type":"string","description":"Denotes if payment method is set for a down payment or installment payments","example":"DownPayment"}}},"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}},"readOnly":true},"PayPlanOptions":{"type":"array","items":{"$ref":"#/components/schemas/BillingDetail"}},"Person":{"type":"object","properties":{"driverId":{"type":"string","description":"If registered owner of the vehicle is a driver on the policy.","readOnly":true},"firstName":{"type":"string","description":"First name of the person who has an interest in the vehicle."},"lastName":{"type":"string","description":"Last Name of the person who has an interest in the vehicle."},"middleInitial":{"type":"string","description":"Optional middle initial of the person who has an interest in the vehicle."},"nonDriverId":{"type":"string","description":"If registered owner of the vehicle is a non-driver on the policy.","readOnly":true},"suffix":{"type":"string","description":"Optional suffix of the person who has an interest in the vehicle."}}},"Pip":{"type":"object","properties":{"options":{"$ref":"#/components/schemas/Options"},"personalInjuryProtectionDeductible":{"type":"string","description":"This is the coverage deductible for the  Personal Injury Protection limit the insured selects."},"personalInjuryProtectionLimit":{"type":"string","description":"This is the coverage limit of Personal Injury Protection insured selects."}}},"PolicyDeductibles":{"type":"object","properties":{"allOtherPerils":{"type":"string","description":"Indicates the desired limit of coverage"}}},"PolicyDiscount":{"type":"object","properties":{"name":{"type":"string","description":"A response value listing the discounts that have been applied to the policy.","readOnly":true}},"readOnly":true},"PolicyDriverIncident":{"type":"object","properties":{"driverId":{"type":"string","description":"The driver id that these incidents belong to."},"incidents":{"type":"array","description":"A list of incidents that apply to the driver.","items":{"$ref":"#/components/schemas/Incident"}}}},"PolicyFee":{"type":"object","properties":{"amount":{"type":"number","description":"The dollar amount of the fee.","format":"double","readOnly":true},"name":{"type":"string","description":"The name of an additional fee imposed on the rate that is added to total policy premium.","readOnly":true}},"readOnly":true},"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"},"annualMileage":{"$ref":"#/components/schemas/AnnualMileage"},"appliedPolicyDiscounts":{"type":"array","description":"A list of discounts that have been applied to the policy.","readOnly":true,"items":{"$ref":"#/components/schemas/PolicyDiscount"}},"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."},"currentHOWrittenByAgency":{"type":"string","description":"Indicates if the agency writes the HO3 (homeowner), HO5 (Comprehensive Homeowner) or HO6 (Condo)policy with another carrier."},"effectiveDates":{"$ref":"#/components/schemas/EffectiveDates"},"emailAddress":{"type":"string","description":"The primary email address where insured would like Mercury to deliver communications."},"esignOptIn":{"type":"string","description":"Indicates if user intends to esign application and other documents."},"homeownershipVerified":{"type":"string","description":"A Yes or No value indicating if homeownership has been verified.","readOnly":true},"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"},"namedInsured":{"type":"array","description":"The full name and other data related to a named insured.","readOnly":true,"items":{"$ref":"#/components/schemas/NamedInsured"}},"otherMercuryPolicies":{"type":"array","description":"Ask for information if applicant desires or has another policy with Mercury under other lines of business.","items":{"$ref":"#/components/schemas/OtherMercuryPolicies"}},"paperlessOptin":{"type":"string","description":"Indicates if applicant wishes to enroll in the paperless program.  NOTE: By enrolling in the paperless program, applicant consents to allowing Mercury to automatically create a customer portal account."},"permissionToOrderCredit":{"type":"string","description":"A Y/N or y/n that indicates if applicant has granted permission for Mercury to order their credit score."},"policyFees":{"type":"array","description":"List of fees applied to the total premium","readOnly":true,"items":{"$ref":"#/components/schemas/PolicyFee"}},"policyPhones":{"type":"array","description":"A collection of phone numbers that apply to the policy.","items":{"$ref":"#/components/schemas/PolicyPhone"}},"priorInsurance":{"type":"array","description":"This section describes data needed on prior insurance carrier if insured was previously insured.","items":{"$ref":"#/components/schemas/PriorInsurance"}},"priorMercuryPPAPolicyNumber":{"type":"string","description":"The policy number of any prior policy insured had with Mercury.","readOnly":true},"termLength":{"type":"string","description":"A numeric value indicating if policy is six or twelve months."},"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"}},"totalHouseholdResidents":{"type":"string","description":"A numeric value representing the total count of persons residing in the insured's household. This includes all family members regardless of age and any other relatives or roommates."},"type":{"type":"string","description":"A value that indicates what type of policy was sold for New Jersey."},"typeResidence":{"type":"string","description":"Indicates the type of residence that is owned or rented or lived in."}}},"PolicyInfoAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address that insured has provided as their mailing address."},"addressLineTwo":{"type":"string","description":"Additional information on the mailing address provided by the insured such as suite or apt."},"addressType":{"type":"string","description":"A collection of values that contain information on policy address."},"city":{"type":"string","description":"Name of the city that the insured has provided as part of their mailing address."},"county":{"type":"string","description":"The name of county the address resides in."},"state":{"type":"string","description":"The full name of the state that the insured has provided as part of their mailing address."},"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 mailing address."}}},"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."}}},"PolicyVehicleInterest":{"type":"object","properties":{"interests":{"type":"array","description":"A list of interests that apply to the vehicle.","items":{"$ref":"#/components/schemas/VehicleOwnershipInterest"}},"vehicleId":{"type":"string","description":"The vehicle id that these interests belong to."}}},"PpaVin":{"type":"object","properties":{"antiLock":{"type":"string","description":"A text description of what version of antilock brakes come with the vehicle. This will not reflect any upgrades applied by owner","example":"Anti-Lock Brakes Four Wheels"},"antiTheft":{"type":"string","description":"A text description of what type of anti-theft device comes with the vehicle.  This will not reflect any upgrades applied by owner","example":"Alarm Only"},"bodyType":{"type":"string","description":"The full description name as it is listed in the database","example":"SEDAN 4D LE I4"},"cylinders":{"type":"string","description":"A numeric value indicating the number of cylinders in the engine. Helpful in selecting the correct vehicle when multiple VIN records are returned","example":"8"},"daytimeRunningLights":{"type":"string","description":"A yes or no value that indicates if the vehicle comes with daytime running lights"},"drivingWheels":{"type":"string","description":"A numeric value indicating the vehicle wheelbase. Helpful in selecting the correct vehicle when multiple VIN records are returned","example":"42"},"electicVehicleIndicator":{"type":"string","description":"A yes or no value that indicates if vehicle is considered an electric vehicle"},"make":{"type":"string","description":"The full make name as it is listed in the database.","example":"TOYOTA"},"model":{"type":"string","description":"The full model name as it is listed in the database","example":"COROLLA"},"passiveRestraint":{"type":"string","description":"A text description of what version of passive restraint system comes with the vehicle. This will not reflect any upgrades applied by owner","example":"Air Bag - both front seats"},"turbo":{"type":"string","description":"A yes or no value indicating if vehicle engine is a turbo-charged engine. Helpful in selecting the correct vehicle when multiple VIN records are returned"},"vin":{"type":"string","description":"A VIN number up to the the first 10 characters as is listed in the database.  This will include special characters for variables and spaces","example":"2GCHG31K-P"},"year":{"type":"string","description":"The full four digit year","example":"2022"}}},"PpaVinMakesResponse":{"type":"object","properties":{"makes":{"type":"array","description":"Applicable list of Vehicle Makes for a given year","items":{"type":"string"}}}},"PpaVinModelsResponse":{"type":"object","properties":{"models":{"type":"array","description":"Applicable list of Vehicle Models for a given year","items":{"type":"string"}}}},"PpaVinRetrieveResponse":{"type":"object","properties":{"vins":{"type":"array","description":"Applicable list of VIN Numbers for the given lookup","items":{"$ref":"#/components/schemas/PpaVin"}}}},"PpaVinYearsResponse":{"type":"object","properties":{"years":{"type":"array","description":"Applicable list of Vehicle Years to retrieve Vehicles for","items":{"type":"string"}}}},"Premium":{"type":"object","properties":{"coverageName":{"type":"string","description":"The name of the coverage.","readOnly":true},"coveragePremium":{"type":"number","description":"The premium for the coverage.","format":"double","readOnly":true},"coverageValue":{"type":"string","description":"The limit of deductible of the coverage.","readOnly":true}},"readOnly":true},"PriorInsurance":{"type":"object","properties":{"continuousInsLastSixMonths":{"type":"string","description":"A Y/N or y/n value indicating if insured has been continuously insured in the past six months."},"insuredMostRecentCompany":{"type":"string","description":"If has the insured been continuously insured for the past six months = Yes OR If has the insured been continuously insured for the past six months = No and If How long has the insured been without insurance in the last six months = Less than 31 days, provide the prior length if time insured with that company."},"priorBodilyInjuryLimit":{"type":"string","description":"The bodily injury per person/per accident limit on the prior policy."},"priorInsuranceDataUsedToRate":{"type":"string","description":"Indicates which set of prior insurance data was used if the agent and/or underwriter override the data generated by the system.","readOnly":true},"priorInsurer":{"type":"string","description":"The name of the current or previous insurance company."},"reasonNoPriorInsurance":{"type":"string","description":"If has the insured been continuously insured for the past six months = No and if How long has the insured been without insurance in the last six months IS NOT EQUAL TO Less than 31 days, provide a reason why."},"reasonQuoteWithMercury":{"type":"string","description":"If current or prior carrier is Mercury Insurance, provide a reason why requoting with Mercury."},"source":{"type":"string","description":"The source of this prior insurance data.","readOnly":true},"totalPriorTenure":{"type":"string","description":"The total time the applicant been continuously insured (without lapse) with all prior insurance companies."},"usedInRate":{"type":"string","description":"Whether or not this prior insurance data was used in the policy rate.","readOnly":true},"verifiedNoLapseStartDate":{"type":"string","description":"A system generated value that indicates how long insured has has continuous insurance without a lapse.","format":"date"},"withoutInsLastSixMonths":{"type":"string","description":"If has the insured been continuously insured for the past six months = No, provide the prior length if time that insured was not insured."}}},"QuickQuotePPA":{"type":"object","properties":{"agencyCode":{"type":"string","description":"The Agency code the quote should belong to"},"driverIncidents":{"type":"array","description":"A list of incidents that apply to the driver.","items":{"$ref":"#/components/schemas/PolicyDriverIncident"}},"drivers":{"type":"array","description":"The information about the drivers.","items":{"$ref":"#/components/schemas/Driver"}},"nonDrivers":{"type":"array","description":"The information about the non-drivers.","items":{"$ref":"#/components/schemas/NonDriver"}},"policyCoverages":{"$ref":"#/components/schemas/Coverages"},"policyInfo":{"$ref":"#/components/schemas/PolicyInfo"},"vehicleAssignments":{"type":"array","description":"The information about the vehicle assignments.","items":{"$ref":"#/components/schemas/VehicleAssignment"}},"vehicleInterests":{"type":"array","description":"A list of interests sorted by vehicle ids that apply to the vehicle.","items":{"$ref":"#/components/schemas/PolicyVehicleInterest"}},"vehicles":{"type":"array","description":"The information about the vehicles.","items":{"$ref":"#/components/schemas/Vehicle"}}}},"QuickQuoteResponse":{"type":"object","properties":{"discounts":{"type":"array","description":"Lists the Discounts applicable on the quote","items":{"$ref":"#/components/schemas/Discount"}},"id":{"type":"string","description":"The unique quote number generated for PPA Quick Quote","format":"uuid"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}},"paymentSchedule":{"type":"object","description":"Represents a list of Possible Payment Schedules for the Policy","allOf":[{"$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"}},"vehicleId":{"type":"string"}}},"QuoteRateResponse":{"type":"object","properties":{"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":{"type":"object","description":"Represents a list of Possible Payment Schedules for the Policy","allOf":[{"$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"},"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 slected for rejected, canedled 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"}}},"SelfEmployedFromHomeDetails":{"type":"object","properties":{"anyEmployees":{"type":"string","description":"Indicates if any employess exist and if so, are they related or unrelated to the named insured"},"description":{"type":"string","description":"Description for self-employed household members, such as occupancy industry and type."},"footTraffic":{"type":"string","description":"Due to self-employment from the home, is there any foot traffic at the home"},"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":{"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"}},"readOnly":true},"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"}}},"Telematics":{"type":"object","properties":{"driverScoreTier":{"type":"string","description":"The score a driver has earned in the telematics programs.","readOnly":true},"enrollment":{"type":"string","description":"A Y/N or y/n value indicting if driver is enrolled in MercuryGo telematics programs."},"mercuryGoConsent":{"type":"string","description":"A Y/N value indicating Customer(s) have provided express consent for Mercury, through its technology partner, to text MercuryGO App downloading and registration information to them, and other information pertaining to the customer's MercuryGO account, at the mobile phone(s) the customer provided."},"mobilePhoneNumber":{"type":"string","description":"A unique mobile phone number that will be used in the telematics programs."}}},"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."}}},"Trailer":{"type":"object","properties":{"length":{"type":"string","description":"The length of the trailer in feet."},"type":{"type":"string","description":"Indicates the type or style of the trailer."}}},"TransactionInfo":{"type":"object","properties":{"bindingDate":{"type":"string","description":"Indicates the current status of a policy.","format":"date"},"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"},"originalTermEffDate":{"type":"string","description":"The first effective date for a policy number.","format":"date"},"policyNumber":{"type":"string","description":"The assigned policy number.","readOnly":true},"renewalConversion":{"type":"string","description":"Indicates if the policy was a renewal conversion.","readOnly":true},"status":{"type":"string","description":"Indicates if Draft, rated, inforce, renewal.","readOnly":true},"termLength":{"type":"string","description":"A numeric value indicating if policy is six or twelve months.","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":"The type of transaction - Draft, Rated, Policy change","readOnly":true},"underwritingCompany":{"type":"string","description":"The name of the company under which the policy is written.","readOnly":true}}},"TransportationNetworkCompany":{"type":"object","properties":{"averageWeeklyTNCHours":{"type":"string","description":""},"driverId":{"type":"string","description":"Driver  ID of the person operating the vehicle for TNC purposes."}}},"TypeOptions":{"type":"object","properties":{"motorhome":{"$ref":"#/components/schemas/Motorhome"},"trailer":{"$ref":"#/components/schemas/Trailer"}}},"UmCoverage":{"type":"object","properties":{"covOptions":{"$ref":"#/components/schemas/CovOptions"},"propertyDamageOrCdw":{"type":"string","description":"This is a California specific application of the coverage. If selected, coverage will be property damage unless the vehicle has collision coverage. In that case, coverage will become collision deductible waiver. The application of this coverage is per vehicle."},"underinsuredBodilyInjuryLimit":{"type":"string","description":"The underinsured per person.per accident coverage limit."},"underinsuredPropertyDamageDeductible":{"type":"string","description":"This is the property damage deductible for uninsured motorist coverage.","readOnly":true},"underinsuredPropertyDamageLimit":{"type":"string","description":"The underinsured property damage limit.","readOnly":true},"uninsuredBodilyInjuryLimit":{"type":"string","description":"The uninsured per person/per accident coverage limit."},"uninsuredPropertyDamageDeductible":{"type":"string","description":"This is the property damage deductible for uninsured motorist coverage. If uninsured and underinsured are one coverage, sent limit under this element."},"uninsuredPropertyDamageLimit":{"type":"string","description":"The uninsured motorist property damage limit."}}},"UnassignedIncident":{"type":"object","properties":{"comment":{"type":"string","description":"If unassigned is set to yes, then user must provide a comment as to why is it unassigned."},"driverId":{"type":"string","description":"The id of the driver to which the unassigned loss is being assigned."},"unassigned":{"type":"string","description":"A Y/N or y/n value indicating if loss should be unassigned or not."}}},"VaCovOptions":{"type":"object","properties":{"umType":{"type":"string","description":"Indicates if the standard or alternative form of UM is desired."}}},"Vehicle":{"type":"object","properties":{"garagingAddress":{"$ref":"#/components/schemas/GaragingAddress"},"nonFactoryEquipment":{"type":"array","description":"A collection of data regarding non factory/excess equipment if coverage is desired","items":{"$ref":"#/components/schemas/NonFactoryEquipment"}},"odometerHistory":{"type":"array","description":"List of Odometer History Records","readOnly":true,"items":{"$ref":"#/components/schemas/OdometerHistory"}},"policyType":{"type":"string","description":"The type of policy that this vehicle is related to."},"premiums":{"type":"array","description":"A Collection of data for premiums generated","readOnly":true,"items":{"$ref":"#/components/schemas/Premium"}},"vehicleCoverages":{"$ref":"#/components/schemas/VehicleCoverages"},"vehicleDiscounts":{"type":"array","description":"A list of discounts that were applied to a specific vehicle","readOnly":true,"items":{"$ref":"#/components/schemas/VehicleDiscount"}},"vehicleInformation":{"$ref":"#/components/schemas/VehicleInformation"},"vehicleQuestions":{"$ref":"#/components/schemas/VehicleQuestions"},"vehicleUsage":{"$ref":"#/components/schemas/VehicleUsage"}}},"VehicleAssignment":{"type":"object","properties":{"driverAssignments":{"type":"array","description":"Allows users to assign a driver to a vehicle, obtain a list of drivers and the vehicles they are assigned to and remove a driver from a vehicle assignment","items":{"$ref":"#/components/schemas/VehicleAssignmentEntry"}}}},"VehicleAssignmentEntry":{"type":"object","properties":{"driverId":{"type":"string","description":"Indicates the driver ID number for the driver who primarily or occasionally drives this vehicle.   Provide the driver ID's for the primary or principal driver of the vehicle. In California or New York, only one primary or principal driver is allowed. In Virgina, there can be multiple primary drivers"},"driverType":{"type":"string","description":"Indicates if the driver is primary or, in California, Primary or Occasional. Rated is a driver type that is response only when applicable"},"vehicleId":{"type":"string","description":"The ID of the vehicle the driver is to be assigned"}}},"VehicleAttributes":{"type":"object","properties":{"antiLockBrakes":{"type":"string","description":"Indicates if the vehicle has antilock brakes and if so what type."},"antiTheftDevices":{"type":"array","description":"Indicates if the vehicle has any anti-theft devices installed.","items":{"$ref":"#/components/schemas/AntiTheftDevices"}},"daytimeRunLights":{"type":"string","description":"NY Only - Indicates if the vehicle has daytime running lights."},"passiveRestraint":{"type":"string","description":"Indicates if the vehicle has a form of restraint that aids to protect injury to any passenger is present."}}},"VehicleCoverages":{"type":"object","properties":{"collision":{"type":"string","description":"Collision Deductible Desired."},"collisionDeductibleWaiver":{"type":"string","description":"Collision Deductible Limit."},"comprehensiveOrOtherThanCollision":{"type":"string","description":"Comprehensive Deductible Desire."},"loanLeasePayoff":{"type":"string","description":"A yes/no value indicating if this vehicle will have loan lease payoff coverage."},"nonFactoryEquipment":{"type":"string","description":"The total amount of non-factory equipment items listed for a vehicle to be covered","readOnly":true},"originalEquipmentManufacturer":{"type":"string","description":"A valid value indicating of the vehicle has this coverage. See VehicleCoverages for vehicle types to which this coverage applies."},"rentalCar":{"type":"string","description":"Rental car limit desired."},"repairOrReplacementCost":{"type":"string","description":"A yes/no value indicating of the vehicle has this coverage."},"roadsideAssistanceOrTowingLabor":{"type":"string","description":"The Roadside Assistance or Towing and Labor limit desired."},"transportationExpense":{"type":"string","description":"Transportation Expense limit desired."},"umpdDeductible":{"type":"string","description":"UMPD Deductible. See VehicleCoverages for vehicle types to which this coverage applies.","readOnly":true},"umpdLimit":{"type":"string","description":"Uninsured Property Damage Limit."}}},"VehicleDiscount":{"type":"object","properties":{"name":{"type":"string","description":"The name of the discount(s) applied","readOnly":true}},"readOnly":true},"VehicleInformation":{"type":"object","properties":{"currentlyHaveLessThanOneThousandMiles":{"type":"string","description":"A Y/N or y/n value indicating if vehicle has less then 1000 miles on the odometer."},"dateAdded":{"type":"string","description":"The date vehicle is being added to the policy.","format":"date","readOnly":true},"electricVehicleIndicator":{"type":"string","description":"Indicates if vehicle qualifies as an electric vehicle."},"garagedAtPolicyAddress":{"type":"string","description":"A Y/N or y/n question indicating if vehicle is garaged as the address listed as the mailing address (If mailing address is a PO Box, then garaging address will be required)."},"id":{"type":"string","description":"Unique numeric number for each vehicle."},"purchaseDate":{"type":"string","description":"Date the vehicle was purchased.","format":"date"},"purchasedInLastNinetyDays":{"type":"string","description":"A Y/N or y/n question indicating if vehicle was purchased within the last 90 days."},"purchasedInLastSixtyDays":{"type":"string","description":"A Y/N or y/n question indicating if vehicle was purchased within the last 60 days."},"purchaseNew":{"type":"string","description":"A Y/N or y/n question that indicates if vehicle was purchased new."},"statedAmount":{"type":"string","description":"The current value of this vehicle."},"vehicleAttributes":{"$ref":"#/components/schemas/VehicleAttributes"},"vehicleBodyType":{"type":"string","description":"The body type or body style of the specific vehicle."},"vehicleMake":{"type":"string","description":"The maker or brand name of the vehicle."},"vehicleModel":{"type":"string","description":"The model of the vehicle produced by the vehicles maker."},"vehicleQuestions":{"$ref":"#/components/schemas/VehicleQuestions"},"vehicleSalvaged":{"type":"string","description":"A Y/N or y/n question that indicates if vehicle is a salvaged vehicle or has a salvaged title."},"vehicleType":{"$ref":"#/components/schemas/VehicleType"},"vehicleYear":{"type":"string","description":"The four digit year of the vehicle."},"vin":{"type":"string","description":"The unique Vehicle Identification Number of the vehicle to be insured"}}},"VehicleOwnershipInterest":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/VehicleOwnershipInterestAddress"},"company":{"$ref":"#/components/schemas/Company"},"entityType":{"type":"string","description":"Indicates if entity that has an interest in the vehicle is for a person or a company. If you need to change this, please delete the person or company ,then add the new person or company. Updating of this value is not allowed"},"id":{"type":"string","description":"Assigned ID for the ownership record.","readOnly":true},"loanExpirationDate":{"type":"string","description":"The date the loan or lease expires.","format":"date"},"ownershipType":{"type":"string","description":"Indicates the type of interest the person or company is. If you need to change ownership type, please delete the ownership interest, and add the ownership interest. Updating of this value is not allowed."},"person":{"$ref":"#/components/schemas/Person"}}},"VehicleOwnershipInterestAddress":{"type":"object","properties":{"addressLineOne":{"type":"string","description":"The first line of the address for the person or company interest."},"addressLineTwo":{"type":"string","description":"Additional information on the for the person or company interest provided by the insured such as suite or apt."},"city":{"type":"string","description":"Name of the city that the insured has provided as part for the person or company interest."},"county":{"type":"string","description":"The full name of the county that the insured has provided for the person or company interest."},"state":{"type":"string","description":"The full name of the state that the insured has provided for the person or company interest."},"zipCode":{"type":"string","description":"This is the five or nine digit number that represents a specific area  that the insured has provided for the person or company interest."}}},"VehicleOwnershipInterests":{"type":"array","items":{"$ref":"#/components/schemas/VehicleOwnershipInterest"}},"VehicleQuestions":{"type":"object","properties":{"existingDamage":{"type":"string","description":"A Y/N or y/n value indicating if the vehicle has existing damage"},"existingDamageDescription":{"type":"string","description":"A description of the existing damage"},"existingDamageSafetyHazard":{"type":"string","description":"A Y/N or y/n indicating if the vehicle has existing damage that could pose a safety hazard. This values applies to vehicles added to a policy with a vehicle added date 01/29/2025 and later."},"existingDamageSafetyHazardDamageTypes":{"type":"array","description":"A container for one to many existing damage types if \"existingDamageSafetyHazard\" = Y/y.","items":{"$ref":"#/components/schemas/DamageType"}},"usedForTransportationNetworkPurposes":{"type":"string","description":"A Y/N or y/n question that indicates if vehicle is used for transportation network purposes."},"usedForTransportationPersonsForHire":{"type":"string","description":"A Y/N or y/n value that indicates if any vehicle will be used for transportations of persons or any delivery"}}},"Vehicles":{"type":"array","items":{"$ref":"#/components/schemas/Vehicle"}},"VehicleType":{"type":"object","properties":{"type":{"type":"string","description":"Indicates what type of vehicle this specific vehicle is according to Mercury vehicle types."},"typeOptions":{"$ref":"#/components/schemas/TypeOptions"}}},"VehicleUsage":{"type":"object","properties":{"annualMileage":{"type":"integer","description":"The annual mileage value applied to the vehicle and used in rating. This can be stated or calculated annual mileage values.","format":"int32","readOnly":true},"annualMileageProgram":{"type":"string","description":"Information regarding the Annual Mileage program.","readOnly":true},"calculatedAnnualMileage":{"type":"integer","description":"The system derived annual mileage value using report data.","format":"int32","readOnly":true},"commutingMilesOneWay":{"type":"integer","description":"The distance driven one way during the commute.","format":"int32"},"currentOdometer":{"type":"integer","description":"Enter the current mileage reading for the vehicle as noted on your vehicles odometer.","format":"int32"},"doYouWantToProvideOdometerReading":{"type":"string","description":"A Y/N or y/n question indicating if you want to provide an odometer reading."},"estimatedAnnualMileage":{"type":"string","description":"The estimated mileage the vehicle is driving in a one year time span."},"otherAnnualMileageReason":{"type":"string","description":"An open text field if useOriginalAnnualMileageReason selected is Other."},"primaryUse":{"type":"string","description":"Indicates how the vehicle will be used."},"statedAnnualMileage":{"type":"integer","description":"The estimated mileage the vehicle is driving in a one year time span.","format":"int32"},"statedAnnualMileageReason":{"type":"string","description":"A value that indicates why the stated annual mileage should be used instead of calculated. If present, system will use statedAnnualMileage. If blank or removed, system will use calculatedAnnualMileage unless statedAnnualMileage is accepted by system."},"transportationNetworkCompany":{"$ref":"#/components/schemas/TransportationNetworkCompany"}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}