AttestationGatedConfig
SIP Protocol API Reference v0.7.4
SIP Protocol API Reference / AttestationGatedConfig
Interface: AttestationGatedConfig
Section titled “Interface: AttestationGatedConfig”Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10936
Configuration for attestation-gated disclosure
Properties
Section titled “Properties”masterViewingKey
Section titled “masterViewingKey”masterViewingKey:
ViewingKey
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10938
Master viewing key to derive auditor keys from
allowedSchemas?
Section titled “allowedSchemas?”
optionalallowedSchemas:string[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10940
Allowed attestation schemas (empty = all schemas)
allowedIssuers?
Section titled “allowedIssuers?”
optionalallowedIssuers:string[]
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10942
Allowed issuers (empty = all issuers)
verifyOnChain?
Section titled “verifyOnChain?”
optionalverifyOnChain:boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10944
Whether to verify attestations on-chain (default: false = API verification)
rangeApiEndpoint?
Section titled “rangeApiEndpoint?”
optionalrangeApiEndpoint:string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10946
Range API endpoint for verification
minAttestationAge?
Section titled “minAttestationAge?”
optionalminAttestationAge:number
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10948
Minimum attestation age in seconds (prevents replay attacks)
maxAttestationAge?
Section titled “maxAttestationAge?”
optionalmaxAttestationAge:number
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10950
Maximum attestation age in seconds (enforces time-bounded access, 0 = no limit)
maxCacheSize?
Section titled “maxCacheSize?”
optionalmaxCacheSize:number
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10952
Maximum number of cached derived keys (default: 1000)
customVerifier()?
Section titled “customVerifier()?”
optionalcustomVerifier: (attestation) =>Promise<boolean>
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:10954
Custom verification function
Parameters
Section titled “Parameters”attestation
Section titled “attestation”Returns
Section titled “Returns”Promise<boolean>