Documentation

---

Documentation / @u-net/contracts / operations

Interface: operations

Defined in: unet-public-api-v2.d.ts:266

Properties

createVerificationSession

createVerificationSession: object

Defined in: unet-public-api-v2.d.ts:336

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

requestBody

requestBody: object

requestBody.content

content: object

requestBody.content.application/json

application/json: object

requestBody.content.application/json.requestedChecks?

optional requestedChecks?: object[]

requestBody.content.application/json.requestType?

optional requestType?: string

requestBody.content.application/json.verifierDisplayName

verifierDisplayName: string

requestBody.content.application/json.verifierId

verifierId: string

responses

responses: object

responses.201

201: object

Hosted verifier session

responses.201.content

content: object

responses.201.content.application/json

application/json: object

responses.201.content.application/json.aggregateOutcome?

optional aggregateOutcome?: "passed" | "warning" | "failed"

Enum (unknown).

responses.201.content.application/json.expiresAt

expiresAt: string

Format: date-time

responses.201.content.application/json.qrPayload?

optional qrPayload?: string

responses.201.content.application/json.sessionId

sessionId: string

responses.201.content.application/json.sessionRef?

optional sessionRef?: 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:365

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path

path: object

parameters.path.sessionId

sessionId: string

parameters.query?

optional query?: undefined

requestBody?

optional requestBody?: undefined

responses

responses: object

responses.200

200: object

Verifier result

responses.200.content

content: object

responses.200.content.application/json

application/json: object

responses.200.content.application/json.aggregateOutcome?

optional aggregateOutcome?: "passed" | "warning" | "failed"

Enum (unknown).

responses.200.content.application/json.expiresAt

expiresAt: string

Format: date-time

responses.200.content.application/json.qrPayload?

optional qrPayload?: string

responses.200.content.application/json.sessionId

sessionId: string

responses.200.content.application/json.sessionRef?

optional sessionRef?: 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:290

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

requestBody?

optional requestBody?: undefined

responses

responses: object

responses.200

200: object

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 value.

responses.200.headers

headers: object

Index Signature

[name: string]: unknown

---

listVerificationChecks

listVerificationChecks: object

Defined in: unet-public-api-v2.d.ts:314

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

requestBody?

optional requestBody?: undefined

responses

responses: object

responses.200

200: object

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

---

reconcileLedgerV2Anchor

reconcileLedgerV2Anchor: object

Defined in: unet-public-api-v2.d.ts:436

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: undefined

requestBody

requestBody: object

requestBody.content

content: object

requestBody.content.application/json

application/json: object

requestBody.content.application/json.candidateTransactionHash?

optional candidateTransactionHash?: string

Optional known transaction. Otherwise the disposable index supplies a candidate, never proof.

requestBody.content.application/json.chainId

chainId: number

requestBody.content.application/json.ledgerAddress

ledgerAddress: string

requestBody.content.application/json.operation

operation: object

requestBody.content.application/json.operation.attestationHash

attestationHash: string

requestBody.content.application/json.operation.deadline

deadline: number

Original signed Unix deadline. It may now be expired if the transaction was included in time.

requestBody.content.application/json.operation.holderRevocationSigner

holderRevocationSigner: string

requestBody.content.application/json.operation.issuerIdHash

issuerIdHash: string

requestBody.content.application/json.operation.issuerKeyEpoch

issuerKeyEpoch: number

requestBody.content.application/json.operation.nonce

nonce: string

Canonical decimal uint256, no greater than 2^256-1.

requestBody.content.application/json.operation.requestIdHash

requestIdHash: string

requestBody.content.application/json.requiredConfirmations

requiredConfirmations: number

Cannot lower the gateway confirmation floor.

requestBody.content.application/json.signature

signature: string

responses

responses: object

responses.200

200: object

Exact anchor evidence confirmed at the returned canonical head

responses.200.content

content: object

responses.200.content.application/json

application/json: object

responses.200.content.application/json.protocolVersion

protocolVersion: 2

Constant value.

responses.200.content.application/json.receipt

receipt: object

responses.200.content.application/json.receipt.attestationHash

attestationHash: string

responses.200.content.application/json.receipt.blockHash

blockHash: string

responses.200.content.application/json.receipt.blockNumber

blockNumber: number

responses.200.content.application/json.receipt.chainId

chainId: number

responses.200.content.application/json.receipt.checkedHeadHash

checkedHeadHash: string

responses.200.content.application/json.receipt.checkedHeadNumber

checkedHeadNumber: number

responses.200.content.application/json.receipt.confirmations

confirmations: number

responses.200.content.application/json.receipt.issuerIdHash

issuerIdHash: string

responses.200.content.application/json.receipt.ledgerAddress

