{"openapi":"3.0.1","info":{"title":"Homeowners Insurance Verification","description":"Homeowners Insurance Verification","contact":{"name":"Homeowners Insurance Verification","url":"https://developer.mercuryinsurance.com","email":"cc@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":"HOI Verify"}],"paths":{"/hoi-verify/v1/policyinfo/{policyNumber}":{"post":{"tags":["HOI Verify"],"summary":"Allows mortgage lenders to verify properties have active insurance coverage on properties in which they have an interest","parameters":[{"name":"policyNumber","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCoverageRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCoverageResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"404":{"description":"Represents when a Search Criteria is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessagesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericMessagesResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericMessagesResponse"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericMessagesResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericMessagesResponse"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericMessagesResponse"}}}}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"AdditionalNamedInsured":{"type":"object","properties":{"companyName":{"type":"string"},"firstName":{"type":"string"},"insuredType":{"type":"string","description":"Valid types are:\r\n<BR><BR>- Person\r\n<BR><BR>- Company\r\n<BR><BR>"},"lastName":{"type":"string"},"middleInitial":{"type":"string"},"suffix":{"type":"string"}}},"Address":{"required":["addressLine1","city","state","zipCode"],"type":"object","properties":{"addressLine1":{"maxLength":60,"type":"string"},"addressLine2":{"maxLength":60,"type":"string"},"city":{"maxLength":60,"type":"string"},"state":{"type":"string"},"zipCode":{"maxLength":10,"type":"string"}}},"Agency":{"type":"object","properties":{"emailAddress":{"type":"string"},"name":{"type":"string"},"phoneNumber":{"type":"string"}}},"Coverage":{"type":"object","properties":{"coverageCode":{"type":"string"},"coverageName":{"type":"string"},"coverageTerms":{"type":"array","items":{"$ref":"#/components/schemas/CoverageTerm"}}}},"CoverageTerm":{"type":"object","properties":{"covTermName":{"type":"string"},"covTermValue":{"type":"string"}}},"Exclusion":{"type":"object","properties":{"exclusionCode":{"type":"string"},"exclusionName":{"type":"string"}}},"GenericAdditionalDetail":{"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"},"GenericMessage":{"type":"object","properties":{"additionalDetails":{"type":"array","description":"Additional information that is specific to this API","items":{"$ref":"#/components/schemas/GenericAdditionalDetail"}},"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"},"GenericMessagesResponse":{"type":"object","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/GenericMessage"}}},"description":"Represents a response of Message Entities"},"Insured":{"type":"object","properties":{"firstName":{"type":"string"},"insuredType":{"type":"string","description":"Valid types are:\r\n<BR><BR>- Person\r\n<BR><BR>- Company\r\n<BR><BR>"},"lastName":{"type":"string"},"middleInitial":{"type":"string"},"suffix":{"type":"string"}},"description":"Policy Primary Insured Details"},"Message":{"type":"object","properties":{"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"},"Mortgagee":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/MortgageeAddress"},"impound":{"type":"string"},"loanNumber":{"type":"string"},"name":{"type":"string"},"number":{"type":"string","description":"Valid values are:\r\n<BR><BR>- First\r\n<BR><BR>- Second\r\n<BR><BR>- Third<BR><BR>"}}},"MortgageeAddress":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"}}},"PolicyLocation":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"type":{"type":"string","description":"Valid types are:\r\n<BR><BR>- PROPERTY\r\n<BR><BR>- MAILING\r\n<BR><BR>"},"zipCode":{"type":"string"}},"description":"PolicyLocation"},"UWCompany":{"type":"object","properties":{"uwAddress":{"$ref":"#/components/schemas/Address"},"uwCompanyNAIC":{"type":"string"},"uwCompanyName":{"type":"string"}}},"VerifyCoverageRequest":{"required":["address","asOfDate"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"asOfDate":{"type":"string","description":"Policy EffectiveDate","format":"date"}},"description":"HOI Coverage verification request"},"VerifyCoverageResponse":{"type":"object","properties":{"additionalNamedInsured":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalNamedInsured"}},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/PolicyLocation"}},"agency":{"$ref":"#/components/schemas/Agency"},"cancellationDate":{"type":"string","description":"Cancellation Effective Date","format":"date"},"cancellationReason":{"type":"string","description":"Valid reasons are:\r\n<BR><BR>- Non Payment\r\n<BR><BR>- Insured's Request\r\n<BR><BR>- Policy Rewritten\r\n<BR><BR> - Underwriting Reasons<BR><BR>"},"coverages":{"type":"array","items":{"$ref":"#/components/schemas/Coverage"}},"exclusions":{"type":"array","items":{"$ref":"#/components/schemas/Exclusion"}},"insured":{"type":"array","items":{"$ref":"#/components/schemas/Insured"}},"mortgagees":{"type":"array","items":{"$ref":"#/components/schemas/Mortgagee"}},"policyEffectiveDate":{"type":"string","description":"Module Effective Date","format":"date"},"policyNumber":{"type":"string","description":"The homeowner/landlord policy number requiring coverage verification."},"policyRenewalDate":{"type":"string","description":"Module Expiration Date","format":"date"},"policyStatus":{"type":"string","description":"The current status of the policy based on the date passed in the request. Valid statuses are:\r\n<BR><BR>- ACTIVE\r\n<BR><BR>- PENDING\r\n<BR><BR>- CANCELLED\r\n<BR><BR>"},"policyType":{"type":"string","description":"The valid values are: \r\n<BR><BR>- Homeowners (HO3)\r\n<BR><BR>- Condominium (HO6)\r\n<BR><BR>- Landlord Dwelling (DP-3)\r\n<BR><BR>"},"premiumBalanceAmount":{"type":"string","description":"Policy Due amount"},"premiumTotalAmount":{"type":"string","description":"Policy Total Premium"},"rewritePolicyNumber":{"type":"string","description":"The policynumber of a rewritten policy incase the cancellation reason is 'Policy Rewritten'."},"uwCompany":{"$ref":"#/components/schemas/UWCompany"}},"description":"HOI Coverage verification response"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}}}}