mobile-logo

Home VaaS API Documentation

V2.2
  1. byPolicyID (Home)
    1. Service Details
    2. Input: byPolicyID
    3. Output
      1. Output : PolicyDetails
      2. Output: PolicyTerm
      3. Output: Coverage
      4. Output: BillingDetails
      5. Output: AgentDetails
      6. Output: Insured
      7. Output: Address
      8. Output: InterestedParty
    4. Errors:
  2. byLastnameZip (Home)
    1. Service Details
    2. Input: byLastnameZip
    3. Output
      1. Output: SearchResult
      2. Output: Insured
      3. SearchAddress
    4. Errors :
  3. Status Codes

1.byPolicyID (Home)

The default method of searching for a policy. It only requires the user to enter the policy number. Responses are formatted into a summary for the user to review.

1.1.Service Details

Description
The getPolicyByID method retrieves details about a policy.
Input
policyID, snapshotDate, returnCoverages (optional), returnBillingDetails (optional)
Output
PolicyDetails

1.2.Input Parameter Details

Name
Data Type
Required
Default Value
Description
policyID
String
Yes
None
The formatted policy number.
snapshotDate
Calender
Yes
Current Date
The date that is spanned by a policy term (yyyy-MM-dd).
returnCoverages
boolean
No
true
Return coverages information.
returnBillingDetails
boolean
No
true
Return billing information.

1.3.Output

 

 

1.3.1.Output : PolicyDetails

Name
Data Type
Description
agentDetails
AgentDetails
The details regarding the corresponding agent of record.
billingDetails
BillingDetails
Optional billing information on the given term of the policy.
additionalInsured
Insured array
The set of coinsured entities
coverages
Coverage array
Optional list of the coverages covered by the policy.
effectiveDate
String
The start date of the policy term.
endorsementEffectiveDate
String
The effective date of the policy snapshot.
expirationDate
String
The end date of the policy term.
interestedParties
InterestedParty array
The set of interested parties.
lineOfBusiness
String
The policy line of business.
policyNumber
String
The formatted policy number.
policyNumber
String
The formatted policy number.
policyTerms
PolicyTerm array
The set of policy terms associated to the policy.
primaryInsured
Insured
The primary insured entity.
renewalStatus
String
The renewal status of the policy. Possible values:
Do Not Renew, Policy Cancelled, Pre Review, Renewal Bound, Review, Review
Complete
riskAddress
Address
The date of the effective snapshot.
snapshotDate
String
The primary insured entity.
status
String
The policy status, whether the policy is Active or Cancelled.
yearsInForce
String
The number of years the policy has been in force.
autoDetails
Auto array
The set of vehicle entities

1.3.2.Output: PolicyTerm

Name
Data Type
Description
effectiveDate
String
The policy term effective date.
expirationDate
String
The policy term expiration date.

1.3.3.Output: Coverage

Name
Data Type
Description
name
String
The name of the coverage, e.g. Coverage A- Dwelling
valueType
CoverageValueType
The type of the value with the following possible values
Text
Number
Boolean
Date (yyyy-MM-dd)
value
String
The value of the coverage, e.g. 173000.00

1.3.4.Output: BillingDetails

Name
Data Type
Description
paymentPlan
String
Possible values:
Full Payment
2 Pay Recurring
4 Pay Recurring
Monthly Payment Recurring
billTo
String
Indicates whether the policy is billed to mortagee or insured.
Possible values:
Insured
Mortgagee
billingAddress
Address
totalPremium
String
The total premium due on the policy.
balance
String
The total balance of the policy.

1.3.5.Output: AgentDetails

Name
Data Type
Description
agencyEmail
String
The email address of the corresponding agency
agencyID
String
The internal unique identifier of the corresponding agency.
agencyLocationAddress
Address
The location address of the corresponding agency.
agencyMailingAddress
Address
The mailing address of the corresponding agency.
agencyName
String
The name of the corresponding agency.
agencyPhoneNumbers
PhoneNumber array
The set of all phone numbers of the corresponding agency.
agentEmail
String
The name of the corresponding Agent.
agentFirstName
String
The first name of the agent.
agentLastName
String
The last name of the agent.
agentPhoneNumbers
PhoneNumber array
The set of all phone numbers corresponding to the agent.

1.3.6.Output: Insured

