What it means: Request did not include the x-api-key header.
How to fix: Add header: x-api-key: eqiqs_live_… (or eqiqs_sandbox_… for sandbox).
{
"error": {
"code": "MISSING_API_KEY",
"message": "Provide a valid API key via the x-api-key header."
}
}What it means: Key is malformed, deactivated, or does not match our records.
How to fix: Verify the key in your Partner Dashboard. If recently revoked, generate a new one.
INVALID_SIGNATUREHTTP 401
What it means: HMAC signing is enabled on this key but x-eqiqs-signature is missing or wrong.
How to fix: Compute sha256=HEX(HMAC_SHA256(signing_secret, raw_body)) and send as x-eqiqs-signature.
ORIGIN_NOT_ALLOWEDHTTP 403
What it means: Browser-based call from an Origin not in this key's CORS allowlist.
How to fix: Add the domain to allowed_origins in your Partner Dashboard, or call from a server.
RATE_LIMIT_EXCEEDEDHTTP 429
What it means: You exceeded the per-hour rate limit for this key.
How to fix: Wait until X-RateLimit-Reset, throttle client-side, or upgrade your tier. Check X-RateLimit-Remaining on every response.
MONTHLY_LIMIT_EXCEEDEDHTTP 429
What it means: Monthly call quota for this key's tier is fully consumed.
How to fix: Upgrade your plan in the Partner Dashboard, or wait until the 1st of next month. Overages on paid tiers bill automatically.
What it means: Request body or query failed schema validation (missing field, bad enum, etc.).
How to fix: Read the message field for the specific issue. Check /openapi.json for required shapes.
{
"error": {
"code": "VALIDATION_ERROR",
"message": "pairs must be a non-empty array."
}
}INSUFFICIENT_DATAHTTP 422
What it means: Both subjects must have ≥ 3 completed frameworks (Data Sufficiency rule). Confidence cannot be computed below this threshold.
How to fix: Submit more framework results per subject before re-requesting compatibility. Use /v1/frameworks for the full list.
INVALID_FRAMEWORKHTTP 400
What it means: A framework key in your payload is not recognized.
How to fix: GET /v1/frameworks returns the canonical list of 21 supported framework keys.
What it means: The requested resource (report id, share token, framework) does not exist.
How to fix: Check the URL path. Resources are scoped per key — sandbox keys cannot resolve live IDs and vice versa.
IDEMPOTENCY_CONFLICTHTTP 409
What it means: An Idempotency-Key was reused with a different request body within 24h.
How to fix: Use a fresh UUID per logical request, or send the exact same body to receive the cached response.
What it means: Something failed on our side. We were paged.
How to fix: Retry with exponential backoff. If it persists, email BD@EQIQs.com with the request id from the response headers.
Don't see your error? Email
BD@EQIQs.com with the response body.