📘
Name Type Description Required userId number insure id yes
Name Type Description Required alias string The name of the address information. Will be used to deliver checks. yes address1 string Legal address info yes address2 string Additional optional legal address info no city string Legal city name yes postalCode number string Number string with 5 digits length yes state string State from values. See first * yes phone string Legal insured’s phone number yes
Name Type Description location string Alias name of added address for insured
Get list of insured’s addresses Request with userId = 1;
Get list of insured’s addresses Response:
JSON
[
{
"address1": "11 Birch Hill Street",
"address2": "Apt. 123",
"city": "Bronx",
"postalCode": "10023",
"state": "NY",
"phone": "123-456-7890",
"alias": "Home"
}
]
Add address for insured Request:
JSON
{
"address1": "9234 Bank Avenue",
"address2": "Apt. 04",
"city": "Corona",
"postalCode": "11368",
"state": "NY",
"phone": "123-456-7890",
"alias": "Office"
}
Add address for insured Response Headers:
Get list of insured’s addresses Request with userId = 1;
Get list of insured’s addresses Response:
JSON
[
{
"address1": "11 Birch Hill Street",
"address2": "Apt. 123",
"city": "Bronx",
"postalCode": "10023",
"state": "NY",
"phone": "123-456-7890",
"alias": "Home"
},
{
"address1": "9234 Bank Avenue",
"address2": "Apt. 04",
"city": "Corona",
"postalCode": "11368",
"state": "NY",
"phone": "123-456-7890",
"alias": "Office"
}
]
This endpoint add new or additional address to your insureds.
After providing all the required information in the request, we will save the new address under the alias you also provided in the request.
If you need to return all the added information at once, you can use the Get insured’s address by alias endpoint, passing in the alias the value that will be in the request response header under the location key.