You are viewing legacy endpoint documentation. See the Modern docs for engine-scoped endpoints.
- Quote matching — send quoted offerings from multiple carriers, get ranked placement solutions with six-dimension scorecards
- Coverage analysis — send a current portfolio, get gap analysis with severity-ranked recommendations
POST /api/v1/jobs, retrieve results via GET /api/v1/jobs/{run_id} or webhooks.
Quickstart
You need an API key from Settings → API Keys. Keys are shown only once.nx_test_ = sandbox, nx_live_ = production.
1. Submit a run
202 Accepted:
2. Poll for results
GET /api/v1/jobs/{run_id} until status is completed or failed. Start at 2s, backoff 1.5x, cap 30s.
3. Read the results
solutions[0].cluster_label— solution label (recommended,best_value, etc.)solutions[0].scorecard.overall_level— package score (lower is better)solutions[0].est_cost_low/est_cost_high— annual cost rangesolutions[0].offerings[*].provider_name— carrier per line
Next steps
Key Concepts
Runs, offerings, solutions, scorecards, routing modes.
Integration Guide
Quote-to-offering mapping, multi-carrier input, failure cases.
API Reference
Full endpoint documentation with typed schemas.
Authentication
API key types, creation, and security.