Read committed public issuer document

GET/v1/assets/{id}/document

TSCScan API v1.0.0 · Assets · also at /api/v1/mainnet/assets/{id}/document

Chain-dependent response; compact chain headers identify the serving snapshot.

Example

curl 'https://api.tensorcash.org/v1/assets/<id>/document'

Parameters

NameInTypeRequiredDescription
idpathstringYesExact 64-character hexadecimal model or asset identifier; use the corresponding list to discover IDs.
min_heightqueryinteger—Optional minimum serving indexed height. Returns DATA_NOT_READY if no eligible source has reached it.

Responses

StatusDescriptionBody
200Successful read from one Indexer snapshot
400Invalid argument or page conditions
401Authentication required
403Permission denied
404Absent in a ready indexed range
409Verified chain continuity invalidation
422Bounded response would exceed byte budget
429Quota exceeded; Retry-After supplied
503Data or eligible source not ready
504Bounded upstream query timed out

Schemas

AssetDocumentResponse

FieldTypeRequiredDescription
dataAssetDocumentYesThe requested resource or collection; its schema is specific to this endpoint.

AssetDocument

Read-only public ICU document. Resolves the indexed registration transaction and fetches its explicit historical commitment without loading a wallet. Private ciphertext, keywraps, witnesses and decryption material are never returned.

FieldTypeRequiredDescription
asset_idstringYesAsset identifier from the indexed protocol registration.
registration_txidstringYesIndexed issuer registration used to select the document commitments.
state"public" | "holder_only" | "none" | "unavailable" | "unverified"Yespublic: verified readable text; holder_only: private or encrypted; none: no payload commitment; unavailable: fetch temporarily failed; unverified: payload or text could not be verified.
plaintextstring | nullYesNormalized original issuer text, only for a public document whose ciphertext and plaintext commitments both match. Never HTML or a browser-generated interpretation.
plaintext_commitstring | nullYesDeclared icu_plain_commit from the indexed registration, in Core display byte order; null while metadata is unavailable.
ciphertext_commitstring | nullYesDeclared icu_ctxt_commit from the indexed registration, in Core display byte order; null while metadata is unavailable.
commit_verifiedbooleanYesTrue only when the public payload and normalized text match both indexed on-chain commitments. Does not certify an issuer's claims or legal rights.

Problem

FieldTypeRequiredDescription
typestringYesProblem type URI; about:blank is used for the current error family.
titlestringYesShort human-readable problem title, normally the stable error code.
statusintegerYesHTTP status code for this problem response.
code"INVALID_ARGUMENT" | "UNAUTHORIZED" | "FORBIDDEN" | "RESOURCE_NOT_FOUND" | "CHAIN_ANCHOR_INVALIDATED" | "RATE_LIMITED" | "DATA_NOT_READY" | "SERVICE_UNAVAILABLE" | "UPSTREAM_TIMEOUT" | "RESPONSE_TOO_LARGE" | "CORE_UNAVAILABLE" | "CORE_METHOD_UNAVAILABLE" | "CORE_DATA_NOT_READY" | "CORE_CAPACITY" | "TRANSACTION_CAPACITY" | "TRANSACTION_STATE_CHANGED" | "TRANSACTION_REJECTED" | "BROADCAST_OUTCOME_UNKNOWN" | "UNSUPPORTED_ASSET_POLICY"YesStable machine-readable error code; use this instead of matching message text.
request_idstringYesIdentifier also supplied in X-Request-ID; include it when reporting an error.
detailstring—Human-readable explanation of the error.
retry_after_secondsinteger—Suggested wait in seconds before retrying; where present, agrees with Retry-After.
Source
TSCScan public API v1.0.0 (12f98c5) · rHuhu · MIT