Check a document against a regulation

curl --request POST \
  --url https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "documentText": "MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.",
  "regulationType": "ccpa"
}
EOF

import requests

url = "https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks"

payload = {
    "documentText": "MASTER SERVICES AGREEMENT

This Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.

8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.

12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.",
    "regulationType": "ccpa"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    documentText: 'MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier\'s total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.',
    regulationType: 'ccpa'
  })
};

fetch('https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks"

	payload := strings.NewReader("{\n  \"documentText\": \"MASTER SERVICES AGREEMENT\\n\\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\\n\\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\\n\\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.\",\n  \"regulationType\": \"ccpa\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "type": "matrix.run",
  "status": "succeeded",
  "createdAt": "2026-08-19T14:32:10Z",
  "completedAt": "2026-08-19T14:32:10Z",
  "matterId": "mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "resource": {
    "kind": "matrix",
    "id": "mtx_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
    "url": "https://storage.vaquill.ai/exports/msa-acme-v3-redline.docx?signature=..."
  },
  "progress": {
    "done": 24,
    "total": 128,
    "unit": "cells"
  },
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "type": "<string>"
    }
  ],
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

POST

matters

{matterId}

compliance-checks

Check a document against a regulation

curl --request POST \
  --url https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "documentText": "MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.",
  "regulationType": "ccpa"
}
EOF

import requests

url = "https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks"

payload = {
    "documentText": "MASTER SERVICES AGREEMENT

This Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.

8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.

12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.",
    "regulationType": "ccpa"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    documentText: 'MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier\'s total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.',
    regulationType: 'ccpa'
  })
};

fetch('https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vaquill.ai/workspace/v1/matters/{matterId}/compliance-checks"

	payload := strings.NewReader("{\n  \"documentText\": \"MASTER SERVICES AGREEMENT\\n\\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\\n\\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\\n\\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware.\",\n  \"regulationType\": \"ccpa\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "type": "matrix.run",
  "status": "succeeded",
  "createdAt": "2026-08-19T14:32:10Z",
  "completedAt": "2026-08-19T14:32:10Z",
  "matterId": "mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "resource": {
    "kind": "matrix",
    "id": "mtx_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
    "url": "https://storage.vaquill.ai/exports/msa-acme-v3-redline.docx?signature=..."
  },
  "progress": {
    "done": 24,
    "total": 128,
    "unit": "cells"
  },
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "type": "<string>"
    }
  ],
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

{
  "type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "This credential carries matters:read. This operation needs matters:write.",
  "instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
  "requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}

Authorizations

Authorization

string

header

required

Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.

Headers

Idempotency-Key

string | null

A unique value of your choosing, so a retried launch returns the FIRST operation instead of starting a second billable job. Reusing one with a different body is refused. Retrying with the same key and the same body is free and is the intended way to recover from a timeout.

Path Parameters

matterId

string

required

mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.

Body

application/json

Check one document against one regulation.

documentText

string

required

The full document text to check, 100 to 200,000 characters.

Required string length: 100 - 200000

Example:

"MASTER SERVICES AGREEMENT\n\nThis Master Services Agreement is entered into as of 1 September 2026 between Acme Corporation, a Delaware corporation, and the Supplier identified on the signature page.\n\n8. LIMITATION OF LIABILITY. Supplier's total liability shall be unlimited for any claim arising out of this Agreement.\n\n12. GOVERNING LAW. This Agreement is governed by the laws of the State of Delaware."

regulationType

enum<string>

required

Which regulation to check against. Only regulations with a full requirement checklist are accepted; anything else would produce a generic answer that reads like a real one.

Available options:

ccpa,

dora,

dpdp,

ferpa,

gdpr,

glba,

hipaa,

lgpd,

nis2,

pci_dss,

sox,

soc2,

tcpa,

uk_gdpr

Example:

"ccpa"

documentCategory

enum<string>

default:other

What kind of document this is. Sharpens which requirements apply; other is a real answer rather than a degraded one.

Available options:

business_continuity_plan,

consent_form,

data_breach_plan,

dpa,

dsr_process,

financial_report,

ict_risk_policy,

incident_response_plan,

information_security_policy,

other,

privacy_policy,

terms_of_service,

vendor_agreement

Example:

"business_continuity_plan"

context

string | null

Anything else that changes which requirements bite: the industry, the data types processed, the jurisdictions involved.

Maximum string length: 2000

Example:

"Cloud vendor processing electronic protected health information for a covered entity in California."

Response

Successful Response

One long-running operation, whatever kind of work it is.

Readable for OPERATION_RETENTION_DAYS after creation, per AIP-151.

string

required

Public identifier, op_ followed by 32 hex characters. Poll GET /v1/operations/{operationId} with it.

Example:

"op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

type

string

required

What kind of work this is, for example matrix.run or draft.generate.

Example:

"matrix.run"

status

enum<string>

required

One of five values: queued, running, succeeded, failed, cancelled. There is no sixth and there are no synonyms. Stop polling once it is succeeded, failed or cancelled.

Available options:

queued,

running,

succeeded,

failed,

cancelled

Example:

"succeeded"

createdAt

string<date-time>

required

When the operation was accepted (RFC 3339).

Example:

"2026-08-19T14:32:10Z"

completedAt

string<date-time> | null

When the operation reached a terminal status (RFC 3339). Present if and only if the status is terminal.

Example:

"2026-08-19T14:32:10Z"

matterId

string | null

mat_ identifier of the matter this work belongs to, when it belongs to one.

Example:

"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

resource

OperationResource · object | null

What the operation produced. Absent until the underlying job row exists, which an idempotent replay can briefly observe, so treat absence as 'not yet' rather than 'never'.

Show child attributes

error

OperationError · object | null

Why the work failed. Present only when status is failed. Partial success is succeeded with progress.done < progress.total, never an error.

Show child attributes

progress

OperationProgress · object | null

How far along the work is, when the underlying job reports it. Absent does not mean no progress.

Show child attributes

requestId

string | null

The X-Request-ID of the request that created this operation. Quote it in a support ticket.

Example:

"req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"

Last modified on August 23, 2026

Chronology

Research

Clients

Comparisons

Compliance

Documents

Drafting

Facts

Folders

Matrices

Matter summary

Matters

NDA triage

Operations

Playbooks

Reviews

Uploads

Workflows

Check a document against a regulation

Authorizations

Headers

Path Parameters

Body

Response