Skip to main content

Quickstart

This guide walks you through submitting your first evaluation and receiving results. You’ll need an API key from the Nexio dashboard.

Step 1: Get your API key

  1. Sign in to platform.usenexio.com
  2. Navigate to Settings → API Keys
  3. Click Create Key and copy the key value
Store your API key securely. It is displayed only once. Keys starting with nx_live_ are production keys (billed). Keys starting with nx_test_ are sandbox keys (not billed, use test data).

Step 2: Submit an evaluation

Send a POST request to /api/v1/jobs with your entity profile and target pool.
curl -X POST https://api.usenexio.com/api/v1/jobs \
  -H "Content-Type: application/json" \
  -H "X-API-Key: nx_live_YOUR_KEY" \
  -d '{
    "profile": {
      "entity": "acme-manufacturing",
      "state": "CA",
      "line": "professional_liability",
      "revenue": 12000000
    },
    "pool": "carriers:all",
    "webhook_url": "https://your-app.com/hooks/nexio"
  }'
The API responds immediately with 202 Accepted:
{
  "eval_id": "eval_7xKp2mNc",
  "status": "queued"
}

Step 3: Receive results

Nexio processes evaluations asynchronously. When complete (typically 15–60 seconds), Nexio delivers results to your webhook_url:
{
  "eval_id": "eval_7xKp2mNc",
  "status": "completed",
  "pool_size": 1847,
  "filtered": 53,
  "candidates": [
    {
      "tier": "STRONG_FIT",
      "name": "Hartford Financial",
      "confidence": "HIGH",
      "scores": {
        "appetite": "L1",
        "coverage": "L2",
        "financial": "L1",
        "pricing": "L1",
        "placement": "L1",
        "service": "L2"
      },
      "reasoning": "Strong CA prof. liability appetite, $10–15M band..."
    }
  ],
  "audit": "https://api.usenexio.com/traces/eval_7xKp2mNc"
}

Step 4: (Optional) Poll for status

You can also poll the status endpoint instead of using webhooks:
curl https://api.usenexio.com/api/v1/jobs/eval_7xKp2mNc \
  -H "X-API-Key: nx_live_YOUR_KEY"
For production integrations, webhooks are more reliable than polling. See the Realtime Events guide for subscribing to live updates via Pusher.

Next steps