Firm lane
Read API for firms
Kind: A platform service both lanes stand on.
Availability
ShippedLive on this deployment: it needs nothing more to run.
- Door
/firms/manage/api-keys · /api/v1/matters- Unlocks with
- A firm administrator's session, signed in with its second factor.
Every status follows one rule from this deployment's own configuration: a capability is marked shipped only when everything it needs is in place.
What it does
A firm administrator mints keys that read where the firm's matters stand: ids, statuses and dates, never names or documents.
Keep in mind
A key is shown once and stored only as its SHA-256 fingerprint.
What it refuses
| Answer | HTTP | Meaning |
|---|---|---|
| — | 401 | A missing, malformed, unknown or revoked key gets the same answer, and nothing is read. |
| — | 403 | A key held by the self-help service is refused: the read API serves firm tenants only. |
unavailable | 503 | A read that could not be completed answers 503, marked retryable — never an empty list. |
| — | 429 | Too many requests in a short time: the answer says when to try again. |
- Answer
- —
- HTTP
- 401
- Meaning
- A missing, malformed, unknown or revoked key gets the same answer, and nothing is read.
- Answer
- —
- HTTP
- 403
- Meaning
- A key held by the self-help service is refused: the read API serves firm tenants only.
- Answer
unavailable- HTTP
- 503
- Meaning
- A read that could not be completed answers 503, marked retryable — never an empty list.
- Answer
- —
- HTTP
- 429
- Meaning
- Too many requests in a short time: the answer says when to try again.
What can leave EstateDraft
The registry declares no action of this capability that reaches outside EstateDraft.
Evidence
src/app/api/v1/matters/route.test.tssrc/lib/api-keys.test.tssrc/app/api/v1/matters/contract.tssrc/lib/api-keys.ts
Reviewed: