U-net SDK 2.0.0-rc.3

Appearance

Documentation

Documentation / @u-net/contracts / paths

Interface: paths ​

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

This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

Properties ​

/v1/mini-programs ​

/v1/mini-programs: object

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

delete? ​

optional delete?: undefined

get ​

get: object

get.parameters ​

parameters: object

optional cookie?: undefined

get.parameters.header? ​

optional header?: undefined

get.parameters.path? ​

optional path?: undefined

get.parameters.query? ​

optional query?: undefined

get.requestBody? ​

optional requestBody?: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Catalog page

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

get.responses.200.content.application/json.programs ​

programs: object[]

get.responses.200.content.application/json.success ​

success: true

Constant value.

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post? ​

optional post?: undefined

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v1/verification-checks ​

/v1/verification-checks: object

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

delete? ​

optional delete?: undefined

get ​

get: object

get.parameters ​

parameters: object

optional cookie?: undefined

get.parameters.header? ​

optional header?: undefined

get.parameters.path? ​

optional path?: undefined

get.parameters.query? ​

optional query?: undefined

get.requestBody? ​

optional requestBody?: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Verification check catalog

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

get.responses.200.content.application/json.checks ​

checks: object[]

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post? ​

optional post?: undefined

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v1/verification-sessions ​

/v1/verification-sessions: object

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

delete? ​

optional delete?: undefined

get? ​

optional get?: undefined

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post ​

post: object

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie?: undefined

post.parameters.header? ​

optional header?: undefined

post.parameters.path? ​

optional path?: undefined

post.parameters.query? ​

optional query?: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.requestedChecks? ​

optional requestedChecks?: object[]

post.requestBody.content.application/json.requestType? ​

optional requestType?: string

post.requestBody.content.application/json.verifierDisplayName ​

verifierDisplayName: string

post.requestBody.content.application/json.verifierId ​

verifierId: string

post.responses ​

responses: object

post.responses.201 ​

201: object

Hosted verifier session

post.responses.201.content ​

content: object

post.responses.201.content.application/json ​

application/json: object

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

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

Enum (unknown).

post.responses.201.content.application/json.expiresAt ​

expiresAt: string

Format: date-time

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

optional qrPayload?: string

post.responses.201.content.application/json.sessionId ​

sessionId: string

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

optional sessionRef?: string

post.responses.201.content.application/json.status ​

status: string

post.responses.201.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v1/verification-sessions/{sessionId} ​

/v1/verification-sessions/{sessionId}: object

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

delete? ​

optional delete?: undefined

get ​

get: object

get.parameters ​

parameters: object

optional cookie?: undefined

get.parameters.header? ​

optional header?: undefined

get.parameters.path ​

path: object

get.parameters.path.sessionId ​

sessionId: string

get.parameters.query? ​

optional query?: undefined

get.requestBody? ​

optional requestBody?: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Verifier result

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

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

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

Enum (unknown).

get.responses.200.content.application/json.expiresAt ​

expiresAt: string

Format: date-time

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

optional qrPayload?: string

get.responses.200.content.application/json.sessionId ​

sessionId: string

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

optional sessionRef?: string

get.responses.200.content.application/json.status ​

status: string

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post? ​

optional post?: undefined

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v2/attestations/{commitment} ​

/v2/attestations/{commitment}: object

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

delete? ​

optional delete?: undefined

get ​

get: object

get.parameters ​

parameters: object

optional cookie?: undefined

get.parameters.header? ​

optional header?: undefined

get.parameters.path ​

path: object

get.parameters.path.commitment ​

commitment: string

get.parameters.query? ​

optional query?: undefined

get.requestBody? ​

optional requestBody?: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Exact on-chain lifecycle status

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

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

optional anchorBlockNumber?: number

get.responses.200.content.application/json.attestationHash ​

attestationHash: string

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

optional issuerIdHash?: string

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

optional revokeBlockNumber?: number

get.responses.200.content.application/json.status ​

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

Enum (unknown).

get.responses.200.content.application/json.success ​

success: true

Constant value.

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post? ​

optional post?: undefined

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v2/operations/anchor/reconcile ​

/v2/operations/anchor/reconcile: object

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

delete? ​

optional delete?: undefined

get? ​

optional get?: undefined

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post ​

post: object

Read-only recovery of an exact previously signed anchor after a lost response. The original signed operation stays in the request body, never in URLs or logs. An index row only locates a candidate; confirmation requires matching canonical chain evidence and active status. No transaction is submitted. At most eight concurrent requests per gateway, a 4096-byte body limit and ten-second total deadline apply. Responses are no-store. The result trusts the configured gateway/RPC; it is not a light-client proof or a delivery authorization.

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie?: undefined

post.parameters.header? ​

optional header?: undefined

post.parameters.path? ​

optional path?: undefined

post.parameters.query? ​

optional query?: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.candidateTransactionHash? ​

optional candidateTransactionHash?: string

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

post.requestBody.content.application/json.chainId ​

chainId: number

post.requestBody.content.application/json.ledgerAddress ​

ledgerAddress: string

post.requestBody.content.application/json.operation ​

operation: object

post.requestBody.content.application/json.operation.attestationHash ​

attestationHash: string

post.requestBody.content.application/json.operation.deadline ​

deadline: number

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

post.requestBody.content.application/json.operation.holderRevocationSigner ​

holderRevocationSigner: string

post.requestBody.content.application/json.operation.issuerIdHash ​

issuerIdHash: string

post.requestBody.content.application/json.operation.issuerKeyEpoch ​

issuerKeyEpoch: number

post.requestBody.content.application/json.operation.nonce ​

nonce: string

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

post.requestBody.content.application/json.operation.requestIdHash ​

requestIdHash: string

post.requestBody.content.application/json.requiredConfirmations ​

requiredConfirmations: number

Cannot lower the gateway confirmation floor.

post.requestBody.content.application/json.signature ​

signature: string

post.responses ​

responses: object

post.responses.200 ​

200: object

Exact anchor evidence confirmed at the returned canonical head

post.responses.200.content ​

content: object

post.responses.200.content.application/json ​

application/json: object

post.responses.200.content.application/json.protocolVersion ​

protocolVersion: 2

Constant value.

post.responses.200.content.application/json.receipt ​

receipt: object

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

attestationHash: string

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

blockHash: string

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

blockNumber: number

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

chainId: number

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

checkedHeadHash: string

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

checkedHeadNumber: number

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

confirmations: number

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

issuerIdHash: string

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

ledgerAddress: string

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

requiredConfirmations: number

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

status: "active"

Constant value.

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

transactionHash: string

post.responses.200.content.application/json.status ​

status: "confirmed"

Constant value.

post.responses.200.content.application/json.success ​

success: true

Constant value.

post.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.202 ​

202: object

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

post.responses.202.content ​

content: object

post.responses.202.content.application/json ​

application/json: object

post.responses.202.content.application/json.protocolVersion ​

protocolVersion: 2

Constant value.

post.responses.202.content.application/json.reason ​

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

Enum (unknown).

post.responses.202.content.application/json.status ​

status: "pending"

Constant value.

post.responses.202.content.application/json.success ​

success: true

Constant value.

post.responses.202.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.400 ​

400: object

Invalid request; no query parameters are accepted

post.responses.400.content? ​

optional content?: undefined

post.responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.409 ​

409: object

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

post.responses.409.content ​

content: object

post.responses.409.content.application/json ​

application/json: object

post.responses.409.content.application/json.error ​

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

Enum (unknown).

post.responses.409.content.application/json.success ​

success: false

Constant value.

post.responses.409.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.413 ​

413: object

Request exceeds 4096 bytes

post.responses.413.content? ​

optional content?: undefined

post.responses.413.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.429 ​

429: object

Gateway concurrency limit; retry later without changing credential lifecycle

post.responses.429.content? ​

optional content?: undefined

post.responses.429.headers ​

headers: object

Index Signature ​

[name: string]: unknown

post.responses.503 ​

503: object

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

post.responses.503.content? ​

optional content?: undefined

post.responses.503.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v2/operations/revoke/holder ​

/v2/operations/revoke/holder: object

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

delete? ​

optional delete?: undefined

get? ​

optional get?: undefined

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post ​

post: object

post.parameters ​

parameters: object

post.parameters.cookie? ​

optional cookie?: undefined

post.parameters.header? ​

optional header?: undefined

post.parameters.path? ​

optional path?: undefined

post.parameters.query? ​

optional query?: undefined

post.requestBody ​

requestBody: object

post.requestBody.content ​

content: object

post.requestBody.content.application/json ​

application/json: object

post.requestBody.content.application/json.operation ​

operation: object

Index Signature ​

[key: string]: unknown

post.requestBody.content.application/json.signature ​

signature: string

post.responses ​

responses: object

post.responses.202 ​

202: object

Signed operation accepted by relayer

post.responses.202.content? ​

optional content?: undefined

post.responses.202.headers ​

headers: object

Index Signature ​

[name: string]: unknown

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined

/v2/services/resolve ​

/v2/services/resolve: object

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

delete? ​

optional delete?: undefined

get ​

get: object

get.parameters ​

parameters: object

optional cookie?: undefined

get.parameters.header? ​

optional header?: undefined

get.parameters.path? ​

optional path?: undefined

get.parameters.query ​

query: object

get.parameters.query.origin ​

origin: string

get.parameters.query.serviceId ​

serviceId: string

get.requestBody? ​

optional requestBody?: undefined

get.responses ​

responses: object

get.responses.200 ​

200: object

Verified service metadata

get.responses.200.content ​

content: object

get.responses.200.content.application/json ​

application/json: object

get.responses.200.content.application/json.registryRevision ​

registryRevision: string

get.responses.200.content.application/json.service ​

service: object

get.responses.200.content.application/json.service.accountPolicy ​

accountPolicy: object

get.responses.200.content.application/json.service.accountPolicy.maxAccounts ​

maxAccounts: number

get.responses.200.content.application/json.service.accountPolicy.mode ​

mode: "single" | "multiple"

Enum (unknown).

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

policyVersion: 2

Constant value.

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

endpoints: object

Index Signature ​

[key: string]: string

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

optional name?: string

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

origin: string

Format: uri

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

optional provider?: string

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

serviceId: string

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

status: "active"

Constant value.

get.responses.200.content.application/json.success ​

success: true

Constant value.

get.responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

head? ​

optional head?: undefined

options? ​

optional options?: undefined

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

patch? ​

optional patch?: undefined

post? ​

optional post?: undefined

put? ​

optional put?: undefined

trace? ​

optional trace?: undefined