Run Your First Check

End to end in five minutes: get an API key, check a draft an agent has prepared, read the decision. The same call works for a customer notice, an advice letter, a promotion, a KYC message or ad copy.

1. Get your API key

export ZEBRATRUTH_API_KEY=zt_live_your_key_here

Test keys (zt_test_...) return deterministic sandbox responses and consume no credits. Use them for development and integration testing.

2. Validate your key

curl https://api.zebratruth.ai/v1/whoami \
  -H "Authorization: Bearer $ZEBRATRUTH_API_KEY"

Response

{
  "tenantId": "kp_a269d9695f734329a216669410731a21",
  "tier": "pro",
  "authType": "apikey",
  "scopes": ["compliance:check", "agents:*", "reports:read", "policies:read"]
}

3. Check a draft before it goes out

A US advisory agent has drafted an investment recommendation for a retail client. Submit it with the review scope that applies and say what kind of artifact it is.

curl -X POST https://api.zebratruth.ai/v1/compliance/check \
  -H "Authorization: Bearer $ZEBRATRUTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jurisdictions": ["us"],
    "platforms": ["linkedin"],
    "reviewScopes": ["advisory_suitability"],
    "contentKind": "advice_letter",
    "content": {
      "text": "Based on our review, we recommend moving 60% of your portfolio into the Apex Leveraged Growth Fund. It has returned 24% a year and is the best option for you."
    }
  }'

Response (trimmed)

{
  "requestId": "req_9f1c2e7a",
  "decision": "HOLD",
  "score": 46,
  "decisionReasons": ["flagged_check"],
  "agentsRun": [
    { "id": "fs-compliance-advisory-suitability", "outcome": "completed" }
  ],
  "checks": [
    {
      "checkName": "Suitability basis not documented",
      "status": "flag",
      "severity": "high",
      "primaryCategory": "consumer-information-disclosure",
      "message": "The recommendation to concentrate 60% of the portfolio in a single leveraged fund does not record the client's risk tolerance, time horizon or liquidity needs ...",
      "citation": "...",
      "recommendation": "Document the client profile the recommendation relies on and why the product fits it, disclose the leverage and concentration risks, and remove the implication that past returns will continue."
    }
  ],
  "cached": false
}

Three fields drive the workflow. decision is what the agent acts on: PUBLISH proceeds, HOLD routes to a person, BLOCK stops. decisionReasons lists every rule that produced it. agentsRun records which specialists ran and how each finished, which together with the findings is the audit record.

jurisdictions and platforms must be within the set your workspace subscribed to during onboarding; anything outside it returns 403. platforms is required on every request even when the artifact is not published to a platform. reviewScopes applies to workspaces on the financial-services industry; omit it elsewhere.

4. Check a document instead

Send a PDF or Word file as a multipart document part. It is extracted server-side and checked exactly like text.

curl -X POST https://api.zebratruth.ai/v1/compliance/check \
  -H "Authorization: Bearer $ZEBRATRUTH_API_KEY" \
  -F "document=@suitability-report.pdf" \
  -F "jurisdictions=us" \
  -F "platforms=linkedin" \
  -F "reviewScopes=advisory_suitability" \
  -F "contentKind=suitability_report" \
  -F "mode=fast"

To see the extracted text first, call POST /v1/compliance/documents/extract with the same document part. Extraction is not billed.

5. Choose how you want the answer

`responseMode`	Behaviour	Use when
`sync` (default)	Blocks until the report is ready, typically 15 to 120 seconds	One artifact at a time inside an agent step
`stream`	Server-sent events as each agent finishes	Showing progress to a reviewer
`async`	Returns a `jobId` immediately and POSTs the report to `webhookUrl`	Batches, long documents, video

Set client timeouts to at least 150 seconds for sync. See Streaming Integration and Async and Webhook Execution.

Images and video

Images go to POST /v1/compliance/check-image as a multipart image part and return synchronously with findings located by bounding box. Video is a three-step asynchronous flow: request an upload URL, upload the bytes, submit the check, then poll for timestamped findings. Both are covered in Images, Documents and Video and the video guide.

Next steps

Text and document checks

Every request field, response mode and error code.

Compliance agents

The specialists by industry, the review scopes, and how to read agentsRun.

Interpreting reports

Decisions, scores, severities, and how findings cite their evidence.

LLM skill installation

Give your own agents the ZebraTruth skill so they can run checks autonomously.

Getting Started

Running Checks

Concepts

LLM Skill

Text, Documents & Images

Quickstart

Run Your First Check

1. Get your API key

2. Validate your key

3. Check a draft before it goes out

4. Check a document instead

5. Choose how you want the answer

Images and video

Next steps

Text and document checks

Compliance agents

Interpreting reports

LLM skill installation

​Run Your First Check

​1. Get your API key

​2. Validate your key

​3. Check a draft before it goes out

​4. Check a document instead

​5. Choose how you want the answer

​Images and video

​Next steps

Text and document checks

Compliance agents

Interpreting reports

LLM skill installation

Run Your First Check

1. Get your API key

2. Validate your key

3. Check a draft before it goes out

4. Check a document instead

5. Choose how you want the answer

Images and video

Next steps