Insureds

Create Insured

Creates a new insured record.

Endpoint: POST /v1/insured

Use Cases:

Add new customers to the system
Sync customer data from your AMS
Pre-create insureds before generating invoices

Request Body:

Field	Type	Required	Description
`insured_name`	string	Yes	Company or individual name
`first_name`	string	No	Contact first name
`last_name`	string	No	Contact last name
`email_primary`	string	No	Primary email (max 256 chars)
`email_secondary`	string	No	Secondary email
`phone_number`	string	No	Phone number (max 15 chars)
`address1`	string	No	Street address line 1
`address2`	string	No	Street address line 2
`city`	string	No	City
`address_state`	string	No	State/Province
`zip_code`	string	No	Postal code
`country`	string	No	Country

Example:

curl -X POST "https://api.advancehq.com/v1/insured" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "insured_name": "Acme Corporation",
    "first_name": "John",
    "last_name": "Smith",
    "email_primary": "[email protected]",
    "phone_number": "555-123-4567",
    "address1": "123 Main Street",
    "address2": "Suite 100",
    "city": "New York",
    "address_state": "NY",
    "zip_code": "10001",
    "country": "USA"
  }'

Response:

{
  "insured_id": "ins_abc123def456",
  "insured_name": "Acme Corporation",
  "first_name": "John",
  "last_name": "Smith",
  "email_primary": "[email protected]",
  "email_secondary": null,
  "phone_number": "555-123-4567",
  "insured_address": {
    "address1": "123 Main Street",
    "address2": "Suite 100",
    "city": "New York",
    "address_state": "NY",
    "zip_code": "10001",
    "country": "USA"
  }
}

List All Insureds

Retrieves all insured records.

Endpoint: GET /v1/insured

Use Cases:

Sync insured data to your system
Search for existing customers
Generate customer reports

Example:

curl -X GET "https://api.advancehq.com/v1/insured" \
  -H "Authorization: Bearer your_api_key"

Response:

[
  {
    "insured_id": "ins_abc123",
    "insured_name": "Acme Corporation",
    "first_name": "John",
    "last_name": "Smith",
    "email_primary": "[email protected]",
    "phone_number": "555-123-4567",
    "insured_address": {
      "address1": "123 Main Street",
      "city": "New York",
      "address_state": "NY",
      "zip_code": "10001"
    }
  }
]

Get Insured by ID

Retrieves a specific insured record.

Endpoint: GET /v1/insured/{insured_id}

Example:

curl -X GET "https://api.advancehq.com/v1/insured/ins_abc123" \
  -H "Authorization: Bearer your_api_key"

Update Insured

Updates an existing insured record.

Endpoint: PUT /v1/insured/{insured_id}

Use Cases:

Update customer contact information
Correct address details
Sync changes from your AMS

Example:

curl -X PUT "https://api.advancehq.com/v1/insured/ins_abc123" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email_primary": "[email protected]",
    "phone_number": "555-987-6543"
  }'