noripple_check

POST

Checks an account's Default Ripple setting and the No Ripple flag state of its trust lines.When a problem is found, it returns a human-readable description and suggests a transaction to resolve it.

param[0]

parametersobjectrequired

accountstringrequired

The account to check.

rolestringrequired

The role of the account. The recommended settings differ by role.

gateway: Treats the account as one that issues tokens.
user: Treats the account as a regular account that holds tokens.

transactionsboolean

Whether to also return transactions that resolve the problems found.

limitinteger

The maximum number of trust line problems to report.

ledger_hashstring

The hash of the ledger version to use. Pass a 32-byte hex string.

ledger_indexoneOf

Specifies the ledger version to use. Pass a ledger index as an integer, or use one of the shortcut strings below.

validated: Uses the most recent ledger version validated by the network.
closed: Uses the most recent ledger version the server has closed. It may not be validated.
current: Uses the in-progress ledger version the server is currently building.

The ledger index of the version to use.

Responses

ledger_current_indexinteger

The ledger index used for the check.

problemsarray

The list of problems found, described in human-readable sentences.At most one Default Ripple problem is reported; trust line problems are reported up to the request's limit.

transactionsarray

The list of transactions suggested to resolve the problems.It is returned when transactions is set to true in the request, and has the same length as problems.

validatedboolean

Whether the response was derived from a validated ledger version.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}

X-API-KEY

cURL

curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "noripple_check",
    "params": [
      {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "role": "gateway",
        "transactions": false,
        "limit": 300
      }
    ]
  }'