XRPLHub — XRPLScore & XRPL actions

{
  "type": "object",
  "required": [
    "product_id",
    "wallet_address"
  ],
  "properties": {
    "params": {
      "type": "object",
      "description": "Per-service parameters. Call list_xrpl_services for types + examples for every field. Required fields by id — multisig: signers, quorum | regkey: regularKey | depositauth: (no params) | desttag: (no params) | lockdown: (no params) | issuerdecl: (no params) | issuercfg: (no params) | tokenfee: transferFee | trustline: issuer, currency | trustsend: issuer, currency, destination, amount | rippling: (no params) | mptissue: name, ticker, maximumAmount | mptsend: destination, mptIssuanceId, amount | globalfreeze: (no params) | freezeline: holder, currency | dexorder: takerGetsValue, takerPaysValue | ammwithdraw: asset2Currency | smartswap: receiveValue, receiveCurrency | ammlaunch: assetValue, asset2Value | ammentry: assetValue, asset2Currency | paychannel: destination, amount, publicKey | tickets: (no params) | nftmint: uri | nftburn: nftokenId | nftoffer: nftokenId, amount | checkcreate: destination, amount | checkcash: checkId, amount | checkcancel: checkId | depositpreauth: sender | escrow: destination, amount, finishAfter | identity: domain | did: uri | compliance: domain, didUri | credentialissue: subject, credentialType | permdomain: credentialType"
    },
    "product_id": {
      "enum": [
        "multisig",
        "regkey",
        "depositauth",
        "desttag",
        "issuerdecl",
        "issuercfg",
        "tokenfee",
        "trustline",
        "trustsend",
        "rippling",
        "mptissue",
        "mptsend",
        "globalfreeze",
        "freezeline",
        "dexorder",
        "ammwithdraw",
        "smartswap",
        "ammlaunch",
        "ammentry",
        "paychannel",
        "tickets",
        "nftmint",
        "nftburn",
        "nftoffer",
        "checkcreate",
        "checkcash",
        "checkcancel",
        "depositpreauth",
        "escrow",
        "identity",
        "did",
        "compliance",
        "credentialissue",
        "permdomain"
      ],
      "type": "string",
      "description": "Which XRPL action to build. Call list_xrpl_services for the full catalogue with each id's label, tier and parameters."
    },
    "wallet_address": {
      "type": "string",
      "description": "XRPL classic address (r...) of the account that will sign the transaction"
    }
  }
}

{
  "type": "object",
  "required": [
    "domain_id",
    "wallet_address"
  ],
  "properties": {
    "domain_id": {
      "type": "string",
      "description": "The PermissionedDomain's ledger index — 64 hex characters"
    },
    "wallet_address": {
      "type": "string",
      "description": "XRPL classic address to check (starts with r)"
    }
  }
}

{
  "type": "object",
  "required": [
    "issuance_id"
  ],
  "properties": {
    "issuance_id": {
      "type": "string",
      "description": "The MPTokenIssuanceID — 48 hexadecimal characters (XLS-33, 192-bit)"
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "required": [
    "wallet_address"
  ],
  "properties": {
    "wallet_address": {
      "type": "string",
      "description": "XRP Ledger classic address to score (starts with r, 25–35 characters)"
    }
  }
}

{
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount to donate. Minimum 1. Any size welcome — even 1-5 XRP helps fund a real grant."
    },
    "message": {
      "type": "string",
      "description": "Optional. A short dedication or message to attach to the donation record."
    },
    "currency": {
      "type": "string",
      "description": "XRP or RLUSD. Default: XRP. Use RLUSD for a stable USD-equivalent donation."
    },
    "donor_wallet": {
      "type": "string",
      "description": "Optional. XRPL wallet address of the donor. Providing this allows building a ready-to-sign Payment transaction."
    }
  }
}

{
  "type": "object",
  "required": [
    "wallet_address"
  ],
  "properties": {
    "issuer": {
      "type": "string",
      "description": "Optional — restrict to one issuer via a direct ledger lookup (no owner-directory walk)"
    },
    "wallet_address": {
      "type": "string",
      "description": "XRPL classic address to look up (starts with r)"
    },
    "credential_type": {
      "type": "string",
      "description": "Optional — credential type (plain name or hex); required with issuer unless the issuer is XRPLHub's"
    }
  }
}

{
  "type": "object",
  "required": [
    "issuer_address"
  ],
  "properties": {
    "issuer_address": {
      "type": "string",
      "description": "XRPL classic address of the credential issuer (starts with r)"
    }
  }
}

{
  "type": "object",
  "required": [
    "issuer_address"
  ],
  "properties": {
    "issuer_address": {
      "type": "string",
      "description": "XRPL issuer address (starts with r)"
    }
  }
}

{
  "type": "object",
  "required": [
    "borrower"
  ],
  "properties": {
    "borrower": {
      "type": "string",
      "description": "XRPL classic address (r..., 25–35 chars) of the borrower"
    }
  }
}

{
  "type": "object",
  "required": [
    "borrower"
  ],
  "properties": {
    "borrower": {
      "type": "string",
      "description": "XRPL classic address (r...) of the borrower"
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "required": [
    "borrower"
  ],
  "properties": {
    "borrower": {
      "type": "string",
      "description": "XRPL classic address (r...) of the borrower"
    }
  }
}

{
  "type": "object",
  "required": [
    "wallet_address"
  ],
  "properties": {
    "uuid": {
      "type": "string",
      "description": "Only for the second call: the payment uuid returned by the first call, after the user has signed in Xaman."
    },
    "currency": {
      "enum": [
        "XRP",
        "RLUSD"
      ],
      "type": "string",
      "description": "Payment currency. Defaults to XRP."
    },
    "wallet_address": {
      "type": "string",
      "description": "XRP Ledger wallet address the credential will attest to (starts with r)"
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "type": "string",
      "description": "XRPL classic address (r..., 25–35 chars) to compare against the OFAC SDN list"
    }
  }
}

{
  "type": "object",
  "required": [
    "q"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Issuer address (r...), MPTokenIssuanceID or hex prefix, or token name/ticker"
    }
  }
}

{
  "type": "object",
  "required": [
    "amount",
    "category",
    "description",
    "wallet_address"
  ],
  "properties": {
    "amount": {
      "type": "number",
      "description": "Amount requested in RLUSD (1–100)"
    },
    "category": {
      "type": "string",
      "description": "Grant category: RENT, UTILITIES, GROCERIES, MEDICAL, TRANSPORT, CHILDCARE, or OTHER"
    },
    "currency": {
      "type": "string",
      "description": "Payout currency. Default and recommended: RLUSD"
    },
    "description": {
      "type": "string",
      "description": "Clear description of the need, situation, and urgency (2–4 sentences). Be specific — vague applications are harder for the reviewer to verify."
    },
    "wallet_address": {
      "type": "string",
      "description": "XRPL wallet address where the grant will be sent if approved"
    }
  }
}

{
  "type": "object",
  "required": [
    "query_id"
  ],
  "properties": {
    "query_id": {
      "type": "string",
      "description": "The queryId (UUID) from screen_address_ofac or get_lending_exposure"
    }
  }
}

{
  "type": "object",
  "properties": {}
}