Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Nexus Legal Account API
version: 1.95.0
description: 'Multi-jurisdictional legal analysis API with a multi-agent architecture and Zero Retention. ## Output language
`language` (and the language implied by the jurisdiction) sets the language the text is written in. For `es` and `en` the delivered text is also measured: when a substantial part of it came back in the other of the two, a block headed `⚠️ LANGUAGE OF THIS REPORT` (`⚠️ IDIOMA DE ESTE INFORME` when `es` was requested) is added at the end of the text. It works the same with any engine, BYO included. - **When there is no block**: it is not a confirmation. Other languages are not measured, and neither is a text too short or too mixed to tell. - **With BYO**: how closely the output follows the request depends on your engine. - **If the output language is essential to your workflow**: check it on your side against the `analysis` string. ## The verdict travels INSIDE the text — read this before you parse a response
Every string this API returns that a lawyer reads — `analysis`, `answer`, `report`, `draft`, `synthesisText`, and the string fields of structured results like `applicableLaw[]` — carries the citation verdict **inline**, not only in the `citationChecks` object beside it. **What you will actually see:**
```
An acknowledgement does not revive a claim already barred: section 29(7) of the
Limitation Act 1980 【✓】. See also [2019] EWHC 3556 (Comm)
【◻ not checked — the reason is in this citation''s note】. ---
DETERMINISTIC CITATION CHECK (against the official corpus)
1 verified · 1 not checked. ◻ **Not checked** — they were not compared against any official corpus…
```
- **Inline marker**: a `【…】` block immediately after each citation, in the response language. The glyph carries the verdict: `✓` verified · `⚠` a warning (e.g. the decision exists but a party you named does not appear in it) · `⛔` broken · `◻` not checked. - **Footer**: a `---` block at the end with the tally and, for anything not clean, the list of citations and why. **Why it is in the text and not only in the JSON.** Whoever copies an answer into an email, a brief or a .docx takes the PROSE. The `citationChecks` object does not travel with it. A verdict that only exists in a field beside the text is a verdict the reader can lose without noticing. **If you parse these strings**: markers are the only `【…】` sequences we emit, so they are safe to strip with a single regex if your pipeline needs the raw prose — but do not strip them from anything a human will read. `citationChecks` remains the machine-readable source of truth for counts and per-citation status; the markers are the same verdict, placed where it cannot get lost. **Idempotent**: annotating an already-annotated text does not duplicate markers or the footer. ## Streaming: `verifiedText` on the `done` event
On SSE routes the client already holds the raw prose by the time the verifier finishes, so the closing `{type:"done"}` event carries `verifiedText`: the same answer with the verdict already in it. **If it is present, render it in place of the concatenated `text_delta` chunks.** It is omitted when there is nothing to annotate, in which case the deltas are already final. The REST wrappers do this for you — `/v1/consulta`, `/v1/chat` and the rest aggregate server-side and hand you the annotated text — so this only concerns you if you consume the SSE stream directly. ## Base capabilities
- **Mode=deep**: the Node A (Claude Opus 4.7) + Node B (DeepSeek V4-Pro) chain audits adversarially. 2 credits. Returns an `audit` object with structured findings (hallucinations, false citations, omissions). - **Direct models**: calls through the providers'' own APIs (Anthropic, DeepSeek) with no proxies — lower latency, better rate limits. - **Stable Stripe-style error format**: `error.type`, `error.code`, `error.request_id`, `error.details` + backward-compat aliases. ## Errors and rate limits
- **Branch on `error.code`.** A code you do not recognise is handled by its `error.type`.'
contact:
name: Nexus Legal
email: support@nexusquantum.legal
url: https://legal.nexusquantum.legal/developers
license:
name: Commercial
url: https://nexusquantum.legal/terms
servers:
- url: https://legal.nexusquantum.legal
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Account
description: 'User-scoped endpoints for the key owner (E6 self-service): DSR export, profile (`account/me`, bar-association, complete-profile), analytics, entitlements, CCPA opt-out, model-request, billing-settings, self-service MFA (`account/mfa/reset-totp`), jurisdiction/case-law activation. Ownership by the key (scope mcp|*). The wrapper does NOT debit (except jurisprudencia/activate, where the internal route charges). Curated MCP tools: `nexus_account_entitlements`, `nexus_ccpa_opt_out`.'
paths:
/api/v1/account/dsr/export:
get:
tags:
- Account
summary: DSR Export (GDPR Art.15/20) — JSON bundle with all personal data
description: 'Downloads the complete DSR bundle of the data subject associated with the authenticated api_key. Meets GDPR Art.15 (Right of access) and Art.20 (Data portability).
For api_keys with `role=master` and `organization_id`: pass `?for_sub_key=` to download the bundle of a specific sub-key (it must belong to the same org). The bundle includes 14 tables: profile, auth, outputs, cases, support_tickets, ticket_messages, disputes, credits_ledger, api_keys metadata, consent_log, alert_subscriptions, firm_memory, admin_audit_entries, notifications.'
parameters:
- name: for_sub_key
in: query
required: false
schema:
type: string
format: uuid
description: Sub-key UUID. Valid only for master keys.
responses:
'200':
description: 'DSR bundle. `Content-Disposition: attachment` + `X-Dsr-Export-Bundle-Counts` header with the counts.'
content:
application/json:
schema:
type: object
'403':
description: Forbidden (sub-key from another org, or not a master).
'404':
description: Sub-key not found.
operationId: getApiV1AccountDsrExport
x-operation-id-source: derived
/api/v1/account/me:
get:
tags:
- Account
summary: Account profile (direct-implement) · 0 credits
description: 'Returns the key owner''s profile: `user_id`, `email`, `profile` (full_name, entity_type, country_iso2, preferred_locale, default_jurisdiction, bar_*) and `is_admin`. Direct-implement against the KEY''s `user_id` (no loopback, no tech-doc cookie). No charge. Scope: mcp | *.'
responses:
'200':
description: '{ user_id, email, profile, is_admin }'
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getApiV1AccountMe
x-operation-id-source: derived
/api/v1/account/analytics:
get:
tags:
- Account
summary: Own usage analytics · 0 credits
description: 'Usage telemetry for the key owner (credits and outputs) over a window of days. Thin loopback to `/api/account/analytics` (ownership `.eq(user_id, userId)` over credits_ledger + analysis_outputs). No charge. Scope: mcp | *.'
parameters:
- name: window
in: query
required: false
schema:
type: string
enum:
- '7'
- '30'
- '90'
description: Window in days (7/30/90).
responses:
'200':
description: Usage analytics.
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getApiV1AccountAnalytics
x-operation-id-source: derived
/api/v1/account/bar-association:
get:
tags:
- Account
summary: Bar membership of the key owner · 0 credits
description: 'Reads the key owner''s declared bar membership. Thin loopback to `/api/account/bar-association` (ownership by the key). No charge. Scope: mcp | *.'
responses:
'200':
description: Bar membership.
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getApiV1AccountBarAssociation
x-operation-id-source: derived
patch:
tags:
- Account
summary: Declare/update bar membership · 0 credits
description: 'Declares or updates the key owner''s bar membership (`.eq(user_id, userId)`, no override). No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Bar membership updated.
content:
application/json:
schema:
type: object
'400':
description: Invalid data.
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: patchApiV1AccountBarAssociation
x-operation-id-source: derived
delete:
tags:
- Account
summary: Clear bar membership · 0 credits
description: 'Removes the key owner''s declared bar membership. No charge. Scope: mcp | *.'
responses:
'200':
description: Bar membership removed.
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: deleteApiV1AccountBarAssociation
x-operation-id-source: derived
/api/v1/account/complete-profile:
post:
tags:
- Account
summary: Complete profile (onboarding) · 0 credits
description: 'Completes the profile of a user mid-onboarding (`insert user_id = userId`, never override). For users already provisioned upstream by a distributor it responds idempotently with `{ ok:true, already:true }`. Thin loopback to `/api/auth/complete-profile` (requireUser adoption; email_confirmed_at via admin.getUserById). No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: '{ ok:true, already? }'
content:
application/json:
schema:
type: object
'400':
description: Invalid data.
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: postApiV1AccountCompleteProfile
x-operation-id-source: derived
/api/v1/account/ccpa-opt-out:
get:
tags:
- Account
summary: CCPA opt-out status · 0 credits
description: 'Reads the key owner''s CCPA (Do Not Sell/Share) status. Thin loopback to `/api/privacy/ccpa-opt-out`. No charge. Scope: mcp | *.'
responses:
'200':
description: '{ ccpa_opt_out, ccpa_opt_out_at }'
content:
application/json:
schema:
type: object
operationId: getApiV1AccountCcpaOptOut
x-operation-id-source: derived
post:
tags:
- Account
summary: Exercise CCPA opt-out (own) · 0 credits
description: 'Records `ccpa_opt_out = true` for the key owner (the user''s own right, `.eq(user_id, userId)`). No charge. Scope: mcp | *. MCP tool: `nexus_ccpa_opt_out`.'
responses:
'200':
description: '{ success, ccpa_opt_out, ccpa_opt_out_at }'
content:
application/json:
schema:
type: object
operationId: postApiV1AccountCcpaOptOut
x-operation-id-source: derived
delete:
tags:
- Account
summary: Revoke CCPA opt-out · 0 credits
description: 'Revokes the key owner''s CCPA opt-out (`ccpa_opt_out = false`). No charge. Scope: mcp | *.'
responses:
'200':
description: '{ success, ccpa_opt_out:false }'
content:
application/json:
schema:
type: object
operationId: deleteApiV1AccountCcpaOptOut
x-operation-id-source: derived
/api/v1/account/model-request:
post:
tags:
- Account
summary: Request model activation · 0 credits
description: 'Append-only into `model_requests` (`user_id` = key). Validates `modelId` against the tier catalog. Thin loopback to `/api/model-request`. No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- modelId
properties:
modelId:
type: string
responses:
'200':
description: Request recorded.
content:
application/json:
schema:
type: object
'400':
description: Invalid modelId.
operationId: postApiV1AccountModelRequest
x-operation-id-source: derived
/api/v1/account/billing-settings:
get:
tags:
- Account
summary: Billing settings of the key owner · 0 credits
description: 'Reads your own billing settings (default_rate_eur_per_hour, currency, invoice_iva_pct). Thin loopback to `/api/user-billing-settings`. No charge. Scope: mcp | *.'
responses:
'200':
description: Billing settings.
content:
application/json:
schema:
type: object
operationId: getApiV1AccountBillingSettings
x-operation-id-source: derived
patch:
tags:
- Account
summary: Update billing settings · 0 credits
description: 'Upsert of your own settings (`.eq/onConflict user_id`, no override). No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Settings updated.
content:
application/json:
schema:
type: object
'400':
description: Invalid data.
operationId: patchApiV1AccountBillingSettings
x-operation-id-source: derived
/api/v1/account/mfa/reset-totp:
post:
tags:
- Account
summary: Self-service TOTP reset (own) · 0 credits
description: 'Deletes ONLY the `unverified` TOTP factors OF THE USER''S OWN account (`.eq(user_id, userId)`) — it never touches third parties nor requires admin. Re-exposed under account (the internal route lives at `/api/admin/reset-totp`, but it is self-service). No charge. Scope: mcp | *.'
responses:
'200':
description: Unverified TOTP factors deleted.
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: postApiV1AccountMfaResetTotp
x-operation-id-source: derived
/api/v1/jurisdictions/activate:
post:
tags:
- Account
summary: Request jurisdiction activation (Polar checkout) · 0 credits
description: 'Writes `jurisdiction_activation_requests` (resolved `user_id`), creates a Polar checkout and notifies support. Jurisdiction-agnostic: `jurisdiction` validated with isValidJurisdiction, NO ES default. Returns `checkout_url` (Polar hosted checkout page — redirect the client there) + `polar_configured`. The charge is confirmed by the post-payment webhook. Does not debit. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- jurisdiction
properties:
jurisdiction:
type: string
description: ISO code. REQUIRED — no ES default.
responses:
'200':
description: '{ checkout_url, polar_configured }'
content:
application/json:
schema:
type: object
'400':
description: MISSING_JURISDICTION | invalid jurisdiction.
operationId: postApiV1JurisdictionsActivate
x-operation-id-source: derived
/api/v1/jurisprudencia/activate:
get:
tags:
- Account
summary: Case-law tier status · 0 credits
description: 'Reads the key owner''s case-law activation tier/status. Thin loopback to `/api/jurisprudencia/activate`. No charge. Scope: mcp | *.'
responses:
'200':
description: Activation status.
content:
application/json:
schema:
type: object
operationId: getApiV1JurisprudenciaActivate
x-operation-id-source: derived
post:
tags:
- Account
summary: Enable/disable the case-law add-on
description: '🔴 The ONLY E6 route with an internal CHARGE: the internal route debits via the idempotent atomic RPC `debit_and_activate_jurisprudencia` (X-Idempotency-Key). The v1 wrapper does NOT debit — it forwards. Internal errors (402 INSUFFICIENT_CREDITS, PROFILE_NOT_FOUND) are re-emitted verbatim. Ownership by the key. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Activation applied.
content:
application/json:
schema:
type: object
'402':
description: INSUFFICIENT_CREDITS.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: postApiV1JurisprudenciaActivate
x-operation-id-source: derived
/api/v1/account/notification-preferences:
get:
tags:
- Account
summary: Notification preferences (own) · 0 credits
description: 'Returns the key owner''s preferences (lazy-creates the defaults). Thin loopback to `/api/account/notification-preferences`. No charge. Scope: mcp | *.'
responses:
'200':
description: '{ preferences }'
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getApiV1AccountNotificationPreferences
x-operation-id-source: derived
patch:
tags:
- Account
summary: Update notification preferences (own) · 0 credits
description: 'Updates the key owner''s whitelisted boolean flags (`.eq(user_id, userId)`). Thin loopback. No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: '{ preferences }'
content:
application/json:
schema:
type: object
operationId: patchApiV1AccountNotificationPreferences
x-operation-id-source: derived
/api/v1/account/firm-setup:
get:
tags:
- Account
summary: Firm setup status (own) · 0 credits
description: 'Setup-interview status (`user_profiles.firm_setup_completed_at/dismissed_at`) for the key owner. Thin loopback to `/api/account/firm-setup`. No charge. Scope: mcp | *.'
responses:
'200':
description: Setup status.
content:
application/json:
schema:
type: object
'401':
description: Invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getApiV1AccountFirmSetup
x-operation-id-source: derived
patch:
tags:
- Account
summary: Mark firm setup (own) · 0 credits
description: 'Marks the setup (`{ action: "complete"|"dismiss"|"reopen" }`) for the key owner (`.eq(user_id, userId)`). Thin loopback. No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- action
properties:
action:
type: string
enum:
- complete
- dismiss
- reopen
responses:
'200':
description: Status updated.
content:
application/json:
schema:
type: object
'400':
description: Invalid action.
operationId: patchApiV1AccountFirmSetup
x-operation-id-source: derived
components:
schemas:
ErrorResponse:
type: object
required:
- error
description: Stripe-style error envelope returned by apiError() on ALL v1 routes. `error` is an OBJECT {type, code, message, request_id, details?}; the top-level `error_message`/`code` are backward-compat (deprecated v1.7). A generated client must deserialize `error` as an object, not as a string.
properties:
error:
type: object
required:
- type
- code
- message
properties:
type:
type: string
example: invalid_request_error
code:
type: string
example: VALIDATION_ERROR
message:
type: string
request_id:
type: string
details:
type: object
description: Optional. An engine failure carries what you need in order to decide what to do next, and a `429` says whose ceiling you reached. Each field is present only when it was measured, and `details` is omitted entirely rather than sent empty.
properties:
retryable:
type: boolean
description: Whether retrying this exact request can succeed. Absent means not measured — do not read absence as `true`.
refunded:
type: boolean
description: Whether the credit for this call was returned. Absent means not measured.
reason:
type: string
description: Short machine-readable cause.
example: provider_timeout
provider:
type: string
description: Which engine failed. On a BYO tenant this is the difference between checking your own key and opening a ticket with us.
example: Anthropic (BYO)
error_class:
type: string
scope:
type: string
enum:
- ip
- user
- organization
description: 'On a `429`: whose ceiling you reached.'
retry_after_seconds:
type: integer
description: 'On a `429`: seconds to wait, the same value as the `Retry-After` header.'
limit_per_minute:
type: integer
description: 'On a `429`: the per-minute ceiling you reached.'
error_message:
type: string
description: Backward-compat (deprecated v1.7).
code:
type: string
description: Backward-compat (deprecated v1.7).
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
bearerFormat: nlk_...