MPTokenIssuance, decode its metadata, check XLS-89 conformance, locate the NAV pointer, substitute the token’s own ID, and follow the URL — and reports every step, including failures. “This collateral is opaque” is a legitimate and useful answer to give a lender, and this route makes it explicit rather than throwing an exception.
Parameters
string
required
48-character hex MPT issuance ID. Case insensitive.
boolean
Whether to follow the pointer after finding it. Defaults to
true. Pass false to inspect the metadata without making an outbound HTTP request.string
Number of share units to value as a pledge (a count of token units, as a decimal string). When present and the pointer resolves successfully, the response includes a
pledge block.Cache-Control: public, max-age=4 and Access-Control-Allow-Origin: *.
Request
Response
Response Fields
string
The 48-character hex MPT issuance ID that was resolved.
string
XRPL address of the
MPTokenIssuance issuer.string
Total share units in circulation at the time of resolution (a count of token units).
boolean
true when every step succeeded and a unitValue was obtained. false when any step failed — the response still contains the steps that did run, and nav is null.The fully substituted URL that was or would be followed.
null if the pointer was not found.array
Ordered list of resolution steps, each with its outcome.
object
Decoded
MPTokenIssuance metadata with XLS-89 conformance check.The full
orma.nav/1 document from the resolved pointer. null when resolved is false or when resolve=false was passed. See GET /api/mpt/:mptId/nav for the full field reference.object | null
Present when
units is supplied and the pointer resolved successfully. Same structure as the pledge block on GET /api/mpt/:mptId/nav. All values are null if the document carries no unitValue, alongside an unpriced explanation.Following the pointer is bounded by a 2 500 ms
AbortController timeout. It is a URL written by a third party into the MPTokenIssuance at creation — it is the only step in the entire API that leaves the ledger and makes an outbound network request. The timeout prevents a slow or unresponsive pointer from blocking the response indefinitely.