Update insured’s address information

📘

API Refs

• Production: Update insured’s address information
• Staging: Update insured’s address information

URI Parameters

Name	Type	Description	Required
userId	number	insure id	yes
alias	string	Name of insured’s address information	yes

Request 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

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

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

3. Update insured’s address information Request with alias = “Home”:

   JSON

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

4. Update insured’s address information Response:

   JSON

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

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.

Since the address information is used only at the time the transfer is accepted as a paper check, it can be changed at any time convenient for you.
You can change any information, including the alias. However, the new value for the alias and primary address must remain unique for each insured.