Public API Reference

Overview

The ADVANCE API enables insurance agencies to programmatically manage their billing operations, including creating invoices (plans), processing payments, managing insureds (customers), and handling producer commissions. This API follows RESTful conventions and uses JSON for request and response bodies.

Base URLs

We recommend using the Sandbox environment for development and testing before moving to Production.

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

API keys follow the format advance_live_<32-character-string> and are issued through the ADVANCE dashboard.

Authentication Example

curl -X GET "https://api.advancehq.com/v1/plans" \
  -H "Authorization: Bearer advance_live_k8j2h4g6f9d3s7a1q5w8e0r2t6y9u3i7o1p4" \
  -H "Content-Type: application/json"

Error Handling

The API uses standard HTTP status codes and returns detailed error messages:

Error Response Format

{
  "detail": "Error description message"
}

Validation Error Format

{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}