Update insuredā€™s address information

šŸ“˜

API Refs

URI Parameters

NameTypeDescriptionRequired
userIdnumberinsure idyes
aliasstringName of insuredā€™s address informationyes

Request body

NameTypeDescriptionRequired
aliasstringThe name of the address information. Will be used to deliver checks.yes
address1stringLegal address infoyes
address2stringAdditional optional legal address infono
citystringLegal city nameyes
postalCodenumber stringNumber string with 5 digits lengthyes
statestringState from values. See first *yes
phonestringLegal insuredā€™s phone numberyes

Response body

NameTypeDescriptionRequired
aliasstringThe name of the address information. Will be used to deliver checks.yes
address1stringLegal address infoyes
address2stringAdditional optional legal address infono
citystringLegal city nameyes
postalCodenumber stringNumber string with 5 digits lengthyes
statestringState from values. See first *yes
phonestringLegal insuredā€™s phone numberyes

Example

  1. Get insuredā€™s address by alias Request with userId = 1 and alias = ā€œHomeā€;

  2. Get insuredā€™s address by alias Response:

    {
      "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ā€:

    {
      "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:

    {
      "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.