Skip to main content

Submit Job

POST https://api.usenexio.com/api/v1/jobs
Submit an entity profile and pool for evaluation. The API queues the job immediately and returns a 202 Accepted response with an eval_id. Results are delivered asynchronously via webhook or available via the status endpoint.

Request

Headers

HeaderRequiredValue
Content-TypeYesapplication/json
X-API-KeyYesYour API key

Body

profile
object
required
The entity profile to evaluate. The structure of this object depends on your configured vertical/domain.
pool
string
required
The candidate pool to evaluate against. Contact support@usenexio.com to get your available pool identifiers.Example: "carriers:all"
webhook_url
string
HTTPS URL to deliver the completed evaluation result to. Must be publicly accessible. If omitted, poll the status endpoint for results.Example: "https://your-app.com/hooks/nexio"

Example Request

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"
  }'

Response

202 Accepted

The job was accepted and queued for processing.
eval_id
string
Unique identifier for this evaluation. Use this to poll the status endpoint or correlate webhook deliveries.Example: "eval_7xKp2mNc"
status
string
Initial status. Always "queued" on submission.
{
  "eval_id": "eval_7xKp2mNc",
  "status": "queued"
}

Webhook Delivery Payload

When processing completes, the following is POSTed to your webhook_url:
eval_id
string
The evaluation identifier.
status
string
"completed" or "failed".
pool_size
number
Total number of candidates in the pool before filtering.
filtered
number
Number of candidates removed during the filter stage (did not meet eligibility).
candidates
array
Ranked list of candidates that passed filtering, in descending order of fit.
audit
string
URL to the full audit trace for this evaluation.
{
  "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"
}

Error Responses

400 Bad Request — Missing required field:
{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: profile.entity",
    "details": []
  }
}
401 Unauthorized — Invalid API key:
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}
422 Unprocessable Entity — Unknown pool:
{
  "error": {
    "code": "unknown_pool",
    "message": "Pool 'carriers:unknown' not found for your organization"
  }
}