ComplianceReport
SIP Protocol API Reference v0.7.0
SIP Protocol API Reference / ComplianceReport
Interface: ComplianceReport
Section titled “Interface: ComplianceReport”Defined in: @sip-protocol/types/dist/index.d.ts:1999
Compliance report
Properties
Section titled “Properties”reportId
Section titled “reportId”reportId:
string
Defined in: @sip-protocol/types/dist/index.d.ts:2001
Report ID
type:
ReportType
Defined in: @sip-protocol/types/dist/index.d.ts:2003
Report type
title:
string
Defined in: @sip-protocol/types/dist/index.d.ts:2005
Report title
description?
Section titled “description?”
optionaldescription:string
Defined in: @sip-protocol/types/dist/index.d.ts:2007
Description
format
Section titled “format”format:
ReportFormat
Defined in: @sip-protocol/types/dist/index.d.ts:2009
Report format
status
Section titled “status”status:
ReportStatusType
Defined in: @sip-protocol/types/dist/index.d.ts:2011
Status
generatedAt?
Section titled “generatedAt?”
optionalgeneratedAt:number
Defined in: @sip-protocol/types/dist/index.d.ts:2013
Generation timestamp
requestedBy
Section titled “requestedBy”requestedBy:
string
Defined in: @sip-protocol/types/dist/index.d.ts:2015
Requested by
requestedAt
Section titled “requestedAt”requestedAt:
number
Defined in: @sip-protocol/types/dist/index.d.ts:2017
Request timestamp
startDate
Section titled “startDate”startDate:
number
Defined in: @sip-protocol/types/dist/index.d.ts:2019
Start date
endDate
Section titled “endDate”endDate:
number
Defined in: @sip-protocol/types/dist/index.d.ts:2021
End date
chains
Section titled “chains”chains:
ChainId[]
Defined in: @sip-protocol/types/dist/index.d.ts:2023
Chains included
tokens
Section titled “tokens”tokens:
string[]
Defined in: @sip-protocol/types/dist/index.d.ts:2025
Tokens included
includeInbound
Section titled “includeInbound”includeInbound:
boolean
Defined in: @sip-protocol/types/dist/index.d.ts:2027
Include inbound transactions
includeOutbound
Section titled “includeOutbound”includeOutbound:
boolean
Defined in: @sip-protocol/types/dist/index.d.ts:2029
Include outbound transactions
optionaldata:ReportData
Defined in: @sip-protocol/types/dist/index.d.ts:2031
Report data (for JSON format)
content?
Section titled “content?”
optionalcontent:string
Defined in: @sip-protocol/types/dist/index.d.ts:2033
Report content (for CSV/PDF - base64 encoded)
error?
Section titled “error?”
optionalerror:string
Defined in: @sip-protocol/types/dist/index.d.ts:2035
Error message (if failed)