> ## Documentation Index
> Fetch the complete documentation index at: https://docs.grantex.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Compliance
> Generate compliance summaries, export grants and audit data, and produce evidence packs for SOC 2 and GDPR.
## Overview
The `compliance` sub-client provides tools for regulatory compliance: organization-wide summaries, bulk exports of grants and audit entries, and full evidence packs with chain integrity verification.
```typescript theme={null}
const summary = await grantex.compliance.getSummary();
console.log(summary.agents.active); // 12
console.log(summary.grants.active); // 1024
console.log(summary.auditEntries.total); // 50432
```
***
## compliance.getSummary()
Get an organization-wide compliance summary with aggregate counts for agents, grants, audit entries, and policies.
```typescript theme={null}
const summary = await grantex.compliance.getSummary({
since: '2026-01-01T00:00:00Z',
until: '2026-02-28T23:59:59Z',
});
console.log(summary.generatedAt); // '2026-02-28T12:00:00Z'
console.log(summary.agents.total); // 15
console.log(summary.agents.active); // 12
console.log(summary.agents.suspended); // 2
console.log(summary.agents.revoked); // 1
console.log(summary.grants.total); // 2048
console.log(summary.grants.active); // 1024
console.log(summary.grants.revoked); // 512
console.log(summary.grants.expired); // 512
console.log(summary.auditEntries.total); // 50432
console.log(summary.auditEntries.success); // 49000
console.log(summary.auditEntries.failure); // 1200
console.log(summary.auditEntries.blocked); // 232
console.log(summary.policies.total); // 8
console.log(summary.plan); // 'pro'
```
### Parameters
ISO 8601 start date for the summary window.
ISO 8601 end date for the summary window.
### Response: `ComplianceSummary`
ISO 8601 timestamp when the summary was generated.
Agent counts: `{ total, active, suspended, revoked }`.
Grant counts: `{ total, active, revoked, expired }`.
Audit entry counts: `{ total, success, failure, blocked }`.
Policy counts: `{ total }`.
The organization's current plan.
***
## compliance.exportGrants()
Export all grants, optionally filtered by status and date range.
```typescript theme={null}
const exported = await grantex.compliance.exportGrants({
status: 'active',
});
console.log(exported.generatedAt); // '2026-02-28T12:00:00Z'
console.log(exported.total); // 1024
console.log(exported.grants); // Grant[]
```
### Parameters
ISO 8601 start date filter.
ISO 8601 end date filter.
Filter by grant status.
### Response: `ComplianceGrantsExport`
ISO 8601 timestamp when the export was generated.
Total number of exported grants.
Array of grant objects.
***
## compliance.exportAudit()
Export all audit entries, optionally filtered by date range, agent, or status.
```typescript theme={null}
const exported = await grantex.compliance.exportAudit({
since: '2026-02-01T00:00:00Z',
agentId: 'ag_01HXYZ...',
});
console.log(exported.total); // 5432
console.log(exported.entries); // AuditEntry[]
```
### Parameters
ISO 8601 start date filter.
ISO 8601 end date filter.
Filter by agent ID.
Filter by action status.
### Response: `ComplianceAuditExport`
ISO 8601 timestamp when the export was generated.
Total number of exported entries.
Array of audit entry objects.
***
## compliance.evidencePack()
Generate a full evidence pack for compliance frameworks (SOC 2, GDPR, or both). Includes a summary, all grants, audit entries, policies, and chain integrity verification.
```typescript theme={null}
const pack = await grantex.compliance.evidencePack({
framework: 'soc2',
since: '2026-01-01T00:00:00Z',
});
console.log(pack.meta.schemaVersion); // '1.0'
console.log(pack.meta.framework); // 'soc2'
console.log(pack.summary.agents.total); // 15
console.log(pack.grants.length); // 2048
console.log(pack.auditEntries.length); // 50432
console.log(pack.policies.length); // 8
console.log(pack.chainIntegrity.valid); // true
console.log(pack.chainIntegrity.checkedEntries); // 50432
```
### Parameters
The compliance framework to generate evidence for. Defaults to `'all'`.
ISO 8601 start date for the evidence window.
ISO 8601 end date for the evidence window.
### Response: `EvidencePack`
Metadata: `{ schemaVersion, generatedAt, since?, until?, framework }`.
Aggregate counts for agents, grants, audit entries, policies, and plan.
All grants in the evidence window.
All audit entries in the evidence window.
All active policies.
Chain integrity verification result.
### ChainIntegrity
Whether the hash chain is intact.
Number of entries verified.
ISO 8601 timestamp of the first broken link, or `null` if the chain is intact.