Documentation / @u-net/contracts / operations
Interface: operations
Defined in: unet-public-api-v2.d.ts:191
Properties
createVerificationSession
createVerificationSession:
object
Defined in: unet-public-api-v2.d.ts:261
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path?
optionalpath?:undefined
parameters.query?
optionalquery?:undefined
requestBody
requestBody:
object
requestBody.content
content:
object
requestBody.content.application/json
application/json:
object
requestBody.content.application/json.requestedChecks?
optionalrequestedChecks?:object[]
requestBody.content.application/json.requestType?
optionalrequestType?:string
requestBody.content.application/json.verifierDisplayName
verifierDisplayName:
string
requestBody.content.application/json.verifierId
verifierId:
string
responses
responses:
object
responses.201
201:
object
Description
Hosted verifier session
responses.201.content
content:
object
responses.201.content.application/json
application/json:
object
responses.201.content.application/json.aggregateOutcome?
optionalaggregateOutcome?:"passed"|"warning"|"failed"
responses.201.content.application/json.expiresAt
expiresAt:
string
Format: date-time
responses.201.content.application/json.qrPayload?
optionalqrPayload?:string
responses.201.content.application/json.sessionId
sessionId:
string
responses.201.content.application/json.sessionRef?
optionalsessionRef?:string
responses.201.content.application/json.status
status:
string
responses.201.headers
headers:
object
Index Signature
[name: string]: unknown
getVerificationSession
getVerificationSession:
object
Defined in: unet-public-api-v2.d.ts:290
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path
path:
object
parameters.path.sessionId
sessionId:
string
parameters.query?
optionalquery?:undefined
requestBody?
optionalrequestBody?:undefined
responses
responses:
object
responses.200
200:
object
Description
Verifier result
responses.200.content
content:
object
responses.200.content.application/json
application/json:
object
responses.200.content.application/json.aggregateOutcome?
optionalaggregateOutcome?:"passed"|"warning"|"failed"
responses.200.content.application/json.expiresAt
expiresAt:
string
Format: date-time
responses.200.content.application/json.qrPayload?
optionalqrPayload?:string
responses.200.content.application/json.sessionId
sessionId:
string
responses.200.content.application/json.sessionRef?
optionalsessionRef?:string
responses.200.content.application/json.status
status:
string
responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
listMiniPrograms
listMiniPrograms:
object
Defined in: unet-public-api-v2.d.ts:215
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path?
optionalpath?:undefined
parameters.query?
optionalquery?:undefined
requestBody?
optionalrequestBody?:undefined
responses
responses:
object
responses.200
200:
object
Description
Catalog page
responses.200.content
content:
object
responses.200.content.application/json
application/json:
object
responses.200.content.application/json.programs
programs:
object[]
responses.200.content.application/json.success
success:
true
Constant
responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
listVerificationChecks
listVerificationChecks:
object
Defined in: unet-public-api-v2.d.ts:239
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path?
optionalpath?:undefined
parameters.query?
optionalquery?:undefined
requestBody?
optionalrequestBody?:undefined
responses
responses:
object
responses.200
200:
object
Description
Verification check catalog
responses.200.content
content:
object
responses.200.content.application/json
application/json:
object
responses.200.content.application/json.checks
checks:
object[]
responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
resolveLedgerV2Attestation
resolveLedgerV2Attestation:
object
Defined in: unet-public-api-v2.d.ts:312
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path
path:
object
parameters.path.commitment
commitment:
string
parameters.query?
optionalquery?:undefined
requestBody?
optionalrequestBody?:undefined
responses
responses:
object
responses.200
200:
object
Description
Exact on-chain lifecycle status
responses.200.content
content:
object
responses.200.content.application/json
application/json:
object
responses.200.content.application/json.anchorBlockNumber?
optionalanchorBlockNumber?:number
responses.200.content.application/json.attestationHash
attestationHash:
string
responses.200.content.application/json.issuerIdHash?
optionalissuerIdHash?:string
responses.200.content.application/json.revokeBlockNumber?
optionalrevokeBlockNumber?:number
responses.200.content.application/json.status
status:
"active"|"revoked"|"unknown"
responses.200.content.application/json.success
success:
true
Constant
responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
resolveService
resolveService:
object
Defined in: unet-public-api-v2.d.ts:192
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path?
optionalpath?:undefined
parameters.query
query:
object
parameters.query.origin
origin:
string
parameters.query.serviceId
serviceId:
string
requestBody?
optionalrequestBody?:undefined
responses
responses:
object
responses.200
200:
object
Description
Verified service metadata
responses.200.content
content:
object
responses.200.content.application/json
application/json:
object
responses.200.content.application/json.registryRevision
registryRevision:
string
responses.200.content.application/json.service
service:
object
responses.200.content.application/json.service.accountPolicy
accountPolicy:
object
responses.200.content.application/json.service.accountPolicy.maxAccounts
maxAccounts:
number
responses.200.content.application/json.service.accountPolicy.mode
mode:
"single"|"multiple"
responses.200.content.application/json.service.accountPolicy.policyVersion
policyVersion:
2
Constant
responses.200.content.application/json.service.endpoints
endpoints:
object
Index Signature
[key: string]: string
responses.200.content.application/json.service.name?
optionalname?:string
responses.200.content.application/json.service.origin
origin:
string
Format: uri
responses.200.content.application/json.service.provider?
optionalprovider?:string
responses.200.content.application/json.service.serviceId
serviceId:
string
responses.200.content.application/json.service.status
status:
"active"
Constant
responses.200.content.application/json.success
success:
true
Constant
responses.200.headers
headers:
object
Index Signature
[name: string]: unknown
submitHolderRevocation
submitHolderRevocation:
object
Defined in: unet-public-api-v2.d.ts:334
parameters
parameters:
object
parameters.cookie?
optionalcookie?:undefined
parameters.header?
optionalheader?:undefined
parameters.path?
optionalpath?:undefined
parameters.query?
optionalquery?:undefined
requestBody
requestBody:
object
requestBody.content
content:
object
requestBody.content.application/json
application/json:
object
requestBody.content.application/json.operation
operation:
object
Index Signature
[key: string]: unknown
requestBody.content.application/json.signature
signature:
string
responses
responses:
object
responses.202
202:
object
Description
Signed operation accepted by relayer
responses.202.content?
optionalcontent?:undefined
responses.202.headers
headers:
object
Index Signature
[name: string]: unknown