ledgerAddress: string

responses.200.content.application/json.receipt.requiredConfirmations

requiredConfirmations: number

responses.200.content.application/json.receipt.status

status: "active"

Constant value.

responses.200.content.application/json.receipt.transactionHash

transactionHash: string

responses.200.content.application/json.status

status: "confirmed"

Constant value.

responses.200.content.application/json.success

success: true

Constant value.

responses.200.headers

headers: object

Index Signature

[name: string]: unknown

responses.202

202: object

Receipt/index pending, insufficient confirmations or detected reorg; preserve pending state

responses.202.content

content: object

responses.202.content.application/json

application/json: object

responses.202.content.application/json.protocolVersion

protocolVersion: 2

Constant value.

responses.202.content.application/json.reason

reason: "receipt_pending" | "insufficient_confirmations" | "reorg_detected"

Enum (unknown).

responses.202.content.application/json.status

status: "pending"

Constant value.

responses.202.content.application/json.success

success: true

Constant value.

responses.202.headers

headers: object

Index Signature

[name: string]: unknown

responses.400

400: object

Invalid request; no query parameters are accepted

responses.400.content?

optional content?: undefined

responses.400.headers

headers: object

Index Signature

[name: string]: unknown

responses.409

409: object

Exact operation evidence mismatch, reverted transaction or chain-revoked credential

responses.409.content

content: object

responses.409.content.application/json

application/json: object

responses.409.content.application/json.error

error: "ledger_v2_anchor_evidence_mismatch" | "ledger_v2_anchor_transaction_failed" | "ledger_v2_attestation_revoked"

Enum (unknown).

responses.409.content.application/json.success

success: false

Constant value.

responses.409.headers

headers: object

Index Signature

[name: string]: unknown

responses.413

413: object

Request exceeds 4096 bytes

responses.413.content?

optional content?: undefined

responses.413.headers

headers: object

Index Signature

[name: string]: unknown

responses.429

429: object

Gateway concurrency limit; retry later without changing credential lifecycle

responses.429.content?

optional content?: undefined

responses.429.headers

headers: object

Index Signature

[name: string]: unknown

responses.503

503: object

Dependency unavailable, timeout or unknown current chain state; preserve pending state

responses.503.content?

optional content?: undefined

responses.503.headers

headers: object

Index Signature

[name: string]: unknown

---

resolveLedgerV2Attestation

resolveLedgerV2Attestation: object

Defined in: unet-public-api-v2.d.ts:387

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path

path: object

parameters.path.commitment

commitment: string

parameters.query?

optional query?: undefined

requestBody?

optional requestBody?: undefined

responses

responses: object

responses.200

200: object

Exact on-chain lifecycle status

responses.200.content

content: object

responses.200.content.application/json

application/json: object

responses.200.content.application/json.anchorBlockNumber?

optional anchorBlockNumber?: number

responses.200.content.application/json.attestationHash

attestationHash: string

responses.200.content.application/json.issuerIdHash?

optional issuerIdHash?: string

responses.200.content.application/json.revokeBlockNumber?

optional revokeBlockNumber?: number

responses.200.content.application/json.status

status: "active" | "revoked" | "unknown"

Enum (unknown).

responses.200.content.application/json.success

success: true

Constant value.

responses.200.headers

headers: object

Index Signature

[name: string]: unknown

---

resolveService

resolveService: object

Defined in: unet-public-api-v2.d.ts:267

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query

query: object

parameters.query.origin

origin: string

parameters.query.serviceId

serviceId: string

requestBody?

optional requestBody?: undefined

responses

responses: object

responses.200

200: object

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"

Enum (unknown).

responses.200.content.application/json.service.accountPolicy.policyVersion

policyVersion: 2

Constant value.

responses.200.content.application/json.service.endpoints

endpoints: object

Index Signature

[key: string]: string

responses.200.content.application/json.service.name?

optional name?: string

responses.200.content.application/json.service.origin

origin: string

Format: uri

responses.200.content.application/json.service.provider?

optional provider?: string

responses.200.content.application/json.service.serviceId

serviceId: string

responses.200.content.application/json.service.status

status: "active"

Constant value.

responses.200.content.application/json.success

success: true

Constant value.

responses.200.headers

headers: object

Index Signature

[name: string]: unknown

---

submitHolderRevocation

submitHolderRevocation: object

Defined in: unet-public-api-v2.d.ts:409

parameters

parameters: object

parameters.cookie?

optional cookie?: undefined

parameters.header?

optional header?: undefined

parameters.path?

optional path?: undefined

parameters.query?

optional query?: 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

Signed operation accepted by relayer

responses.202.content?

optional content?: undefined

responses.202.headers

headers: object

Index Signature

[name: string]: unknown