Get list of insured’s addresses
API Refs
- Production: Get list of insured’s addresses
- Staging: Get list of insured’s addresses
URI Parameters
Name | Type | Description | Required |
---|---|---|---|
userId | number | insure id | yes |
Response body
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 |
Example
- Get list of insured’s addresses Request with userId = 1;
- Get list of insured’s addresses Response:
[ { "address1": "11 Birch Hill Street", "address2": "Apt. 123", "city": "Bronx", "postalCode": "10023", "state": "NY", "phone": "123-456-7890", "alias": "Home" } ]
Description
With this endpoint, you can get the addresses of your insureds specified using their id.
The value that you may need from the execution result to use other functionality of our API is an alias.
This value is used to select an address to perform operations related to it in our API.
Each alias is unique for each insured, same with address1.
Updated over 1 year ago