Quantum Nexus Firm Management API
The Firm Management API from Quantum Nexus — 6 operation(s) for firm management.
The Firm Management API from Quantum Nexus — 6 operation(s) for firm management.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nexusquantum-legal:nexusquantum-legal-firm-management-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Nexus Legal Firm Management 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: Firm Management
paths:
/api/v1/firm/members:
get:
tags:
- Firm Management
summary: List firm members (owner-only) · 0 credits
description: 'Lists the members of YOUR firm (you are the owner): role, active status, email, invitation/acceptance dates. Owner-only via the internal route (`.eq(firm_owner_id, userId)`); if you are not the owner, the list comes back empty. No charge. Scope: mcp | * (NOT cases).'
responses:
'200':
description: Array of FirmMember (owner-scoped).
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FirmMember'
operationId: getApiV1FirmMembers
x-operation-id-source: derived
post:
tags:
- Firm Management
summary: Invite a firm member (owner-only) · 0 credits
description: 'Sends an invitation by email; the person joins the firm when they accept it, whether or not they already have an account (a person is an active member of one firm at most). For someone who is already an active member, it changes their role. `email` required; `role` defaults to author. Consumes a seat: if none are left, it returns `402 SEAT_LIMIT_REACHED` (a SEAT limit, NOT a credit limit — it is not remapped to INSUFFICIENT_CREDITS). It NEVER accepts `firm_owner_id`/overrides from the client. `requireAAL2` is a no-op for API-key auth. No charge. Scope: mcp | *.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddFirmMemberRequest'
responses:
'200':
description: 'The person was already an active member: their role was changed.'
content:
application/json:
schema:
$ref: '#/components/schemas/FirmMember'
'201':
description: Invitation sent. The person is not a member until they accept it.
content:
application/json:
schema:
type: object
properties:
invited:
type: boolean
pending:
type: boolean
email:
type: string
role:
type: string
emailSent:
type: boolean
description: 'false: the invitation exists and holds a seat, but the email was not delivered.'
expiresAt:
type: string
format: date-time
'400':
description: invalid email/role
'402':
description: SEAT_LIMIT_REACHED — no seats available (a seat limit, not a credit limit).
'409':
description: MEMBER_OF_ANOTHER_FIRM — the caller is an active member of another firm and cannot invite to their own.
'503':
description: FIRM_LOOKUP_FAILED — the caller's firm could not be checked; nothing was sent.
operationId: postApiV1FirmMembers
x-operation-id-source: derived
/api/v1/firm/members/{memberId}:
patch:
tags:
- Firm Management
summary: Update a firm member (owner-only) · 0 credits
description: 'Changes a member''s role, or deactivates them (`active:false`). `memberId` goes in the URL. A member who left is not reactivated here: `active:true` on them → `409 REACTIVATION_REQUIRES_INVITATION`; invite them again with `POST /members`. An id from another firm → 404 (owner-only preserved). `requireAAL2` is a no-op for API-key auth. No charge. Scope: mcp | *.'
parameters:
- name: memberId
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirmMemberRequest'
responses:
'200':
description: Member updated.
content:
application/json:
schema:
$ref: '#/components/schemas/FirmMember'
'400':
description: INVALID_ID | invalid role / no fields to update
'404':
description: Member not found (id from another firm or nonexistent).
'409':
description: REACTIVATION_REQUIRES_INVITATION — the member left; they rejoin only by accepting a new invitation.
operationId: patchApiV1FirmMembersByMemberId
x-operation-id-source: derived
delete:
tags:
- Firm Management
summary: Remove a firm member (soft-remove, owner-only) · 0 credits
description: 'Soft-remove (`active:false`): removes the member and frees the seat. `memberId` goes in the URL. An id from another firm or a nonexistent one → 404 (owner-only preserved; NOT 204). `requireAAL2` is a no-op for API-key auth. No charge. Scope: mcp | *.'
parameters:
- name: memberId
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: Member removed (no body).
'400':
description: INVALID_ID (not a UUID)
'404':
description: Member not found (id from another firm or nonexistent).
operationId: deleteApiV1FirmMembersByMemberId
x-operation-id-source: derived
/api/v1/firm/invitations:
get:
tags:
- Firm Management
summary: List the firm's pending invitations (owner-only) · 0 credits
description: 'Lists your firm''s pending invitations (email, role, expiration). The token is NOT exposed. Owner-only via the internal route. No charge. Scope: mcp | *.'
responses:
'200':
description: Array of FirmInvitation (no token).
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FirmInvitation'
operationId: getApiV1FirmInvitations
x-operation-id-source: derived
/api/v1/firm/invitations/{id}:
delete:
tags:
- Firm Management
summary: Revoke a pending firm invitation (owner-only) · 0 credits
description: 'Revokes a pending invitation by its id (frees the seat). Owner-only via the internal helper (`revokeInvitation(sb, ownerId, id)`). Returns `200 {ok:true}` on success (NOT 204); an id belonging to someone else/nonexistent/already consumed → `400 REVOKE_FAILED`. No charge. Scope: mcp | *.'
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Invitation revoked.
content:
application/json:
schema:
type: object
properties:
ok:
type: boolean
'400':
description: INVALID_ID | REVOKE_FAILED (id belonging to someone else/nonexistent/already consumed).
operationId: deleteApiV1FirmInvitationsById
x-operation-id-source: derived
/api/v1/firm/seats:
get:
tags:
- Firm Management
summary: Firm seat usage (owner-only) · 0 credits
description: 'Returns your firm''s seat usage: total, used, remaining, and whether the limit is enforced. Owner-only via the internal helper (`getSeatUsage(sb, ownerId)`). No charge. Scope: mcp | *.'
responses:
'200':
description: Seat usage.
content:
application/json:
schema:
$ref: '#/components/schemas/SeatUsage'
operationId: getApiV1FirmSeats
x-operation-id-source: derived
/api/v1/firm/audit:
get:
tags:
- Firm Management
summary: Firm audit log (owner-only) · 0 credits
description: 'Audit feed for your firm (member actions: invitations, role changes, removals…). Optional filters. Owner-only via the internal helper (`.eq(firm_owner_id, ownerId)`). No charge. Scope: mcp | *.
**Language.** This is a compliance record, so it is served in your firm''s language, not in the language each route happened to be written in. Resolution order: `?locale=` > `Accept-Language` > the account holder''s jurisdiction (SG → en, ES → es) > English. Never Spanish by default. The response declares `locale` and `locale_source` so you can see which signal decided it (`fallback` = there was no signal; it is not presented as a choice).
**Nothing is hidden.** Each line is translated from its stable `action` code, and the text stored when the event was logged is always kept in `summary_raw`. A line whose action has no label in the catalogue is served with its stored text VERBATIM and flagged `summary_localized:false` with `summary_unlocalized_reason` — it is neither translated nor dropped.'
parameters:
- name: actor
in: query
required: false
schema:
type: string
format: uuid
description: Filter by actor UUID.
- name: resource_type
in: query
required: false
schema:
type: string
description: Filter by resource type (member, invitation…).
- name: before
in: query
required: false
schema:
type: string
format: date-time
description: Only events earlier than this ISO-8601 timestamp (pagination).
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 200
default: 50
description: Maximum number of events (1-200; the internal helper clamps).
- name: locale
in: query
required: false
schema:
type: string
description: Language for the record (e.g. en, es, fr, de). Overrides Accept-Language and the holder's jurisdiction.
responses:
'200':
description: '{ locale, locale_source, events: [FirmAuditEvent] }'
content:
application/json:
schema:
type: object
properties:
locale:
type: string
description: Language the record was served in.
locale_source:
type: string
enum:
- param
- cookie
- accept-language
- jurisdiction
- fallback
description: Which signal decided the language. `fallback` = none was available.
events:
type: array
items:
$ref: '#/components/schemas/FirmAuditEvent'
operationId: getApiV1FirmAudit
x-operation-id-source: derived
components:
schemas:
SeatUsage:
type: object
description: Firm seat usage.
properties:
seats:
type: integer
description: Total seats purchased.
used:
type: integer
description: Seats in use (active members + pending invitations).
remaining:
type: integer
description: Free seats.
enforced:
type: boolean
description: Whether the seat limit is enforced for this tenant. This flag is the observable signal — read it rather than inferring enforcement from a request that happened to succeed.
FirmInvitation:
type: object
description: Pending firm invitation (E4). The token is NEVER exposed in list responses.
properties:
id:
type: string
format: uuid
description: Invitation UUID.
email:
type: string
description: Invited email.
role:
type: string
enum:
- author
- reviewer
- approver
- admin
created_at:
type: string
format: date-time
expires_at:
type:
- string
- 'null'
format: date-time
description: Invitation expiry.
FirmMember:
type: object
description: 'Firm member (E4, OWNER-ONLY). The internal route filters by the `firm_owner_id` derived from the `userId` of the KEY: only the owner sees/manages their members. Soft-remove = `active:false`.'
properties:
id:
type: string
format: uuid
description: UUID of the member row (firm_members.id).
member_user_id:
type:
- string
- 'null'
format: uuid
description: UUID of the member user (null while it is still an invitation pending redemption).
email:
type: string
description: Member's email.
role:
type: string
enum:
- author
- reviewer
- approver
- admin
description: Member's role in the firm.
active:
type: boolean
description: Active status (soft-remove sets it to false).
invited_at:
type:
- string
- 'null'
format: date-time
accepted_at:
type:
- string
- 'null'
format: date-time
UpdateFirmMemberRequest:
type: object
description: 'PARTIAL update of a member: send `role` and/or `active`. `memberId` goes in the URL. Reactivating (active=true) may require a free seat (403 SEATS_EXCEEDED when seat enforcement is active for the tenant; `GET /seats` exposes `enforced`).'
properties:
role:
type: string
enum:
- author
- reviewer
- approver
- admin
active:
type: boolean
description: Activate (true) or deactivate (false) the member.
AddFirmMemberRequest:
type: object
required:
- email
description: Invites a person by email; they join the firm when they accept the invitation, whether or not they already have an account. `firm_owner_id` is NEVER accepted from the client (the internal route derives it from the KEY).
properties:
email:
type: string
description: Email of the person to invite.
role:
type: string
enum:
- author
- reviewer
- approver
- admin
default: author
description: Member's role (default author).
FirmAuditEvent:
type: object
description: Event from the firm audit feed (invitations, role changes, removals…). `summary` is served in the language declared by the response's `locale`, translated from the stable `action` code — including for rows written before this behaviour existed (no data migration). `summary_raw` always keeps the text exactly as it was stored when the event was logged.
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
action:
type: string
description: Action recorded (e.g. member.added, member.role_changed, invitation.revoked). Stable code — this is what the summary is translated from.
actor_user_id:
type:
- string
- 'null'
format: uuid
description: UUID of the member who performed the action.
resource_type:
type:
- string
- 'null'
description: Type of resource affected (member, invitation…).
resource_id:
type:
- string
- 'null'
summary:
type:
- string
- 'null'
description: Human-readable event summary, in the response `locale`. Falls back to the stored text when the action has no label (see summary_localized).
summary_raw:
type:
- string
- 'null'
description: The summary exactly as stored when the event was logged, in whatever language it was written. The canonical forensic trace — never rewritten.
summary_localized:
type: boolean
description: '`true` = `summary` was translated from the `action` code. `false` = this line is NOT localized and carries the stored text verbatim; it is neither translated nor omitted.'
summary_source:
type: string
enum:
- action_label
- stored_text
- action_code
description: 'Where `summary` came from: the label catalogue, the stored free text, or the raw action code (no label and nothing stored).'
summary_unlocalized_reason:
type:
- string
- 'null'
description: 'Present (non-null) only when `summary_localized` is false: why this line could not be localized, in the response `locale`.'
detail:
type:
- string
- 'null'
description: Detail derived from the event METADATA (name, jurisdiction, via), not from prose in any language. `null` when there is nothing structured to show.
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
bearerFormat: nlk_...