Documentation
- Interactive API reference Browse and try every operation in the browser.
- OpenAPI 3.1 (JSON) The canonical machine-readable contract.
- OpenAPI 3.1 (YAML) The same contract, YAML serialization.
- Markdown API reference Every operation as plain text — no JavaScript.
- Integration guide Recommended call sequences, start to finish.
- llms.txt Concise index for AI tools and agents.
- llms-full.txt Expanded overview of the API model.
- Guides & tutorials Authentication, requests, webhooks, partner tier.
The OpenAPI specification is the canonical source of truth. AI agents and developer tools should read /openapi.json rather than scraping the interactive reference, which is a JavaScript application and serves no API content in its HTML.
What you can build
- Transactions — create, search, and update deals; manage checklists, contingencies, notes, statuses, and reminders.
- Key dates & tasks — read and write the negotiated deadlines that drive the transaction, and the work items hanging off them.
- Documents & extraction — upload a contract and have DocJacket read it, returning structured fields with confidence and citations back to the source.
- Messaging — send client updates and document requests, draft and schedule messages, and read the unified per-deal communication log.
- Contacts & disclosures — people and companies with roles; assemble seller disclosure packages and track recipient access.
- Webhooks — subscribe to events and be pushed changes instead of polling.
- Partner provisioning — white-label partners provision and administer organizations across their book of business.
Authentication
Every operation takes a bearer token. There are two credential types, and each is rejected on the other's routes.
| Credential | Prefix | Scope of access |
|---|---|---|
| Organization API key | mcp_at_ |
Acts within one organization. Scoped read, draft, and
actions. Created in DocJacket under
Settings → AI & API Access. |
| Reseller / partner key | rsk_ |
Cross-tenant provisioning for white-label partners. Accepted only on
/api/v1/orgs/*. |
A resource belonging to another organization returns 404, never
403 — existence is never disclosed across tenants.
Integration path
- Obtain an API key in DocJacket under Settings → AI & API Access.
- Verify it with the health endpoint — it echoes your organization and scopes.
- Inspect the catalog — every operation, flagged callable against your key.
- Create or retrieve transactions, then attach key dates, tasks, and documents.
- Subscribe to webhooks so changes are pushed to you instead of polled.
# 1. Does my key work? Echoes your organization and granted scopes.
curl https://api.docjacket.com/api/v1/health \
-H "Authorization: Bearer $DOCJACKET_API_KEY"
# 2. What can this key call? Every operation, with a callable flag.
curl https://api.docjacket.com/api/v1/catalog \
-H "Authorization: Bearer $DOCJACKET_API_KEY"
# 3. The book of business.
curl https://api.docjacket.com/api/v1/transactions \
-H "Authorization: Bearer $DOCJACKET_API_KEY"
Conventions
| Base URL | https://api.docjacket.com |
|---|---|
| Errors | { "error": { "code", "message", "fields"? } } —
branch on code, never on message. |
| Rate limits | Per key per minute: 300 reads, 60 writes.
429 with Retry-After: 60. |
| Retries | Send Idempotency-Key on sends; the specification
marks the operations that honor it. |
| Compatibility | Additive. Ignore unknown response fields and do not depend
on property order. Breaking changes ship as /api/v2. |