Get insured’s address by alias

📘

API Refs

• Production: Get insured’s address by alias
• Staging: Get insured’s address by alias

URI Parameters

Name	Type	Description	Required
userId	number	insure id	yes
alias	string	Name of insured’s address information	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

1. Get insured’s address by alias Request with userId = 1 and alias = “Home”;
2. Get insured’s address by alias Response:
   JSON

   {
     "address1": "11 Birch Hill Street",
     "address2": "Apt. 123",
     "city": "Bronx",
     "postalCode": "10023",
     "state": "NY",
     "phone": "123-456-7890",
     "alias": "Home"
   }
   

Description

📘

Where to get address alias?

You can get all existing addresses with their alias for any you insured. Go to Get list of insured’s addresses for more information about it.

With this endpoint, you can get the specific address of your insured specified by their id and address alias.
This endpoint is an alternative to returning all addresses for your client. If you know the address alias and need the information behind it, this endpoint will return all the existing information associated with the given insured address alias.