Skip to main content
POST
/
api
/
v1
/
engines
/
{engine_slug}
/
runs
Submit Run
curl --request POST \
  --url https://api.usenexio.com/api/v1/engines/{engine_slug}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "address": {
      "state": "NY",
      "zip_code": "11231"
    },
    "coverage_types": [
      "home",
      "auto",
      "umbrella"
    ],
    "appetite_bucket": "balanced",
    "drivers": [
      {
        "driver_id": "ca31ba0d-8d07-4a2f-bbba-c80fa9882fe3",
        "years_licensed": 23,
        "violations_5yr": 1
      }
    ],
    "current_coverage": {
      "home": {
        "carrier": "21stcentury",
        "annual_premium": 2480.91
      },
      "auto": {
        "carrier": "21stcentury",
        "annual_premium": 507.32
      }
    },
    "premium": 3557.23,
    "vehicles": 1
  },
  "offerings": [
    {
      "id": "quote_line_carrier_a_home_001",
      "provider_id": "prov_carrier_a",
      "provider_name": "Carrier A",
      "category": "home",
      "quality_rating": "A+",
      "pricing_tier": "premium",
      "commission": 0.14,
      "constraints": {
        "excluded_states": [],
        "prohibited_naics": [],
        "avoided_naics": []
      },
      "coverage": {
        "product_name": "Premier Homeowners",
        "program_type": "quoted_line"
      },
      "attributes": {
        "quote_id": "qt_carrier_a_home_001",
        "line_premium_annual": 6120,
        "package_premium_annual": 12840
      }
    }
  ]
}
'
{
  "run_id": "bcb87157-0bfc-404d-a120-7f5c9cd01037",
  "status": "queued"
}

Authorizations

​
Authorization
string
header
required

API key with environment prefix. Use nx_test_... for sandbox and nx_live_... for production. Obtain keys at platform.usenexio.com/settings/api-keys.

Path Parameters

​
engine_slug
string
required

Engine identifier slug (e.g. default).

Body

application/json
​
input
object
required

The insured's profile and context. Key fields:

  • coverage_types — lines to evaluate: home, auto, umbrella
  • address.state — two-letter state code; required for personal-lines quote matching, including dual-mode runs
  • address.zip_code — postal code
  • applicant — named insured (name, DOB, marital status, occupation)
  • drivers — driver profiles (years licensed, violations, accidents)
  • vehicles_detail — vehicle info (year, make, model, VIN, garaging ZIP)
  • residence — home details (construction, sq ft, year built, replacement cost)
  • current_coverage — incumbent home/auto/umbrella policies (used for scoring context, not ranked)
  • insurance_history — claims history and continuous coverage
  • appetite_bucket — ranking strategy: coverage_first, cost_sensitive, balanced, or simplicity. Controls how scorecard dimensions are weighted.
  • prospect.primary_address.state — canonical gap-analysis state when coverage_analysis runs
  • request_config.coverage_analysis — enable gap analysis
  • request_config.quote_matching — enable quote matching
​
offerings
object[]

Quoted line items from carriers — one entry per carrier per coverage line. Required for quote matching. Not needed for coverage-analysis-only runs.

Response

Run accepted and queued for processing.

​
run_id
string<uuid>
required

Unique run identifier. Use this to poll for results.

​
status
enum<string>
required

Always queued on successful submission.

Available options:
queued