API REFERENCE
This reference is generated from the same routes manifest the service ships — path, method, and request/response examples as JSON. The base path is this host; requests and responses are application/json.
The Matter is the unit of legal work — one Client, one legal objective, advanced through the six Stage Verbs (intake, prepare, examine, review, sign, file) to a terminal outcome. Stage is derived from the append-only journal; terminal is forever.
{
"tenant": "acme-ip-tools",
"mint": "patent.click",
"consumerPattern": "B2H2A",
"offer": "provisional",
"listFeeUsd": 1200,
"client": { "name": "Ada Inventor" },
"asset": { "kind": "patent_application", "title": "Distributed ledger for credential attestation" },
"rail": "patent",
"matterType": "patent_provisional",
"clientState": "TX",
"adverseParties": [],
"exposureUsd": 25000,
"clientMandates": { "settlementFloor": 50000 },
"tenantGuardrails": { "maxFeeUsd": 300 }
}{
"matter": {
"id": "m_1",
"stage": "intake",
"status": "intake",
"rail": "patent",
"matterType": "patent_provisional",
"jurisdiction": "*",
"assetId": "a_1",
"needsClientDirection": false
}
}{
"matter": { "id": "m_1", "stage": "review", "status": "waiting_on_signer", "pendingGigId": "g_7" },
"asset": { "id": "a_1", "kind": "patent_application", "lineage": ["m_1"] },
"journal": [
{ "kind": "stage", "verb": "intake", "by": "gate", "note": "matter opened" },
{ "kind": "stage", "verb": "prepare", "by": "agent", "note": "…" }
]
}{
// optional B2H2A override, merged over the agent's Proposal
"merits": { "settlementUsd": 60000, "clientDirectionSeq": 1 }
}{
"matter": { "id": "m_1", "stage": "prepare", "status": "prepare" },
"committed": { "advanceTo": "prepare", "by": "agent" }
}
// or, when the next act is reserved:
{
"matter": { "id": "m_1", "status": "waiting_on_signer", "pendingGigId": "g_7" },
"escalated": { "reservedAct": "sign", "gigId": "g_7" }
}{
"gigId": "g_7",
"outcome": "attested",
"attestation": { "signedBy": "sg_1", "credentialRef": "uspto:71234", "artifactHash": "sha256:…" }
}{ "matter": { "id": "m_1", "stage": "sign", "status": "sign" } }{ "instruction": "proceed with a narrowed claim set", "authorizes": { "settlementUsd": 60000 } }{ "matter": { "id": "m_1", "status": "review", "needsClientDirection": false }, "directionSeq": 6 }{ "actor": "client", "scope": "limited-scope engagement + tenant data access" }{ "matter": { "id": "m_1", "stage": "intake", "consented": true }, "consentSeq": 1 }{
"settlement": {
"rail": "patent",
"merchantOfRecord": "platform",
"productFeeToCustomerUsd": 1200,
"legalFeeToSignerUsd": 300,
"attestedActs": 2,
"perActInsuranceUsd": 40,
"insuranceTotalUsd": 80,
"platformNetUsd": 820
}
}The one-shot Mint surface: a Mint (patent.click) turns a purchase into a Matter and drives it until it waits on a Signer or terminates.
{
"mint": "patent.click",
"offer": "provisional",
"title": "Distributed ledger for credential attestation",
"inventor": "Ada Inventor",
"listFeeUsd": 99
}{ "matterId": "m_2", "status": "waiting_on_signer" }Clock-driven safety machinery on the Asset — deterministic (an explicit tick drives the clock, never wall time), closed only by evidence, daily human acknowledgment inside the final week, and an enumerated terminal rung.
{
"assetId": "a_1",
"daysUntilDeadline": 45,
"alarm": "nominal",
"vacant": false,
"monitoring": { "assetId": "a_1", "signerId": "sg-1" },
"ackRequiredToday": false,
"terminalOutcomes": ["clientNotice", "extensionPurchase", "proSeHandoff", "outsideCounselHandoff"],
"occurrences": [],
"acks": [],
"resolution": null
}{ "actor": "ops@tenant" }{ "acked": true, "atDaysRemaining": 6 }{ "days": 15 }{
"daysUntilDeadline": 30,
"alarm": "nominal",
"events": [{ "rung": "notice", "atDaysRemaining": 30 }]
}{ "signerId": "sg-1" }{ "monitoring": { "assetId": "a_1", "signerId": "sg-1" }, "vacant": false, "alarm": "nominal" }{ "evidenceRef": "de/franchise-tax/receipt/2027" }{
"assetId": "a_1",
"recurEveryDays": 365,
"nextOccurrenceInDays": 365,
"occurrences": [{ "kind": "satisfied", "evidenceRef": "de/franchise-tax/receipt/2027" }],
"resolution": null
}{ "outcome": "outsideCounselHandoff" }{ "resolved": { "kind": "terminal_rung", "outcome": "outsideCounselHandoff" } }Refusals are typed and worded: 404 for a Matter or Asset that does not exist, 409 when the Matter is waiting_on_signer, terminal, or stopped by a Declination, 422 when the Gate refuses a Proposal (mechanics, merits, or a missing Attestation), and 502 when gigs.lawyer refuses a Gig post. The Gate speaks only to refuse — a 2xx is the journal committing.