Get insuredā€™s address by alias

šŸ“˜

API Refs

URI Parameters

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

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