Carriers

List All Carriers

Retrieves all carrier records.

Endpoint: GET /v1/carriers

Use Cases:

Get list of available carriers for policy creation
Sync carrier data to your system

Example:

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

Response:

[
  {
    "carrier_id": "car_abc123",
    "carrier_name": "National Insurance Co",
    "contact_info": {
      "name": "Claims Department",
      "email": "[email protected]",
      "phone_": "800-555-1234"
    },
    "contact_address": {
      "address1": "100 Insurance Plaza",
      "city": "Hartford",
      "state": "CT",
      "zip_code": "06103"
    },
    "recurrence_payout_enabled": true,
    "recurrence_payout_day": 20
  }
]

Get Carrier by ID

Retrieves detailed carrier information including product lines.

Endpoint: GET /v1/carriers/{carrier_id}

Example:

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

Response:

{
  "carrier_id": "car_abc123",
  "carrier_name": "National Insurance Co",
  "contact_info": {
    "name": "Claims Department",
    "email": "[email protected]",
    "phone_": "800-555-1234"
  },
  "contact_address": {
    "address1": "100 Insurance Plaza",
    "city": "Hartford",
    "state": "CT",
    "zip_code": "06103"
  },
  "product_lines": [
    {
      "product_line_id": "pl_001",
      "name": "General Liability",
      "commission_percentage": 15.0,
      "created_at": "2024-01-01T00:00:00Z"
    },
    {
      "product_line_id": "pl_002",
      "name": "Workers Compensation",
      "commission_percentage": 12.0,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "recurrence_payout_enabled": true,
  "recurrence_payout_day": 20
}