ComplianceReporter

SIP Protocol API Reference / ComplianceReporter

Class: ComplianceReporter

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:6982

ComplianceReporter - Generates audit reports from encrypted transactions

Example

const reporter = new ComplianceReporter()

const report = await reporter.generateAuditReport({
  viewingKey: myViewingKey,
  transactions: encryptedTransactions,
  startDate: new Date('2025-01-01'),
  endDate: new Date('2025-12-31'),
  format: 'json',
})

console.log(`Report contains ${report.summary.transactionCount} transactions`)
console.log(`Total volume: ${report.summary.totalVolume}`)

Constructors

Constructor

new ComplianceReporter(): ComplianceReporter

Returns

ComplianceReporter

Methods

generateAuditReport()

generateAuditReport(params): Promise<AuditReport>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:6994

Generate an audit report from encrypted transactions

Decrypts transactions using the provided viewing key, filters by date range, and generates a comprehensive report with summary statistics.

Parameters

params

GenerateAuditReportParams

Report generation parameters

Returns

Promise<AuditReport>

Audit report with decrypted transactions and statistics

Throws

If parameters are invalid

Throws

If decryption fails

exportToPdf()

exportToPdf(report, options?): Uint8Array

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:7039

Export audit report to PDF format

Generates a professionally formatted PDF document from an audit report. Works in both Node.js and browser environments.

Parameters

report

AuditReport

The audit report to export

options?

PdfExportOptions

PDF export options

Returns

Uint8Array

PDF document as Uint8Array

Example

const reporter = new ComplianceReporter()
const report = await reporter.generateAuditReport({...})

const pdfBytes = reporter.exportToPdf(report, {
  title: 'Q1 2025 Audit Report',
  organization: 'ACME Corp',
})

// Save to file (Node.js)
fs.writeFileSync('report.pdf', pdfBytes)

exportForRegulator()

exportForRegulator(params): Promise<RegulatoryExport>

Defined in: @sip-protocol/sdk/dist/index-CzWPI6Le.d.ts:7083

Export transactions to regulatory compliance formats

Decrypts and exports transactions in formats required by regulators:

FATF: Financial Action Task Force Travel Rule format
FINCEN: FinCEN Suspicious Activity Report (SAR) format
CSV: Generic comma-separated values format

Parameters

params

ExportForRegulatorParams

Export parameters

Returns

Promise<RegulatoryExport>

Regulatory export in the specified format

Throws

If parameters are invalid

Throws

If decryption fails

Example

const reporter = new ComplianceReporter()

// FATF Travel Rule export
const fatfExport = await reporter.exportForRegulator({
  viewingKey: myViewingKey,
  transactions: encryptedTxs,
  jurisdiction: 'EU',
  format: 'FATF',
  currency: 'EUR',
})

// FINCEN SAR export (US only)
const fincenExport = await reporter.exportForRegulator({
  viewingKey: myViewingKey,
  transactions: suspiciousTxs,
  jurisdiction: 'US',
  format: 'FINCEN',
})

// CSV export
const csvExport = await reporter.exportForRegulator({
  viewingKey: myViewingKey,
  transactions: encryptedTxs,
  jurisdiction: 'SG',
  format: 'CSV',
})