Get public asset registration rules

GET/v1/assets/{id}/policy

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

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

Example

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

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

AssetPolicyResponse

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

AssetPolicy

Public registration policy. The document route serves verified public ICU text; private documents, complete witness evaluation, fees and advanced compliance state are not exposed.

FieldTypeRequiredDescription
asset_idstringYesAsset identifier from the indexed protocol registration.
policy_bitsintegerYesRaw on-chain asset permission bitmask.
mint_allowedbooleanYesWhether the asset registration permits minting.
burn_allowedbooleanYesWhether the asset registration permits burning.
burn_requires_icubooleanYesWhether burning requires issuer ICU authorization.
burn_requires_joint_authorizationbooleanYesWhether burning requires joint authorization.
kyc_requiredbooleanYesWhether the registration carries the KYC-required permission bit; not a full compliance evaluation.
documents_availablebooleanYesWhether this API supports the separate read-only public document route. Use that route's state to distinguish public, holder-only, missing, unavailable and unverified documents.
policy_epochinteger | nullYesRegistered policy version counter.
quorum_bpsinteger | nullYesRegistered governance quorum in basis points; zero means immutable from registration.
delegate_asset_idstring | nullYesDelegated compliance asset identifier, or null; distinct from the parent asset.

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