Skip to main content
GET
Get compliance report

Authorizations

Authorization
string
header
required

API key starting with zt_live_ (production) or zt_test_ (sandbox). Get your key at https://developers.zebratruth.ai

Path Parameters

reportId
string
required

Response

Full compliance report

requestId
string

Identifier of this check, usable with GET /compliance/checks/{requestId} and in request logs.

reportId
string
Example:

"rpt_abc123"

score
integer
Required range: 0 <= x <= 100
Example:

72

decision
enum<string>
  • PUBLISH — Score 80-100, safe to publish
  • HOLD — Score 60-79, or any high-severity flag
  • BLOCK — Score 0-59, or any critical-severity check
Available options:
PUBLISH,
HOLD,
BLOCK
checks
object[]

All compliance findings. Each check has structured classification metadata (id, jurisdictions, platforms, scope, primaryCategory, categories) added inline. Combine bySeverity + byJurisdiction etc. via the indexes field for filtered views.

checksById
object

O(1) lookup map keyed by stable id. Same data as checks[], indexed for direct access (e.g. when resolving an annotation's checkId to its parent check).

indexes
object

Pre-computed reference indexes — pure ID lists, no content duplication. Tenants pick whichever organization fits their UI. Combine via set intersection (e.g., critical EU findings = bySeverity.critical ∩ byJurisdiction.eu). All seven dimensions always present; empty buckets are included so client code can do indexes.byJurisdiction.us ?? [] without optional-chaining on the bucket itself.

annotations
object[]
profile
object
agentSummaries
object
versionInfo
object
costBreakdown
object
creditsCharged
number

Credits debited for this request. 0 on a cache hit.

cached
boolean

true when the result was served from the response cache or an idempotent replay.

coverageIncomplete
boolean

true when at least one agent could not consult its legal corpus. Always equals coverageGaps.length > 0.

coverageGaps
object[]
analysisDiagnostics
object[]

Pipeline diagnostics that are not compliance findings.

regulatedActors
enum<string>[]

Present when the check was evaluated for specific regulated actors.

The regulated party a check is evaluating. Corpus rules tagged with an incompatible actor are excluded from asserted citations and cannot drive blocking findings.

Available options:
advertiser,
manufacturer,
platform,
provider,
payer,
pharmacy,
HCP,
telehealth_provider,
adviser,
broker_dealer,
bank,
lender,
servicer,
debt_collector,
fund_manager,
payment_service_provider,
insurer
agentsRun
object[]

One record per financial-services specialist selected for this check, with how it finished. Absent on checks that ran no specialist and on cached results produced before this field existed.

decisionReasons
enum<string>[]

Every rule that contributed to decision, in evaluation order. Present on checks that ran a financial-services specialist.

Why the decision is what it is. blocking_check: a blocking finding forced BLOCK. required_review_incomplete: a required specialist did not complete, so the check is HOLD. legal_context_overflow: the applicable rule set exceeded what one run can evaluate. flagged_check: a flagged finding produced HOLD.

Available options:
blocking_check,
required_review_incomplete,
legal_context_overflow,
flagged_check
_meta
object

Present only for test mode (zt_test_ keys)