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
- Sign in to platform.usenexio.com
- Navigate to Settings → API Keys
- 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 aPOST request to /api/v1/jobs with your entity profile and target pool.
202 Accepted:
Step 3: Receive results
Nexio processes evaluations asynchronously. When complete (typically 15–60 seconds), Nexio delivers results to yourwebhook_url:
Step 4: (Optional) Poll for status
You can also poll the status endpoint instead of using webhooks:Next steps
- Read Key Concepts to understand tiers, scores, and dimensions
- Read the full API reference for all endpoint details
- Learn about authentication options
