Get list of insuredā€™s addresses

šŸ“˜

API Refs

URI Parameters

NameTypeDescriptionRequired
userIdnumberinsure idyes

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 list of insuredā€™s addresses Request with userId = 1;
  2. 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.