Name
Data Type
Description
company
String
The company name, if the insured is an organization.
email
String
The email address of the insured.
firstName
String
The first name of the insured, if the insured is an individual.
gender
String
The gender of the insured.
lastName
String
The last name of the insured, if the insured is an individual.
mailingAddress
Address
The mailing address of the insured.
phoneNumbers
PhoneNumber array
The set of associated phone numbers.
preferredContactMethod
String
Not currently implemented.
relationToPrimaryNamedInsured
String
If the insured is the primary, the value will be: Self.

1.3.7.Output: Address

Name
Data Type
Description
street
String
The company name, if the insured is an organization.
street2
String
The email address of the insured.
city
String
The first name of the insured, if the insured is an individual.
stateCode
String
The gender of the insured.
zip
String
The last name of the insured, if the insured is an individual.
lalitude
String
The mailing address of the insured.
longitude
String
The set of associated phone numbers.

1.3.8.Output: InterestedParty

Name
Data Type
Description
interestedPartyId
String
firstName
String
lastName
String
company
String
email
String
phoneNumbers
PhoneNumber Array
preferredContactMethod
String
mailingAddress
String
kind
String
The type of Interested Party. Possible values:
‘Additional Insured’, ‘Additional Insured – Organization’, ‘Additional Insured – Person’,
‘Additional Interest – Homeowners Association’, ‘Additional Interest – Estate’, ‘Additional
Interest – LLC’, ‘Additional Interest – Other’, ‘Additional Interest – Primary Contact’,
‘Additional Interest – Property Manager’, ‘Additional Interest – Secondary Contact’,
‘Additional Interest – Trust’, ‘Mortgagee – First Mortgagee’, ‘Mortgagee – Fourth
Mortgagee’, ‘Mortgagee – Second Mortgagee’, ‘Mortgagee – Third Mortgagee’, null
loanNumber
String
rank
String
The ordering of the interested party. For example First mortgagee would be rank 1,
Second mortgagee would be rank 2.

1.4.Errors:

Error Code
Error Message
Description
E01
Specified policy number is not properly formatted
The input policyID is not properly formatted.

2.byLastnameZip (Home)

When a policy number is not available, the search form enables two additional fields to search by a combination of a policyholder’s last name and zip code. A summary is returned of all matching last names, addresses, and zip codes. Because the policy number is also returned, when a name is selected from the list, the default API call is triggered, sending the policy number and returning policyholder data to the policy summary screen.

 

2.1.Service Details

Description
The “byLastnameZip” method allows for the retrieval of policies by referencing the primary insured last name in combination with the insured’s mailing zip code.
Input
byLastnameZip
Output
SearchResult array

2.2.Input: byLastnameZip

Name
Type
Required
Valid values
Description
lastName
String
Yes
The first name of the insured, if the insured is an individual.
zipCode
String
Yes
5 Digit, US Zipcode.
The zip code of the insured mailing address.

2.3.Output

 

 

2.3.1.Output: SearchResult (Array)

Name
Data Type
Description
effectiveDate
String
The start date of the policy term.
expirationDate
String
The end date of the policy term.
policyNumber
String
The formatted policy number.
primaryInsured
Insured
The full name of the insured, if the insured is an individual, or the company name, if the insured is an organization.
primaryAddress
Address
The primary address associated with the policy. For Home it will be the
address of the insured property.
status
String
The policy status.

2.3.2.Output: Insured

Name
Data Type
Description
firstName
String
The start date of the policy term.
lastName
String
The end date of the policy term.
fullName
String
The insured’s full name, i.e. first, middle, and last names plus any titles.

2.3.3.SearchAddress

Name
Data Type
Description
street
String
The street address.
street2
String
The address line 2, e.g. apartment number.
city
String
stateCode
String
zip
String
fullAddress
String
The address as a single string.

2.4.Errors :

Error Message
Description
The policy search criteria must be specified.
The input policySearch should not be empty.
The policy search mode must be specified.
The input searchMode should not be empty.
The last name must be specified.
The input lastName should not be empty if searchMode is Name.
The business name must be specified.
The input businessName should not be empty if searchMode is BusinessName.
The phone number must be specified.
The input phoneNumber should not be empty if searchMode is PhoneNumber.
The Phone Number is invalid.
The input phoneNumber should contain one or more digits.
Please enter a value for at least one other field in addition to Last Name to narrow down the search.
The input lastName should also have at least one of firstName, insuredPropertyCity, insuredPropertyState, or
propertyZip not be empty.
Your search returned too many customer records. Please enter more information and search again.
The set of matching policies is too large. Refine the input search criteria.

3.Status Codes

Status Code
0
Success
1
No policy found
2
Policy not enforce
3
Policy format invalid
-1
System failure
Suggest Edit