Dossier developer reference
Your evidence.
Your integrations.
Work with matters, evidence and the knowledge graph through the REST API. Give your AI assistant access to the same workspace through MCP.
https://dossierplus.ai/api/public/v1Start here
Your first request
- Create a workspace token.
Open API keys & MCP, choose your workspace and create a token with
readscope. - Set your environment variables.
Store the key as
DOSSIER_TOKENand the matching workspace UUID asWORKSPACE_ID. Keep credentials on your server. - List your matters.
Run the example. A successful request returns
dataand pagination information inmeta.
Examples use synthetic values. Replace IDs with your own. cURL examples use POSIX shell syntax; the Python example uses only the standard library.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"Authentication
REST requests use a workspace API token in the Authorization header. Tokens are shown once, stored as a SHA-256 hash, and can be revoked from the app.
read- Read the workspace endpoints below.
write- Create, edit and delete matters, events, actors, evidence, claims and storylines. Read and write are separate scopes; select both if your integration needs both.
MCP uses individual OAuth sign-in. Partner endpoints use separate partner keys.
Authorization: Bearer wsk_live_YOUR_TOKEN
Content-Type: application/jsonTargeting a workspace
The workspace UUID goes in the URL. Each workspace token is bound to exactly one workspace. Use the workspace you selected when creating the token; its app URL also contains the UUID.
A token for another workspace returns 401 unauthorized. A matter must belong to the workspace named in the path. The customer REST API does not expose a workspace-list endpoint.
/workspaces/{workspaceId}/matters
/workspaces/{workspaceId}/matters/{matterId}/evidencePagination
Workspace list endpoints accept limit from 1 to 100 (default 50). Pass the returned meta.next_cursor as the next request’s cursor. Stop when it is null or has_more is false.
These lists sort by creation time, newest first. A full page may require one final empty request. The cursor is timestamp-based; records with identical creation timestamps can straddle a page boundary. Do not treat a paginated read as a complete audit export.
Partner endpoints and MCP tools use their own parameters. Check each operation for limit, page or offset.
{
"meta": {
"count": 1,
"limit": 50,
"has_more": false,
"next_cursor": null
}
}Rate limits
Workspace tokens allow 120 requests per minute per token. When throttled, wait at least the number of seconds in Retry-After and retry with backoff.
Partner limits are configured per partner or key. The workspace REST limit is not a published MCP quota.
HTTP/1.1 429 Too Many Requests
Retry-After: 30
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 0Errors & retries
REST errors contain error.code and error.message. Include the response’s X-Request-Id when contacting support.
- 400
- Malformed JSON, an invalid limit or an invalid cursor. Correct the request.
- 401
- Missing, expired, revoked or wrong-workspace token. Check the key and workspace.
- 403
- Required scope is missing or the operation is restricted.
- 404
- The requested resource is unavailable in this workspace.
- 413
- The evidence upload exceeds the size limit.
- 422
- Validation or an operation-specific requirement failed. Read the error code and message.
- 429
- Rate limited. Respect Retry-After.
- 5xx
- A server or dependency failed. Retry reads with bounded backoff.
Do not automatically replay a write after an uncertain response. Reuse an idempotency key or operation ID only where that operation supports it, and check the saved state first.
{
"error": {
"code": "unauthorized",
"message": "Missing, malformed, expired, or revoked API token."
}
}Asynchronous work
An accepted request can leave work in progress. Binary evidence uploads may queue extraction; use List evidence files to check processing status. Partner checks expose a separate status endpoint.
Saved records, extracted text and research results have different review states. Check status and source coverage before treating a result as complete. Internal worker tick routes are not customer integration endpoints.
Workspace endpoints
/workspaces/{workspaceId}/mattersreadList matters
Returns matters in the workspace, newest first.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of matters.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"{
"data": [
{
"id": "0f2a1c6e-6d4b-4d1f-9a1c-6f2b8a3d5e11",
"name": "Riverside Holdings — asset trace",
"description": "Chronology of transfers 2019-2024",
"status": "active",
"project_id": "3a9d0c11-2b77-45a3-8d0e-90c1f7b2a441",
"workspace_id": "9c1b7f22-4f8d-4c0a-b3a6-2f5d81c9e001",
"created_at": "2026-06-02T18:11:04.221Z",
"updated_at": "2026-07-21T09:02:44.010Z"
}
],
"meta": {
"workspace_id": "9c1b…",
"count": 1,
"limit": 50,
"has_more": false,
"next_cursor": null
}
}Response schema
dataobject[]optionalObject fields
idstringoptionaluuid
namestringoptionaldescriptionstring | nulloptionalstatusstringoptionalproject_idstring | nulloptionaluuid
workspace_idstringoptionaluuid
created_atstringoptionaldate-time
updated_atstringoptionaldate-time
metaobjectoptionalObject fields
countintegeroptionallimitintegeroptionalhas_morebooleanoptionalnext_cursorstring | nulloptionaldate-time
/workspaces/{workspaceId}/matterswriteCreate a matter
Creates a matter in the workspace. Requires a token with the write scope. When project_id is omitted the workspace's first project is used. Supply operation_id or an Idempotency-Key header for safe retries. Reusing a key with different input returns 409. Mutations and audit records commit together.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
JSON body required
namestringrequiredmin 2 characters · max 200 characters
descriptionstring | nulloptionalkindstringrequireddefault "investigation"
investigationdiligenceproject_idstringoptionalmin 36 characters · max 36 characters
operation_idstringoptionalmin 8 characters · max 120 characters
Responses
- 200
- The created matter.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- The resource does not exist in this workspace.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"name": "Example",
"kind": "investigation"
}'200 · Response
The created matter.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/eventsreadList timeline events in a matter
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of timeline events.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/events?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
A page of timeline events.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/eventswriteCreate timeline events in bulk
Adds up to 200 events to a matter in one call. Requires a token with the write scope. Events are created accepted and appear immediately on the chronology, graph and exports. Supply operation_id or an Idempotency-Key header for safe retries. Reusing a key with different input returns 409. Mutations and audit records commit together.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
JSON body required
eventsobject[]requiredmin 1 items · max 200 items
Object fields
titlestringrequiredmin 2 characters · max 400 characters
descriptionstring | nulloptionaldate_precisionstringrequireddefault "unknown"
exactapproximaterangeunknowndate_exactstring | nulloptionaldate_approxstring | nulloptionaldate_range_startstring | nulloptionaldate_range_endstring | nulloptionalsource_classstringrequireddefault "other"
court_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewnotesstring | nulloptionaltagsstring[]optionalmax 20 items
operation_idstringoptionalmin 8 characters · max 120 characters
Responses
- 200
- The created events.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- The resource does not exist in this workspace.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/events" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"events": [
{
"title": "Example",
"date_precision": "unknown",
"source_class": "other"
}
]
}'200 · Response
The created events.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/actorsreadList actors in a matter
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of actors.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/actors?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
A page of actors.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/actorswriteCreate actors in bulk
Adds up to 100 people or organisations to a matter, with optional aliases. Requires the write scope. Supply operation_id or an Idempotency-Key header for safe retries. Reusing a key with different input returns 409. Mutations and audit records commit together.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
JSON body required
actorsobject[]requiredmin 1 items · max 100 items
Object fields
canonical_namestringrequiredmin 2 characters · max 200 characters
actor_typestringrequireddefault "person"
personcompanytrustgovernmentothernotesstring | nulloptionalaliasesstring[]optionalmax 30 items
operation_idstringoptionalmin 8 characters · max 120 characters
Responses
- 200
- The created actors.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- The resource does not exist in this workspace.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/actors" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"actors": [
{
"canonical_name": "Example",
"actor_type": "person"
}
]
}'200 · Response
The created actors.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/evidencereadList evidence files in a matter
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of evidence files with processing status.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/evidence?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
A page of evidence files with processing status.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/evidencewriteUpload an evidence file
Uploads a document (base64, max 25 MB) or plain text into a matter. Requires the write scope. Identical bytes reuse the existing file; retries can finish incomplete indexing. Supplied text is paged immediately. With extract=true, readable PDF, DOCX and UTF-8 text use native indexing; no AI or OCR job is queued. With extract=false, binary files remain uploaded, not processing. Check status and indexing_status for completion. PDF page numbers retain physical pages; other text uses chunks.
Provide either text or content_base64. A successful upload confirms storage; check the file’s extraction status before using its content.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
JSON body required
filenamestringrequiredmime_typestringoptionalcontent_base64stringoptionalBase64 file bytes. Max 25 MB decoded.
textstringoptionalPlain text alternative to content_base64.
source_urlstringoptionaluri
descriptionstringoptionalsource_classstringoptionaldefault "third_party"
extractbooleanoptionaldefault true
Responses
- 200
- The stored evidence file.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- The resource does not exist in this workspace.
- 413
- File exceeds the 25 MB limit.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/evidence" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"filename": "source.txt",
"text": "Synthetic documentation example.",
"source_class": "other"
}'200 · Response
The stored evidence file.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/storylinesreadList storylines in a matter
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of storylines.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/storylines?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
A page of storylines.
Returned under data, with meta where provided.
/workspaces/{workspaceId}/matters/{matterId}/storylineswriteCreate a storyline
Creates a storyline title and description. This does not publish a narrative or bypass sentence-proof requirements. Requires write scope. Supply operation_id (or Idempotency-Key) for safe retries.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
JSON body required
titlestringrequiredmin 2 characters · max 400 characters
descriptionstring | nulloptionaloperation_idstringoptionalmin 8 characters · max 120 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/storylines" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"title": "Example"
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/claimsreadList claims in a matter
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
Query parameters
limitintegeroptionalPage size, 1–100. Defaults to 50.
min 1 · max 100 · default 50
cursorstringoptionalISO-8601 timestamp from
meta.next_cursorof the previous page.date-time
Responses
- 200
- A page of claims.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/claims?limit=50" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
A page of claims.
Returned under data, with meta where provided.
Response schema
dataobject[]optionalObject fields
idstringoptionaluuid
matter_idstringoptionaluuid
assertionstringoptionalpredicatestring | nulloptionalobjectstring | nulloptionalsubject_actor_idstring | nulloptionaluuid
evidence_classstringoptionalconfidencestringoptionalstated_or_inferredstringoptionalstatedinferredstatusstringoptionalrelated_event_idstring | nulloptionaluuid
related_case_idstring | nulloptionaluuid
created_atstringoptionaldate-time
metaobjectoptionalObject fields
countintegeroptionallimitintegeroptionalhas_morebooleanoptionalnext_cursorstring | nulloptionaldate-time
/workspaces/{workspaceId}/matters/{matterId}/claimswriteCreate a claim
Requires a token with the write scope. Supply operation_id or an Idempotency-Key header for safe retries. Reusing a key with different input returns 409. Mutations and audit records commit together.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
matterIdstringrequiredA matter inside the workspace.
uuid
JSON body required
assertionstringrequiredmin 3 characters · max 4000 characters
predicatestring | nulloptionalobjectstring | nulloptionalsubject_actor_idstring | nulloptionalrelated_event_idstring | nulloptionalrelated_case_idstring | nulloptionalevidence_classstringrequireddefault "other"
court_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewconfidencestringrequiredmax 50 characters · default "unspecified"
stated_or_inferredstringrequireddefault "stated"
statedinferredoperation_idstringoptionalmin 8 characters · max 120 characters
Responses
- 200
- The created claim.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- The resource does not exist in this workspace.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/claims" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"assertion": "Example",
"evidence_class": "other",
"confidence": "unspecified",
"stated_or_inferred": "stated"
}'200 · Response
The created claim.
Returned under data, with meta where provided.
Response schema
dataobjectoptionalObject fields
idstringoptionaluuid
assertionstringoptionalstatusstringoptionalcreated_atstringoptionaldate-time
/workspaces/{workspaceId}/graphreadExport the workspace knowledge graph
Returns nodes (matter, case, claim, evidence, actor, event) and edges (contains, related, supports, contradicts, subject_of) for the whole workspace. Capped at 5,000 rows per entity type.
The graph is a bounded snapshot. An export at the row cap does not establish complete workspace coverage.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
Responses
- 200
- Graph nodes and edges.
- 401
- Missing, malformed, expired or revoked token.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/graph" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Graph nodes and edges.
Returned under data, with meta where provided.
Response schema
dataobjectoptionalObject fields
nodesobject[]optionalObject fields
idstringoptionalPrefixed id, e.g.
actor:<uuid>.kindstringoptionalmattercaseclaimevidenceactoreventlabelstringoptional
edgesobject[]optionalObject fields
sourcestringoptionaltargetstringoptionalkindstringoptionalcontainsrelatedsupportscontradictssubject_of
metaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}readGet a matter
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}writeEdit a matter
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
namestringoptionalmin 2 characters · max 200 characters
descriptionstring | nulloptionalstatusstringoptionalactiveclosedarchived
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"name": "Updated example label"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}writeDelete a matter
Requires write scope, confirm=true, a reason, and a stable operation_id. confirm_name must match the current matter name. Deletes the matter and dependent records; consumed credits are not refunded. Retained original files are not purged. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringrequiredmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true,
"confirm_name": "Example"
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/events/{recordId}readGet a timeline event
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/events/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/events/{recordId}writeEdit a timeline event
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
titlestringoptionalmin 2 characters · max 400 characters
descriptionstring | nulloptionaldate_precisionstringoptionalexactapproximaterangeunknowndate_exactstring | nulloptionaldate_approxstring | nulloptionaldate_range_startstring | nulloptionaldate_range_endstring | nulloptionalsource_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewnotesstring | nulloptionaltagsstring[]optionalmax 20 items
statusstringoptionalproposedaccepteddisputedrejectedarchived
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/events/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"title": "Updated example label"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/events/{recordId}writeDelete a timeline event
Requires write scope, confirm=true, a reason, and a stable operation_id. Soft-deletes the event, preserving its history and evidence links; it disappears from normal reads. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringoptionalmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/events/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/actors/{recordId}readGet an actor
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/actors/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/actors/{recordId}writeEdit an actor
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required. A supplied aliases list replaces existing aliases.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
canonical_namestringoptionalmin 2 characters · max 200 characters
actor_typestringoptionalpersoncompanytrustgovernmentothernotesstring | nulloptionalaliasesstring[]optionalmax 30 items
statusstringoptionalproposedaccepteddisputedrejectedarchived
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/actors/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"canonical_name": "Updated example label"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/actors/{recordId}writeDelete an actor
Requires write scope, confirm=true, a reason, and a stable operation_id. Removes this record. References or immutable published records may block deletion. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringoptionalmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/actors/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/claims/{recordId}readGet a claim
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/claims/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/claims/{recordId}writeEdit a claim
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
assertionstringoptionalmin 3 characters · max 4000 characters
predicatestring | nulloptionalobjectstring | nulloptionalsubject_actor_idstring | nulloptionalrelated_event_idstring | nulloptionalrelated_case_idstring | nulloptionalevidence_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewconfidencestringoptionalmax 50 characters
stated_or_inferredstringoptionalstatedinferredstatusstringoptionalproposedaccepteddisputedrejectedarchived
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/claims/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"assertion": "Updated example label"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/claims/{recordId}writeDelete a claim
Requires write scope, confirm=true, a reason, and a stable operation_id. Removes this record. References or immutable published records may block deletion. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringoptionalmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/claims/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/storylines/{recordId}readGet a storyline
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/storylines/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/storylines/{recordId}writeEdit a storyline
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required. A storyline with a published version cannot be edited.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
titlestringoptionalmin 2 characters · max 400 characters
descriptionstring | nulloptionalstatusstringoptionalproposedaccepteddisputedrejectedarchived
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/storylines/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"title": "Updated example label"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/storylines/{recordId}writeDelete a storyline
Requires write scope, confirm=true, a reason, and a stable operation_id. Removes this record. References or immutable published records may block deletion. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringoptionalmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/storylines/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/evidence/{recordId}readGet an evidence file
Read a single saved record by its ID. Requires the read scope.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/evidence/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN"200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/evidence/{recordId}writeEdit an evidence file
Requires write scope. Supply only the fields to change in patch; omitted fields remain unchanged and null clears nullable values. A reason and stable operation_id are required. Only file metadata is editable; original bytes and hashes cannot be replaced.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
patchobjectrequiredObject fields
filenamestringoptionalmin 1 characters · max 200 characters
descriptionstring | nulloptionalsource_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewsource_urlstring | nulloptional
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X PATCH "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/evidence/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-edit-001",
"reason": "Correct the record label",
"patch": {
"filename": "renamed-source.txt"
}
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
/workspaces/{workspaceId}/matters/{matterId}/evidence/{recordId}writeDelete an evidence file
Requires write scope, confirm=true, a reason, and a stable operation_id. Removes the evidence record and dependent rows. Retained original file bytes are not purged; storage_retained reports this explicitly. Active legal holds prevent deletion.
Path parameters
workspaceIdstringrequireduuid
matterIdstringrequireduuid
recordIdstringrequireduuid
JSON body required
operation_idstringrequiredmin 8 characters · max 120 characters
reasonstringrequiredmin 5 characters · max 1000 characters
confirmbooleanrequiredconfirm_namestringoptionalmin 1 characters · max 200 characters
Responses
- 200
- Confirmed saved result. Mutation metadata includes operation_id and replayed.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- Record not found in this workspace or matter.
- 409
- An active legal hold, published storyline, dependent record, or operation ID conflict prevents this change.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Result could not be confirmed. Retry identical input using the same operation_id.
curl --fail-with-body -X DELETE "https://dossierplus.ai/api/public/v1/workspaces/$WORKSPACE_ID/matters/$MATTER_ID/evidence/$RECORDID" \
-H "Authorization: Bearer $DOSSIER_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"operation_id": "example-operation-001",
"reason": "Example",
"confirm": true
}'200 · Response
Confirmed saved result. Mutation metadata includes operation_id and replayed.
Returned under data, with meta where provided.
Response schema
dataobject | arrayoptionalmetaobjectoptional
Model Context Protocol · 1.1.0
Connect an AI assistant
Dossier offers a remote Streamable HTTP MCP server. Add the server URL to a client that supports remote MCP and OAuth, then complete Dossier sign-in and consent.
- Add the remote server.
Use the client’s custom connector or MCP settings. Select OAuth when prompted.
- Sign in to Dossier.
Each person authorizes their own connection. Matter and report tools honor the signed-in user’s access. Partner tools also require a scoped partner key.
- Discover the tools.
Refresh the client’s tool list, then call
list_mattersto find a matter you can access.
Use the tools returned by your connected server’s discovery. Client availability and account policies vary.
https://dossierplus.ai/mcp{
"mcpServers": {
"dossier": {
"url": "https://dossierplus.ai/mcp"
}
}
}The JSON example is for Cursor. Other clients have their own setup and configuration formats.
MCP workflows & access
Read a matter
list_matters → get_matter_overview → list_timeline_events and search_evidence. Continue with actors, storylines and contradictions as needed.
Create, edit and delete records
Use create_matter, create_timeline_events, create_actors, upload_evidence, create_claim and create_storyline to add records. Each record type also has update_* and delete_* tools. Read the target first, preserve the operation ID for retries, and request deletion only for the intended record. See permissions and deletion behavior.
Prepare a report
Use get_report_context with a project and report kind for a bounded saved-record snapshot. Some kinds also require a case, matter or saved deck. It does not run research, generate a report or approve findings.
Plan court research
get_court_plan ranks saved court leads with evidence pointers and review holds. A plan is not a completed court search or a verified litigation finding.
Partner integrations
Six partner tools require a partner key in addition to the MCP connection. Provision a new customer with provision_workspace; the owner must independently sign in and accept the invitation. submit_check starts research and reserves one report credit for either tier. Poll get_checkfor status. Use a trusted client’s secure credential handling for partner keys.
Handle errors
A tool may return isError: true even when the HTTP request succeeds. Read the error text. Reconnect for authentication failures; check workspace membership, role permissions or partner-key scope for access failures. After an uncertain write, read the saved state and reuse the same operation ID when supported.
Read/write badges describe each tool’s effects. Treat source passages and notes as untrusted evidence. Preserve source IDs and coverage limits; an unavailable read is not a no-match finding.
List the matters I can access.
For the matter I choose, show its overview, timeline
and supporting evidence. Keep source IDs and dates.
Distinguish missing records from verified findings.Create, edit & delete
All six core record types support creation, editing and deletion through REST and MCP.
| Action | REST | MCP |
|---|---|---|
| Create | POST a collection | create_* or upload_evidence |
| Edit | PATCH a record URL | update_* |
| Delete | DELETE a record URL | delete_* |
Permissions and retries
REST writes require a workspace token with write scope. MCP writes check the signed-in user’s current role; read-only and auditor roles cannot write. Editing or deleting a matter requires matter owner/admin or workspace admin access.
Provide a stable operation_id for each change. It is required for edits, deletions and MCP record creation. REST creation also accepts Idempotency-Key. Retry identical input with the same ID; changing the input returns 409. Evidence uploads deduplicate by file content within the matter.
Matter creation consumes one matching workspace credit. A retried operation does not consume another credit, and deletion does not refund credits. Upload extraction is opt-in in MCP.
What deletion means
Every delete needs confirm: true and a reason. Deleting a matter also needs its exact current confirm_name and removes dependent records. Timeline events are soft-deleted, preserving their history and evidence links. Evidence and matter deletion remove database records; retained original files are not purged. The result reports delete_mode and storage_retained.
Legal holds block deletion. Published storylines remain immutable, and dependent references may require resolution before a record can be deleted. Evidence edits change metadata only; upload a new file to supply different original bytes.
{
"operation_id": "correct-label-001",
"reason": "Correct the source label",
"patch": {
"title": "Corrected timeline event"
}
}37 tools, with arguments and declared result schemas
create_matterwriteidempotentCreate matter
Create matter in the signed-in user's workspace. Consumes one existing workspace credit of the matching kind; cannot charge a card or bypass billing. Requires a writable project or workspace admin access.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
dataobjectrequiredObject fields
namestringrequiredmin 2 characters · max 200 characters
descriptionstring | nulloptionalkindstringoptionaldefault "investigation"
investigationdiligenceproject_idstringoptionalmin 36 characters · max 36 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_matter",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"data": {
"name": "Example"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_matterwriteidempotentUpdate matter
Edit the supplied fields on an existing matter. Omitted fields stay unchanged; null clears nullable fields. A reason is required.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
namestringoptionalmin 2 characters · max 200 characters
descriptionstring | nulloptionalstatusstringoptionalactiveclosedarchived
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_matter",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"name": "Updated example label"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_matterdeleteidempotentDelete matter
Delete matter records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires matter owner/admin or workspace admin access and the exact matter name. Credits are not refunded.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
confirm_namestringrequiredThe current matter name, entered exactly to confirm deletion of the matter and its children.
min 1 characters · max 200 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_matter",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true,
"confirm_name": "Example"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
create_timeline_eventswriteidempotentCreate timeline events
Create timeline events in the signed-in user's workspace. Requires write access to the matter. Creates records without dispatching research or AI.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
dataobject[]requiredmin 1 items · max 200 items
Object fields
titlestringrequiredmin 2 characters · max 400 characters
descriptionstring | nulloptionaldate_precisionstringoptionaldefault "unknown"
exactapproximaterangeunknowndate_exactstring | nulloptionaldate_approxstring | nulloptionaldate_range_startstring | nulloptionaldate_range_endstring | nulloptionalsource_classstringoptionaldefault "other"
court_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewnotesstring | nulloptionaltagsstring[]optionalmax 20 items
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_timeline_events",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"data": [
{
"title": "Example"
}
]
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_timeline_eventwriteidempotentUpdate timeline event
Edit the supplied fields on an existing timeline event. Omitted fields stay unchanged; null clears nullable fields. A reason is required.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
titlestringoptionalmin 2 characters · max 400 characters
descriptionstring | nulloptionaldate_precisionstringoptionalexactapproximaterangeunknowndate_exactstring | nulloptionaldate_approxstring | nulloptionaldate_range_startstring | nulloptionaldate_range_endstring | nulloptionalsource_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewnotesstring | nulloptionaltagsstring[]optionalmax 20 items
statusstringoptionalproposedaccepteddisputedrejectedarchived
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_timeline_event",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"title": "Updated example label"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_timeline_eventdeleteidempotentDelete timeline event
Delete timeline event records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires write access to the matter.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_timeline_event",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
create_actorswriteidempotentCreate actors
Create actors in the signed-in user's workspace. Requires write access to the matter. Creates records without dispatching research or AI.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
dataobject[]requiredmin 1 items · max 100 items
Object fields
canonical_namestringrequiredmin 2 characters · max 200 characters
actor_typestringoptionaldefault "person"
personcompanytrustgovernmentothernotesstring | nulloptionalaliasesstring[]optionalmax 30 items
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_actors",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"data": [
{
"canonical_name": "Example"
}
]
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_actorwriteidempotentUpdate actor
Edit the supplied fields on an existing actor. Omitted fields stay unchanged; null clears nullable fields. A reason is required. When aliases are supplied, they replace the alias list.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
canonical_namestringoptionalmin 2 characters · max 200 characters
actor_typestringoptionalpersoncompanytrustgovernmentothernotesstring | nulloptionalaliasesstring[]optionalmax 30 items
statusstringoptionalproposedaccepteddisputedrejectedarchived
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_actor",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"canonical_name": "Updated example label"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_actordeleteidempotentDelete actor
Delete actor records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires write access to the matter.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_actor",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
create_claimwriteidempotentCreate claim
Create claim in the signed-in user's workspace. Requires write access to the matter. Creates records without dispatching research or AI.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
dataobjectrequiredObject fields
assertionstringrequiredmin 3 characters · max 4000 characters
predicatestring | nulloptionalobjectstring | nulloptionalsubject_actor_idstring | nulloptionalrelated_event_idstring | nulloptionalrelated_case_idstring | nulloptionalevidence_classstringoptionaldefault "other"
court_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewconfidencestringoptionalmax 50 characters · default "unspecified"
stated_or_inferredstringoptionaldefault "stated"
statedinferred
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_claim",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"data": {
"assertion": "Example"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_claimwriteidempotentUpdate claim
Edit the supplied fields on an existing claim. Omitted fields stay unchanged; null clears nullable fields. A reason is required.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
assertionstringoptionalmin 3 characters · max 4000 characters
predicatestring | nulloptionalobjectstring | nulloptionalsubject_actor_idstring | nulloptionalrelated_event_idstring | nulloptionalrelated_case_idstring | nulloptionalevidence_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewconfidencestringoptionalmax 50 characters
stated_or_inferredstringoptionalstatedinferredstatusstringoptionalproposedaccepteddisputedrejectedarchived
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_claim",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"assertion": "Updated example label"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_claimdeleteidempotentDelete claim
Delete claim records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires write access to the matter.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_claim",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
create_storylinewriteidempotentCreate storyline
Create storyline in the signed-in user's workspace. Requires write access to the matter. Creates records without dispatching research or AI.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
dataobjectrequiredObject fields
titlestringrequiredmin 2 characters · max 400 characters
descriptionstring | nulloptional
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "create_storyline",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"data": {
"title": "Example"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_storylinewriteidempotentUpdate storyline
Edit the supplied fields on an existing storyline. Omitted fields stay unchanged; null clears nullable fields. A reason is required. Published storylines are immutable.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
titlestringoptionalmin 2 characters · max 400 characters
descriptionstring | nulloptionalstatusstringoptionalproposedaccepteddisputedrejectedarchived
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_storyline",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"title": "Updated example label"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_storylinedeleteidempotentDelete storyline
Delete storyline records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires write access to the matter.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_storyline",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
update_evidencewriteidempotentUpdate evidence
Edit the supplied fields on an existing evidence. Omitted fields stay unchanged; null clears nullable fields. A reason is required. Edits metadata only; original file bytes and hashes cannot be overwritten.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
patchobjectrequiredObject fields
filenamestringoptionalmin 1 characters · max 200 characters
descriptionstring | nulloptionalsource_classstringoptionalcourt_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewsource_urlstring | nulloptional
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "update_evidence",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"patch": {
"filename": "renamed-source.txt"
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
delete_evidencedeleteidempotentDelete evidence
Delete evidence records only after an explicit user request. Legal holds, dependent records, and published storylines can block deletion. Timeline events are soft-deleted. Evidence and matter deletion removes records and related rows but does not purge retained original files. Requires write access to the matter.
Arguments
workspace_idstringrequiredWorkspace containing the target records.
min 36 characters · max 36 characters
operation_idstringrequiredStable unique ID for this action. Retry with the same ID and identical input; never reuse it for another action.
min 8 characters · max 120 characters
matter_idstringrequiredmin 36 characters · max 36 characters
record_idstringrequiredID of the record to change, within this matter.
min 36 characters · max 36 characters
reasonstringrequiredWhy this record is being changed; saved in the audit trail.
min 5 characters · max 1000 characters
confirmbooleanrequiredSet true only after the user explicitly requests deletion of this target.
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "delete_evidence",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"operation_id": "example-operation-001",
"matter_id": "11111111-1111-4111-8111-111111111111",
"record_id": "11111111-1111-4111-8111-111111111111",
"reason": "Example",
"confirm": true
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
upload_evidencewriteidempotentUpload evidence
Upload original evidence as text or base64 bytes into a writable matter. Maximum decoded size is 25 MB; use small files in chat clients. Identical bytes reuse the existing record, and retries can finish incomplete indexing. Supplied text is searchable immediately. Binary files are stored as uploaded unless extract=true requests native PDF, DOCX or UTF-8 text indexing. This does not queue AI or OCR. Read status and indexing_status for the confirmed result. File replacement is not supported: upload a new version instead.
Arguments
workspace_idstringrequiredmin 36 characters · max 36 characters
matter_idstringrequiredmin 36 characters · max 36 characters
fileobjectrequiredObject fields
filenamestringrequiredmin 1 characters · max 200 characters
mime_typestringoptionalmax 120 characters
content_base64stringoptionalmin 4 characters · max 35000000 characters
textstringoptionalmin 1 characters · max 26214400 characters
source_urlstringoptionaluri · max 2000 characters
descriptionstringoptionalmax 1000 characters
source_classstringoptionaldefault "third_party"
court_recordregulatory_filingnewsinternal_documentpublic_recordthird_partystatementotheremailemail_threadscreenshotimagecalendar_invitecontact_cardarchiveunsupported_manual_reviewextractbooleanoptionaldefault false
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "upload_evidence",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"matter_id": "11111111-1111-4111-8111-111111111111",
"file": {
"filename": "source.txt",
"text": "Synthetic documentation example.",
"extract": false
}
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_claimsreadidempotentList claims
Read a bounded page of claims in an accessible matter, including their actor and event references. Use IDs from this result when editing or deleting claims. This is a page, not proof of complete coverage.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
limitintegeroptionalmin 1 · max 100 · default 25
cursorstringoptionaldate-time
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_claims",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_mattersreadidempotentList matters
List the investigation and due-diligence matters the signed-in user can access, newest first.
Arguments
querystringoptionalOptional name filter.
max 200 characters
limitintegeroptionalMax matters to return (default 25).
min 1 · max 100
Result
mattersobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
namestringrequireddescriptionstring | nullrequiredkindstringrequiredstatusstringrequiredworkspace_idstring | nullrequiredproject_idstring | nullrequiredcreated_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_matters",
"arguments": {
"limit": 25
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_matter_overviewreadidempotentGet matter overview
Counts and headline facts for one matter: events, actors, evidence files, claims, storylines and open contradictions.
Arguments
matter_idstringrequiredThe matter to summarise.
min 36 characters · max 36 characters
Result
matterobjectrequiredObject fields
idstringrequiredmin 36 characters · max 36 characters
namestringrequireddescriptionstring | nullrequiredkindstringrequiredstatusstringrequiredcreated_atstringrequired
countsobjectrequiredObject fields
eventsnumberrequiredactorsnumberrequiredevidence_filesnumberrequiredclaimsnumberrequiredstorylinesnumberrequiredopen_contradictionsnumberrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_matter_overview",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_timeline_eventsreadidempotentList timeline events
Chronology events for a matter, with optional date-range, text, tag and source-class filters. Deleted events are excluded.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
querystringoptionalText match against the event title.
max 200 characters
fromstringoptionalEarliest event date, YYYY-MM-DD.
date
tostringoptionalLatest event date, YYYY-MM-DD.
date
tagsstring[]optionalReturn events carrying any of these tags.
max 10 items
limitintegeroptionalmin 1 · max 100
Result
eventsobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
titlestringrequireddescriptionstring | nullrequireddate_exactstring | nullrequireddate_approxstring | nullrequireddate_range_startstring | nullrequireddate_range_endstring | nullrequireddate_precisionstring | nullrequireddate_qualitystring | nullrequiredsource_classstring | nullrequiredtagsstring[] | nullrequirednotesstring | nullrequiredstatusstringrequiredcreated_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_timeline_events",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
search_evidencereadidempotentSearch evidence files
Find evidence files in a matter by filename or description, with extraction status so you can tell what has been processed.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
querystringrequiredFilename or description fragment.
min 1 characters · max 200 characters
limitintegeroptionalmin 1 · max 100
Result
evidenceobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
filenamestringrequireddescriptionstring | nullrequiredmime_typestring | nullrequiredbyte_sizenumber | nullrequiredpage_countnumber | nullrequiredsource_classstring | nullrequiredstatusstringrequiredextraction_phasestring | nullrequiredextraction_errorstring | nullrequiredcreated_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "search_evidence",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111",
"query": "Northgate"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_actorsreadidempotentList actors
People, companies and other entities identified in a matter, with their known aliases.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
querystringoptionalName fragment filter.
max 200 characters
limitintegeroptionalmin 1 · max 100
Result
actorsobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
canonical_namestringrequiredactor_typestringrequiredstatusstringrequirednotesstring | nullrequiredcreated_atstringrequiredaliasesstring[]required
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_actors",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_storylinesreadidempotentList storylines
Themed storyline summaries and statuses for a matter, including auto-generated ones. Does not include storyline sentences or their proof links.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
limitintegeroptionalmin 1 · max 100
Result
storylinesobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
titlestringrequireddescriptionstring | nullrequiredstatusstringrequiredis_autobooleanrequiredauto_theme_keystring | nullrequiredcreated_atstringrequiredupdated_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_storylines",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_contradictionsreadidempotentList contradictions
Detected conflicts between claims or events in a matter, so you can see where the record disagrees with itself.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
include_resolvedbooleanoptionalInclude contradictions already resolved (default false).
limitintegeroptionalmin 1 · max 100
Result
contradictionsobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
kindstringrequiredsummarystringrequiredstatusstringrequirednotesstring | nullrequiredclaim_a_idstring | nullrequiredclaim_b_idstring | nullrequiredevent_a_idstring | nullrequiredevent_b_idstring | nullrequireddetected_atstringrequiredresolved_atstring | nullrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_contradictions",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_dd_casesreadidempotentList due-diligence cases
Due-diligence cases in a workspace, with deal type, gate and decision state.
Arguments
workspace_idstringrequiredmin 36 characters · max 36 characters
limitintegeroptionalmin 1 · max 100
Result
casesobject[]requiredObject fields
idstringrequiredmin 36 characters · max 36 characters
matter_idstring | nullrequiredproject_idstring | nullrequiredcase_typestringrequiredinstrumentstring | nullrequiredsectorstring | nullrequiredgeographystring | nullrequiredthesisstring | nullrequiredcurrent_gatestring | nullrequireddecision_statestring | nullrequiredtarget_close_datestring | nullrequiredcreated_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_dd_cases",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_dd_case_scorereadidempotentGet due-diligence score
The latest 0-100 control score for a due-diligence case, with band, weakest domains and scoring rationale.
Arguments
case_idstringrequiredmin 36 characters · max 36 characters
Result
scoreobjectrequiredObject fields
idstringrequiredmin 36 characters · max 36 characters
scorenumber | nullrequiredbandstring | nullrequiredweakest_domainsanyrequireddriversanyrequiredrationalestring | nullrequiredmodelstring | nullrequiredcomputed_atstringrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_dd_case_score",
"arguments": {
"case_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
add_event_notewriteidempotentAdd a note to a timeline event
Append a dated analyst note to an existing timeline event. Existing notes are preserved, never overwritten.
Arguments
event_idstringrequiredmin 36 characters · max 36 characters
notestringrequiredThe note text to append.
min 2 characters · max 2000 characters
operation_idstringrequiredA stable identifier for this note operation so a retried call cannot append twice.
min 8 characters · max 120 characters
Result
eventobjectrequiredObject fields
idstringrequiredmin 36 characters · max 36 characters
titlestringrequirednotesstring | nullrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "add_event_note",
"arguments": {
"event_id": "11111111-1111-4111-8111-111111111111",
"note": "Example",
"operation_id": "example-operation-001"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
provision_workspacewriteidempotentProvision a Dossier workspace
Create a new Dossier account, workspace, default project and API access for a customer of an integration partner. Requires a live partner key (dpk_live_...). Existing accounts require a separate owner-authorized workflow. Claim links require the intended owner's independent verified sign-in and never create a session. Repeating a completed idempotency_key returns the existing workspace without reissuing secrets; unfinished provisioning requires reconciliation.
Arguments
partner_keystringrequiredPartner provisioning key (dpk_live_...).
min 8 characters
emailstringrequiredEmail of the end user who will own the workspace.
email
display_namestringoptionalmin 1 characters · max 120 characters
workspace_namestringoptionalmin 1 characters · max 120 characters
project_namestringoptionalmin 1 characters · max 120 characters
matter_namestringoptionalOptionally create a first matter.
min 1 characters · max 160 characters
plan_idstringoptionalPlan to stamp on the workspace; defaults to the partner's plan.
min 1 characters · max 60 characters
external_refstringoptionalYour own customer/account id.
min 1 characters · max 200 characters
idempotency_keystringoptionalmin 8 characters · max 200 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "provision_workspace",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY",
"email": "developer@example.com"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_provisioned_workspacereadidempotentGet a provisioned workspace
Status, plan, claim state and usage counters for a workspace this partner provisioned. Requires a partner key (dpk_...).
Arguments
partner_keystringrequiredPartner provisioning key (dpk_live_...).
min 8 characters
workspace_idstringrequiredmin 36 characters · max 36 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_provisioned_workspace",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY",
"workspace_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_provisioned_workspacesreadidempotentList provisioned workspaces
Every Dossier workspace this partner has provisioned, newest first, with state and claim status. Requires a partner key (dpk_...).
Arguments
partner_keystringrequiredPartner provisioning key (dpk_live_...).
min 8 characters
limitintegeroptionalmin 1 · max 100
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_provisioned_workspaces",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
submit_checkwriteidempotentSubmit a Dossier check
Submit a subject (company, person, fund) for a Dossier background check. Opens a matter in the customer's Dossier workspace, seeds the subjects and starts research immediately. Both tiers reserve one workspace report credit; 'plus' runs deeper research. A missing credit blocks submission without charging a card. Requires a partner key (dpk_...). Idempotent on idempotency_key or external_ref.
Arguments
partner_keystringrequiredPartner provisioning key (dpk_live_...).
min 8 characters
subject_namestringrequiredPrimary subject to look into.
min 1 characters · max 160 characters
subject_typestringoptionalDefaults to company.
personcompanytrustgovernmentotheradditional_subjectsobject[]optionalOther people or entities to include in the same check.
max 25 items
Object fields
namestringrequiredmin 1 characters · max 200 characters
typestringoptionalmax 40 characters
notestringoptionalmax 500 characters
reasonstringoptionalWhy the check is being run.
max 2000 characters
tierstringoptionalstandardplusworkspace_idstringoptionalExisting provisioned workspace to file the check in.
min 36 characters · max 36 characters
emailstringoptionalCustomer email — used to create a workspace if none exists yet.
email
display_namestringoptionalmin 1 characters · max 120 characters
external_refstringoptionalYour own check/request id.
min 1 characters · max 200 characters
idempotency_keystringoptionalmin 8 characters · max 200 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "submit_check",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"subject_name": "Example Company",
"tier": "standard",
"idempotency_key": "example-check-001"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_checkreadidempotentGet a Dossier check
Read the status and progress of a submitted Dossier check (queued, running, ready, failed) plus a link to open it in Dossier. Requires a partner key (dpk_...).
Arguments
partner_keystringrequiredPartner key (dpk_live_...).
min 8 characters
check_idstringrequiredThe check_id returned by submit_check.
min 36 characters · max 36 characters
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_check",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY",
"check_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
list_checksreadidempotentList Dossier checks
List Dossier checks submitted by this partner, newest first, optionally filtered to one workspace. Requires a partner key (dpk_...).
Arguments
partner_keystringrequiredPartner key (dpk_live_...).
min 8 characters
workspace_idstringoptionalmin 36 characters · max 36 characters
limitintegeroptionalmin 1 · max 100
Result
Returns JSON in MCP text content. This tool does not declare a structured output schema. Check the returned fields and error status before using the result.
Access, errors and workflow guidance{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_checks",
"arguments": {
"partner_key": "dpk_live_YOUR_PARTNER_KEY"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_report_contextreadidempotentGet saved report context
Retrieve a bounded current saved-record snapshot for a Dossier report, including source references, excerpts, selection, limitations and content digest. Supports diligence, investigation, project/matter dossier, overview, timeline, questions, subject, Gantt, saved slides, case brief and saved request memo. Requires project_id and caller membership. Not a reconstruction of a prior export. Does not run AI, research, generate a report, modify records or approve findings.
Arguments
project_idstringrequiredmin 36 characters · max 36 characters
report_kindstringrequireddiligenceinvestigationproject_dossiermatter_dossieroverviewtimelinequestionssubjectproject_ganttslidescase_briefrequest_memomatter_idsstring[]optionalOptional nonempty matter selection, all belonging to this project.
min 1 items · max 50 items
case_idstringoptionalmin 36 characters · max 36 characters
subject_idsstring[]optionalActor IDs for a subject report; not diligence subject IDs.
min 1 items · max 50 items
event_idsstring[]optionalmin 1 items · max 50 items
question_idsstring[]optionalmin 1 items · max 50 items
deck_idstringoptionalRequired for a saved slide deck; unsaved slide edits are excluded.
min 36 characters · max 36 characters
request_idstringoptionalmin 36 characters · max 36 characters
limitintegeroptionalMaximum rows per register. Additional rows are disclosed as omitted.
min 1 · max 100 · default 40
Result
contextobjectrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_report_context",
"arguments": {
"project_id": "11111111-1111-4111-8111-111111111111",
"report_kind": "project_dossier",
"limit": 40
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
get_court_planreadidempotentGet court research plan
Rank saved matter court leads using the versioned Court Atlas. Returns evidence pointers, P0 known proceedings, P1 procedural links, P2 geographic nexuses and P3 context cases, with identity, jurisdiction and access holds. Does not search courts, spend money, establish party identity or imply complete coverage.
Arguments
matter_idstringrequiredmin 36 characters · max 36 characters
Result
planobjectrequired
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_court_plan",
"arguments": {
"matter_id": "11111111-1111-4111-8111-111111111111"
}
}
}Illustrative arguments for an initialized MCP connection. Replace example IDs and values with records you can access. Your client handles OAuth, initialization and transport headers.
Partner integrations
Partner API access
Approved integrations use a separate partner key to provision customer workspaces, submit checks and manage partner operations. Workspace tokens and MCP OAuth connections cannot replace this key.
Each operation below shows its required read or provision scope. Partner checks can consume credits; invoice and lifecycle operations have billing or account effects.
Use each endpoint’s documented idempotency fields. Partner pagination and rate limits differ from workspace endpoints.
Authorization: Bearer dpk_live_YOUR_PARTNER_KEY/partner/provisionprovisionProvision a Dossier account for a partner's customer
Creates a new end user, their workspace, a default project, an optional first matter, a scoped workspace API token and a one-time claim link — in one call. Existing accounts require a separate owner-authorized workflow. Claim links require the intended owner's independent verified sign-in; they never create an account session. Authenticate with a partner key (dpk_live_…), not a workspace token. Idempotent: repeating the call with the same idempotency_key (or the Idempotency-Key header) returns the existing workspace instead of a duplicate.
JSON body required
emailstringrequiredEnd user who will own the workspace.
email
display_namestringoptionalmax 120 characters
workspace_namestringoptionalmax 120 characters
project_namestringoptionalmax 120 characters
matter_namestringoptionalOptionally create a first matter.
max 160 characters
plan_idstringoptionalPlan stamped on the workspace; defaults to the partner's plan.
external_refstringoptionalYour own customer/account identifier.
idempotency_keystringoptionalmin 8 characters
metadataobjectoptional
Responses
- 200
- The provisioned workspace.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/provision" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"email": "customer@example.com",
"display_name": "Alex Kim",
"workspace_name": "Acme Diligence",
"plan_id": "dossier_plus",
"external_ref": "acct_9182",
"idempotency_key": "acct_9182"
}'200 · Response
The provisioned workspace.
Returned under data, with meta where provided.
Response schema
dataobjectoptionalObject fields
provision_idstringoptionaluuid
statestringoptionalpendingreadyclaimedfailedreusedbooleanoptionalTrue when an existing provision was returned.
emailstringoptionalemail
plan_idstringoptionalworkspace_idstringoptionaluuid
project_idstringoptionaluuid
matter_idstringoptionaluuid
api_tokenstringoptionalWorkspace API token, returned once.
claim_urlstringoptionalOne-time workspace claim link. The intended owner must independently sign in with a verified account; the link does not create a session.
claim_expires_atstringoptionaldate-time
mcp_urlstringoptionalapi_base_urlstringoptional
/partner/workspaces/{workspaceId}provisionRead a provisioned workspace
Provisioning state, plan, claim status and usage counters for a workspace this partner created.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
Responses
- 200
- Provision status and usage.
- 401
- Missing, malformed, expired or revoked token.
- 404
- The resource does not exist in this workspace.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/workspaces/$WORKSPACE_ID" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Provision status and usage.
Returned under data, with meta where provided.
Response schema
dataobjectoptional
/partner/checksprovisionSubmit a Dossier check on a subject
Files a background check: opens a matter in the customer's workspace, seeds the subject (and any additional subjects) as actors and starts research immediately. Pass workspace_id for an existing provisioned workspace, or email to have one created. Both tiers reserve one workspace report credit. Tier plus runs deeper research. Insufficient credit blocks submission without charging a card. Idempotent on idempotency_key, the Idempotency-Key header, or external_ref.
JSON body required
subject_namestringrequiredmin 1 characters · max 160 characters
subject_typestringoptionalmax 40 characters
additional_subjectsobject[]optionalmax 25 items
Object fields
namestringrequiredmin 1 characters · max 200 characters
typestringoptionalmax 40 characters
notestringoptionalmax 500 characters
reasonstringoptionalmax 2000 characters
tierstringoptionalstandardplusworkspace_idstringoptionaluuid
emailstringoptionalemail · max 254 characters
display_namestringoptionalmin 1 characters · max 120 characters
external_refstringoptionalmin 1 characters · max 200 characters
idempotency_keystringoptionalmin 8 characters · max 200 characters
metadataobjectoptional
Responses
- 200
- Check accepted.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/checks" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"subject_name": "Acme Holdings LLC",
"subject_type": "company",
"additional_subjects": [
{
"name": "Jane Roe",
"type": "person"
}
],
"reason": "Pre-close sponsor diligence",
"tier": "plus",
"external_ref": "check_8821"
}'200 · Response
Check accepted.
Returned under data, with meta where provided.
Response schema
object
/partner/checksreadList checks submitted by this partner
Newest first. Optionally filter to one workspace. Requires the read scope.
Query parameters
workspace_idstringoptionaluuid
limitintegeroptionalmin 1 · max 100
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/checks?limit=50" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/checks/{checkId}readGet one check's status and progress
Returns status (queued, running, ready, failed), counts of what has been gathered so far, and a link to open the matter in Dossier. Requires the read scope.
Path parameters
checkIdstringrequireduuid
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 404
- No such check for this partner.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/checks/$CHECK_ID" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/provision/batchprovisionProvision up to 100 customers in one call
Bulk onboarding. Each entry is provisioned idempotently and reported individually; one failure never aborts the batch.
JSON body required
customersobject[]requiredmin 1 items · max 100 items
Object fields
emailstringrequiredEnd user who will own the workspace.
email
display_namestringoptionalmax 120 characters
workspace_namestringoptionalmax 120 characters
project_namestringoptionalmax 120 characters
matter_namestringoptionalOptionally create a first matter.
max 160 characters
plan_idstringoptionalPlan stamped on the workspace; defaults to the partner's plan.
external_refstringoptionalYour own customer/account identifier.
idempotency_keystringoptionalmin 8 characters
metadataobjectoptional
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/provision/batch" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"customers": [
{
"email": "customer@example.com",
"idempotency_key": "customer-example-001"
}
]
}'200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/overviewreadPartner overview
Accounts, claim states and rolled-up metered usage for this partner. Requires the read scope.
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/overview" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/workspaces/{workspaceId}/lifecycleprovisionSuspend, resume or deprovision a workspace
Suspend freezes API tokens but keeps all data. Deprovision schedules deletion after a grace period (default 14 days) and can be cancelled by resuming.
Path parameters
workspaceIdstringrequiredWorkspace UUID. Workspace API requests require a token bound to this workspace; partner requests require a workspace provisioned by the partner.
uuid
JSON body required
actionstringrequiredsuspendresumedeprovisionreasonstringoptionalmax 500 characters
grace_daysintegeroptionalDeletion grace period for deprovision; defaults to 14 days.
min 1 · max 90
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/workspaces/$WORKSPACE_ID/lifecycle" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"action": "suspend",
"reason": "Customer-requested pause"
}'200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/keysreadList partner keys
Keys issued to this partner, with prefixes, scopes, environment and last-used times.
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/keys" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/keysprovisionRotate or revoke the calling key
Rotation returns a new key immediately and expires the current one after an overlap window, so there is no downtime.
JSON body required
actionstringrequiredrotaterevokeoverlap_minutesintegeroptionalOverlap window when rotating the calling key.
min 0 · max 10080
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/keys" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"action": "rotate",
"overlap_minutes": 60
}'200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/webhooksreadList webhooks and recent deliveries
Shows endpoints, subscribed events and the last 50 delivery attempts.
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/webhooks" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/webhooksprovisionCreate, update or delete a webhook
Deliveries are signed with HMAC-SHA256 over ${t}.${rawBody} and sent as dossier-signature: t=<unix>,v1=<hex>. Failed deliveries retry with exponential backoff up to six times.
JSON body required
Body option 1
Create a webhook. Its secret is returned once. Use a public HTTPS URL on port 443.
urlstringrequireduri · max 500 characters
eventsstring[]optionalDefaults to all events. GET this endpoint for available_events.
max 20 items
descriptionstringoptionalmax 200 characters
Body option 2
Update or delete an existing webhook. A valid id selects this branch before creation is considered.
idstringrequireduuid
activebooleanoptionaleventsstring[]optionalmax 20 items
deletebooleanoptionalSet true to delete this webhook.
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/webhooks" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"url": "https://example.com/webhooks/dossier",
"events": [
"*"
],
"description": "Customer workspace updates"
}'200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/billingreadCurrent and previous period statements
Usage is metered continuously and priced with the partner rate card. Demo invoices are never charged. Unavailable billing returns JSON 503, not a zero balance.
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Billing could not be verified (billing_unavailable).
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/billing" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/billingprovisionIssue a statement for a period
Finalizes a closed period as an invoice. In live billing mode the same statement is sent to Stripe. The current month (months_ago: 0) can only be previewed with finalize: false; attempting to finalize it returns JSON 422 (billing_period_open). Malformed JSON returns 400. An unavailable invoice outcome returns JSON 503 (billing_unavailable); read billing state before retrying the same period.
JSON body
months_agointegeroptionalmin 0 · max 24 · default 1
finalizebooleanoptionalFinalizes a closed period when true. Sandbox partner keys cannot finalize invoices. Use false for an unsaved preview; previews do not emit invoice-created webhooks.
default true
Responses
- 200
- Success.
- 400
- Malformed JSON (invalid_json); no invoice was issued.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After. - 503
- Invoice outcome is unverified (billing_unavailable). Read billing before retrying the same period.
curl --fail-with-body -X POST "https://dossierplus.ai/api/public/v1/partner/billing" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY" \
-H "Content-Type: application/json" \
--data '{
"months_ago": 1,
"finalize": false
}'200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object
/partner/healthreadAPI health and version policy
Availability, error rate and p50/p95 latency for the partner surface over the requested window, plus the supported API versions and sunset policy.
Query parameters
minutesnumberoptionalMetrics window, clamped to 5–1440 minutes.
min 5 · max 1440 · default 60
Responses
- 200
- Success.
- 401
- Missing, malformed, expired or revoked token.
- 403
- The token lacks the required scope.
- 422
- The request body failed validation.
- 429
- Rate limit exceeded. Retry after the number of seconds in
Retry-After.
curl --fail-with-body -X GET "https://dossierplus.ai/api/public/v1/partner/health" \
-H "Authorization: Bearer $DOSSIER_PARTNER_KEY"200 · Response
Success.
Returned under data, with meta where provided.
Response schema
object