ComplianceManager
SIP Protocol API Reference v0.7.4
SIP Protocol API Reference / ComplianceManager
Class: ComplianceManager
Section titled “Class: ComplianceManager”Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9722
ComplianceManager - Enterprise compliance and auditing
Accessors
Section titled “Accessors”organizationId
Section titled “organizationId”Get Signature
Section titled “Get Signature”get organizationId():
string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9738
Returns
Section titled “Returns”string
organizationName
Section titled “organizationName”Get Signature
Section titled “Get Signature”get organizationName():
string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9739
Returns
Section titled “Returns”string
masterViewingKey
Section titled “masterViewingKey”Get Signature
Section titled “Get Signature”get masterViewingKey():
ViewingKey
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9740
Returns
Section titled “Returns”Methods
Section titled “Methods”create()
Section titled “create()”
staticcreate(params):Promise<ComplianceManager>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9733
Create a new compliance manager
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<ComplianceManager>
fromConfig()
Section titled “fromConfig()”
staticfromConfig(config):ComplianceManager
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9737
Load from existing config
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”ComplianceManager
getConfig()
Section titled “getConfig()”getConfig():
ComplianceConfig
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9741
Returns
Section titled “Returns”registerAuditor()
Section titled “registerAuditor()”registerAuditor(
params,registeredBy):Promise<AuditorRegistration>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9745
Register a new auditor
Parameters
Section titled “Parameters”params
Section titled “params”registeredBy
Section titled “registeredBy”string
Returns
Section titled “Returns”Promise<AuditorRegistration>
getAuditor()
Section titled “getAuditor()”getAuditor(
auditorId):AuditorRegistration|undefined
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9749
Get an auditor by ID
Parameters
Section titled “Parameters”auditorId
Section titled “auditorId”string
Returns
Section titled “Returns”AuditorRegistration | undefined
getAllAuditors()
Section titled “getAllAuditors()”getAllAuditors():
AuditorRegistration[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9753
Get all auditors
Returns
Section titled “Returns”getActiveAuditors()
Section titled “getActiveAuditors()”getActiveAuditors():
AuditorRegistration[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9757
Get active auditors
Returns
Section titled “Returns”deactivateAuditor()
Section titled “deactivateAuditor()”deactivateAuditor(
auditorId,deactivatedBy,reason):AuditorRegistration
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9761
Deactivate an auditor
Parameters
Section titled “Parameters”auditorId
Section titled “auditorId”string
deactivatedBy
Section titled “deactivatedBy”string
reason
Section titled “reason”string
Returns
Section titled “Returns”updateAuditorScope()
Section titled “updateAuditorScope()”updateAuditorScope(
auditorId,scope,updatedBy):AuditorRegistration
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9765
Update auditor scope
Parameters
Section titled “Parameters”auditorId
Section titled “auditorId”string
updatedBy
Section titled “updatedBy”string
Returns
Section titled “Returns”discloseTransaction()
Section titled “discloseTransaction()”discloseTransaction(
payment,auditorId,viewingKey,disclosedBy,additionalInfo?):DisclosedTransaction
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9775
Disclose a transaction to an auditor
Parameters
Section titled “Parameters”payment
Section titled “payment”The shielded payment to disclose
auditorId
Section titled “auditorId”string
The auditor to disclose to
viewingKey
Section titled “viewingKey”The viewing key to decrypt the payment
disclosedBy
Section titled “disclosedBy”string
Who authorized the disclosure
additionalInfo?
Section titled “additionalInfo?”txHash?
Section titled “txHash?”string
blockNumber?
Section titled “blockNumber?”number
riskScore?
Section titled “riskScore?”number
riskFlags?
Section titled “riskFlags?”string[]
notes?
Section titled “notes?”string
string[]
Returns
Section titled “Returns”The disclosed transaction
getDisclosedTransactions()
Section titled “getDisclosedTransactions()”getDisclosedTransactions(
auditorId?):DisclosedTransaction[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9786
Get disclosed transactions for an auditor
Parameters
Section titled “Parameters”auditorId?
Section titled “auditorId?”string
Returns
Section titled “Returns”getDisclosedTransaction()
Section titled “getDisclosedTransaction()”getDisclosedTransaction(
disclosureId):DisclosedTransaction|undefined
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9790
Get a disclosed transaction by ID
Parameters
Section titled “Parameters”disclosureId
Section titled “disclosureId”string
Returns
Section titled “Returns”DisclosedTransaction | undefined
createDisclosureRequest()
Section titled “createDisclosureRequest()”createDisclosureRequest(
transactionId,auditorId,reason):DisclosureRequest
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9794
Create a disclosure request
Parameters
Section titled “Parameters”transactionId
Section titled “transactionId”string
auditorId
Section titled “auditorId”string
reason
Section titled “reason”string
Returns
Section titled “Returns”approveDisclosureRequest()
Section titled “approveDisclosureRequest()”approveDisclosureRequest(
requestId,approvedBy):DisclosureRequest
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9798
Approve a disclosure request
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
approvedBy
Section titled “approvedBy”string
Returns
Section titled “Returns”denyDisclosureRequest()
Section titled “denyDisclosureRequest()”denyDisclosureRequest(
requestId,deniedBy,reason):DisclosureRequest
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9802
Deny a disclosure request
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
deniedBy
Section titled “deniedBy”string
reason
Section titled “reason”string
Returns
Section titled “Returns”getPendingRequests()
Section titled “getPendingRequests()”getPendingRequests():
DisclosureRequest[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9806
Get pending disclosure requests
Returns
Section titled “Returns”generateReport()
Section titled “generateReport()”generateReport(
params,requestedBy):Promise<ComplianceReport>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9810
Generate a compliance report
Parameters
Section titled “Parameters”params
Section titled “params”requestedBy
Section titled “requestedBy”string
Returns
Section titled “Returns”Promise<ComplianceReport>
getReport()
Section titled “getReport()”getReport(
reportId):ComplianceReport|undefined
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9814
Get a report by ID
Parameters
Section titled “Parameters”reportId
Section titled “reportId”string
Returns
Section titled “Returns”ComplianceReport | undefined
getAllReports()
Section titled “getAllReports()”getAllReports():
ComplianceReport[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9818
Get all reports
Returns
Section titled “Returns”getAuditorList()
Section titled “getAuditorList()”getAuditorList():
AuditorRegistration[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9827
Get list of auditors for dashboard UI
Returns a simplified view of auditors with essential info. Alias for getAllAuditors() but returns AuditorRegistration directly.
Returns
Section titled “Returns”Array of auditor registrations
getPendingDisclosures()
Section titled “getPendingDisclosures()”getPendingDisclosures():
DisclosureRequest[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9836
Get pending disclosure requests for dashboard
Returns disclosure requests waiting for approval/denial. This is for disclosure REQUESTS, not disclosed transactions.
Returns
Section titled “Returns”Array of pending disclosure requests
getDisclosureHistory()
Section titled “getDisclosureHistory()”getDisclosureHistory(
auditorId):DisclosedTransaction[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9846
Get disclosure history for a specific auditor
Returns all disclosed transactions that were shared with this auditor, sorted by disclosure date (most recent first).
Parameters
Section titled “Parameters”auditorId
Section titled “auditorId”string
Auditor ID to get history for
Returns
Section titled “Returns”Array of disclosed transactions for this auditor
getComplianceMetrics()
Section titled “getComplianceMetrics()”getComplianceMetrics():
ComplianceMetrics
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9859
Get compliance metrics for dashboard
Calculates key compliance metrics including:
- Total auditors (active + inactive)
- Total disclosures made
- Pending disclosure requests
- Approval rate (approved / total resolved requests)
- Average processing time for disclosure requests
Returns
Section titled “Returns”ComplianceMetrics
Compliance metrics object
getAuditLog()
Section titled “getAuditLog()”getAuditLog(
options?):AuditLogEntry[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9863
Get audit log entries
Parameters
Section titled “Parameters”options?
Section titled “options?”startDate?
Section titled “startDate?”number
endDate?
Section titled “endDate?”number
actor?
Section titled “actor?”string
action?
Section titled “action?”"auditor_registered" | "auditor_deactivated" | "transaction_disclosed" | "report_generated" | "disclosure_requested" | "disclosure_approved" | "disclosure_denied" | "config_updated"
limit?
Section titled “limit?”number
Returns
Section titled “Returns”exportToCSV()
Section titled “exportToCSV()”exportToCSV(
auditorId?):string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9873
Export transactions to CSV
Parameters
Section titled “Parameters”auditorId?
Section titled “auditorId?”string
Returns
Section titled “Returns”string
exportToJSON()
Section titled “exportToJSON()”exportToJSON(
auditorId?):string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9877
Export transactions to JSON
Parameters
Section titled “Parameters”auditorId?
Section titled “auditorId?”string
Returns
Section titled “Returns”string
toJSON()
Section titled “toJSON()”toJSON():
string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9881
Serialize to JSON
Returns
Section titled “Returns”string
fromJSON()
Section titled “fromJSON()”
staticfromJSON(json):ComplianceManager
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:9885
Deserialize from JSON
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ComplianceManager