Skip to content

Manage holder authorization for MPTs that require issuer approval.

How authorization works

When an MPT is created with lsfMPTRequireAuth, holders cannot receive tokens until the issuer explicitly authorizes them. This enables controlled distribution and compliance workflows.

Authorization is a two-step process:

  1. Holder opt-in — The holder submits MPTokenAuthorize to express interest in the MPT.
  2. Issuer approval — The issuer submits MPTokenAuthorize with the holder's address to grant permission.

If lsfMPTRequireAuth is not set, holders can receive tokens after their own opt-in without issuer approval.

Prerequisites

  • You are the issuer of the MPT
  • The MPT has lsfMPTRequireAuth enabled
  • The holder has already submitted their opt-in MPTokenAuthorize

Authorize a holder

To authorize a holder to receive your MPT, submit an MPTokenAuthorize transaction:

{
  "payload": {
    "id": "{{intent_id}}",
    "accountId": "{{issuer_account_id}}",
    "parameters": {
      "type": "XRPL",
      "feeStrategy": {
        "priority": "Medium",
        "type": "Priority"
      },
      "operation": {
        "type": "MPTokenAuthorize",
        "tokenIdentifier": {
          "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D0831E",
          "type": "MPTokenIssuanceId"
        },
        "holder": {
          "address": "rHolderAddress...",
          "type": "Address"
        },
        "flags": []
      }
    },
    "customProperties": {},
    "type": "v0_CreateTransactionOrder"
  }
}

Parameters

FieldTypeRequiredDescription
tokenIdentifier.issuanceIdstringYesThe 192-bit MPT issuance ID.
tokenIdentifier.typestringYesMust be MPTokenIssuanceId.
holderobjectYesThe holder to authorize.
holder.typestringYesOne of: Account (internal account UUID), Address (XRPL address), or Endpoint (endpoint UUID).
holder.addressstringConditionalThe holder's XRPL address to authorize. Required when holder.type is Address.
holder.accountIdstringConditionalInternal account UUID. Required when holder.type is Account.
holder.endpointIdstringConditionalEndpoint UUID. Required when holder.type is Endpoint.
flagsarrayYesEmpty array [] for authorization.

Revoke authorization

To revoke a holder's authorization, include the tfMPTUnauthorize flag:

{
  "operation": {
    "type": "MPTokenAuthorize",
    "tokenIdentifier": {
      "issuanceId": "000004C463C52827307480341125DA0577AFFC21D4B2D0831E",
      "type": "MPTokenIssuanceId"
    },
    "holder": {
      "address": "rHolderAddress...",
      "type": "Address"
    },
    "flags": ["tfMPTUnauthorize"]
  }
}

Revoking authorization does not remove the holder's tokens. Use clawback to recover tokens before revoking if needed.

Response

A successful request returns the transaction order with status Pending. After confirmation, the holder can receive tokens from the issuer or other authorized holders.

Authorization workflow

XRPLIssuerHolderXRPLIssuerHolderMPTokenAuthorize (opt-in)MPTokenAuthorize (approve holder)Payment (mint to holder)Tokens credited
XRPLIssuerHolderXRPLIssuerHolderMPTokenAuthorize (opt-in)MPTokenAuthorize (approve holder)Payment (mint to holder)Tokens credited