API Reference

Ledger

The Ledger is the central component that manages all records, configurations, and operations within the system. It stores global settings, such as access rules, and maintains the ledger signer, which is responsible for signing transactions owned by the ledger itself. The ledger ensures the integrity and security of all data and transactions.

List ledger instances

GET
/ledgers

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Query Parameters

page?

Page query parameters

filter?

Base filter parameters

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3000/v2/ledgers?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D"
{
  "hash": "f0bd2eda6d39952c27e01180ef0e85f47fa3ed0341882f01a8d754aa2c7b2803",
  "meta": {
    "proofs": []
  },
  "data": [
    {
      "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
      "data": {
        "handle": "open-ledger",
        "signer": "system",
        "custom": {
          "city": "New York",
          "country": "USA"
        },
        "access": [
          {
            "action": "any",
            "record": "any"
          }
        ],
        "config": {
          "anchor.walletRequired": true,
          "request.journalingEnabled": true,
          "intent.expiryThresholdMinutes": 60,
          "intent.creditorInitiatedTransfersEnabled": false,
          "policy.scheduleProcessorEnabled": false
        }
      },
      "luid": "$ldg.-01dNJEZnRJC2YjP5",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-03-13T16:41:54.566Z",
              "status": "created"
            },
            "digest": "86e558550aae3de3ac6ad53fb2cc2f879d42f7db896ad6aaf3cb292ada2c4048",
            "method": "ed25519-v2",
            "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
            "result": "UN7NEkTYpsrG+JVq+3q/S+1GK2AHxlKAzpqCEi7+01b9UiUTHsJwlAwWRbQ580uLTVwrilu1v0vJGJ/yDjvMCQ=="
          },
          {
            "custom": {
              "luid": "$ldg.-01dNJEZnRJC2YjP5",
              "moment": "2025-03-13T16:41:54.654Z",
              "status": "created"
            },
            "digest": "9d2424469066b8c10248f89cf23ef7d74bdab024047fe2088a67e5ef1c0644d3",
            "method": "ed25519-v2",
            "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
            "result": "/AERNZ/QFhEJnEz7lP3CVQboV+7r4ZGc0QGVO1hUyZON3o7KNnwJVo5W4iK9W8099ypcHSWrs3dz7VTJEVfCBQ=="
          }
        ],
        "status": "created",
        "moment": "2025-03-13T16:41:54.645Z",
        "owners": [
          "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
        ]
      }
    },
    {
      "hash": "54d27b902750fe31fd7ecbf5c5bf50c36220f28bf94331028642180d19e70fcf",
      "data": {
        "parent": "8417ba9c5c52f69c57c1fb3d5a8c4e38914e1d6cf1025498d08b5d93a30cee51",
        "handle": "open-ledger-london",
        "signer": "system",
        "custom": {
          "city": "London",
          "country": "UK"
        },
        "access": [
          {
            "action": "any",
            "record": "any"
          }
        ],
        "config": {
          "anchor.walletRequired": true,
          "request.journalingEnabled": true,
          "intent.expiryThresholdMinutes": 70,
          "intent.creditorInitiatedTransfersEnabled": false,
          "policy.scheduleProcessorEnabled": false
        }
      },
      "luid": "$ldg.-01dG27V2qcdBt3fR",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-03-13T16:34:09.205Z"
            },
            "digest": "33ad679a074342f7b324b6f69edadc211ceb1722c0877d5e60977fc1b6347d43",
            "method": "ed25519-v2",
            "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
            "result": "W3tYVjKo2+aSgP7D6PzisCS747sBMOT94jxoTVAlqYBH+ENbPKyt1wHg5ez60zDAUFDABaTEbYlbEhAVGnqLAg=="
          },
          {
            "custom": {
              "luid": "$ldg.-01dG27V2qcdBt3fR",
              "moment": "2025-03-13T16:34:09.230Z"
            },
            "digest": "056d41f5efd8e91290a58deec4c86dcf36aafb38d9cf3882d3413183efd61789",
            "method": "ed25519-v2",
            "public": "BZnhkjfLCZJVZdZWBL71zReIzxkilU5SO1eSIwQY5x4=",
            "result": "O4dtQikBIHsVGeQnJuxJIergKUeVLnuLAQRgariPRHKIcLHJWfQrDjV386JTCFUhFPWOcCo+u34jB6JIXfOfBQ=="
          }
        ],
        "status": "created",
        "moment": "2025-03-13T16:34:09.228Z",
        "owners": [
          "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
        ]
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 2
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "d48c4a6bb91c37c85625280d90a114b4983ea57089a00964e33e68d165fbecd8",
  "data": {
    "reason": "api.request-timeout",
    "detail": "Processing of request on server timed out. Your request may or may not have been processed."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "a/udgZN+Qebmkcw9GJ63MlvPiwwt6RZxzpc6+OyTTdE=",
        "digest": "295ec195e7468e1514fe9eecc0b463f9efdb45341eb06af9115c6ad9f0e2f26d",
        "result": "BJ7g1gTzJ/KeiwylEaiuzeMK7QXipBAkMaOndm3G0fjubmMCIS9wtl5wOm0X8BdYx3LLbyeh0C7zgQepsrCYBw==",
        "custom": {
          "moment": "2025-03-25T10:19:07.654Z"
        }
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Create a ledger instance.

POST
/ledgers

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Request Body

application/json

Ledger body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/ledgers" \  -H "Content-Type: application/json" \  -d '{    "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",    "data": {      "handle": "open-ledger",      "signer": "system",      "access": [        {          "record": "any",          "action": "any"        }      ],      "config": {        "anchor.walletRequired": true,        "intent.expiryThresholdMinutes": 60,        "intent.creditorInitiatedTransfersEnabled": false,        "policy.scheduleProcessorEnabled": false,        "request.journalingEnabled": true      },      "custom": {        "country": "USA",        "city": "New York"      }    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",          "digest": "86e558550aae3de3ac6ad53fb2cc2f879d42f7db896ad6aaf3cb292ada2c4048",          "result": "UN7NEkTYpsrG+JVq+3q/S+1GK2AHxlKAzpqCEi7+01b9UiUTHsJwlAwWRbQ580uLTVwrilu1v0vJGJ/yDjvMCQ==",          "custom": {            "moment": "2025-03-13T16:41:54.566Z",            "status": "created"          }        }      ]    }  }'
{
  "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
  "data": {
    "handle": "open-ledger",
    "signer": "system",
    "custom": {
      "city": "New York",
      "country": "USA"
    },
    "access": [
      {
        "action": "any",
        "record": "any"
      }
    ],
    "config": {
      "anchor.walletRequired": true,
      "request.journalingEnabled": true,
      "intent.expiryThresholdMinutes": 60,
      "intent.creditorInitiatedTransfersEnabled": false,
      "policy.scheduleProcessorEnabled": false
    }
  },
  "luid": "$ldg.-01dNJEZnRJC2YjP5",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-03-13T16:41:54.566Z",
          "status": "created"
        },
        "digest": "86e558550aae3de3ac6ad53fb2cc2f879d42f7db896ad6aaf3cb292ada2c4048",
        "method": "ed25519-v2",
        "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
        "result": "UN7NEkTYpsrG+JVq+3q/S+1GK2AHxlKAzpqCEi7+01b9UiUTHsJwlAwWRbQ580uLTVwrilu1v0vJGJ/yDjvMCQ=="
      },
      {
        "custom": {
          "luid": "$ldg.-01dNJEZnRJC2YjP5",
          "moment": "2025-03-13T16:41:54.654Z",
          "status": "created"
        },
        "digest": "9d2424469066b8c10248f89cf23ef7d74bdab024047fe2088a67e5ef1c0644d3",
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "result": "/AERNZ/QFhEJnEz7lP3CVQboV+7r4ZGc0QGVO1hUyZON3o7KNnwJVo5W4iK9W8099ypcHSWrs3dz7VTJEVfCBQ=="
      }
    ],
    "status": "created",
    "moment": "2025-03-13T16:41:54.645Z",
    "owners": [
      "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}
{
  "hash": "9e518d3f4a7c8b67ad43fcf9b6a21e0c5f9b2a5e7d6c3b8a1f4e7d0c9b8a7f5e",
  "data": {
    "reason": "record.duplicated",
    "detail": "Ledger with handle ach already exists."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "QpI4V3K6NzJLbRWCGxdHF7XYT9w2jVkArMpLoFa84s4=",
        "digest": "9e518d3f4a7c8b67ad43fcf9b6a21e0c5f9b2a5e7d6c3b8a1f4e7d0c9b8a7f5e",
        "result": "jR3PQvN7Dy4GcXshzZIa5qd6me9CyiTUwRlJo8fkHpv2jlYE+Hx/D0FSrT2y6MCcSjFnV3dlUmWxJrb5F+kzDQ=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Read a ledger instance

GET
/ledger

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3000/v2/ledger" \  -H "x-ledger: rtp-ledger"
{
  "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
  "data": {
    "handle": "open-ledger",
    "signer": "system",
    "custom": {
      "city": "New York",
      "country": "USA"
    },
    "access": [
      {
        "action": "any",
        "record": "any"
      }
    ],
    "config": {
      "anchor.walletRequired": true,
      "request.journalingEnabled": true,
      "intent.expiryThresholdMinutes": 60,
      "intent.creditorInitiatedTransfersEnabled": false,
      "policy.scheduleProcessorEnabled": false
    }
  },
  "luid": "$ldg.-01dNJEZnRJC2YjP5",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-03-13T16:41:54.566Z",
          "status": "created"
        },
        "digest": "86e558550aae3de3ac6ad53fb2cc2f879d42f7db896ad6aaf3cb292ada2c4048",
        "method": "ed25519-v2",
        "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
        "result": "UN7NEkTYpsrG+JVq+3q/S+1GK2AHxlKAzpqCEi7+01b9UiUTHsJwlAwWRbQ580uLTVwrilu1v0vJGJ/yDjvMCQ=="
      },
      {
        "custom": {
          "luid": "$ldg.-01dNJEZnRJC2YjP5",
          "moment": "2025-03-13T16:41:54.654Z",
          "status": "created"
        },
        "digest": "9d2424469066b8c10248f89cf23ef7d74bdab024047fe2088a67e5ef1c0644d3",
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "result": "/AERNZ/QFhEJnEz7lP3CVQboV+7r4ZGc0QGVO1hUyZON3o7KNnwJVo5W4iK9W8099ypcHSWrs3dz7VTJEVfCBQ=="
      }
    ],
    "status": "created",
    "moment": "2025-03-13T16:41:54.645Z",
    "owners": [
      "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Drop a ledger

POST
/ledger

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Request Body

application/json

Ledger drop body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/ledger" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3"    },    "hash": "690991880046a704481e4f75e32dcf7331960606fbf00d5046f246d9e888c1d2",    "luid": "$ldg.-01dNJEZnRJC2YjP5",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",          "digest": "ef8ad39c9c0d86bda17927fce52c851a3106c38867445bf2039fbce689ba6e62",          "result": "dMLHHBGtoGNodR7qXj54S04qEfppDrSiEhNvE40Z8sY9LsUkYWqJt3Oc/0OW67YDvmNWfRZOUPscpw7UU2WUAw==",          "custom": {            "moment": "2025-03-13T16:41:55.976Z",            "reason": "Ledger is no longer needed. Dropped by user.",            "status": "dropped"          }        }      ],      "status": "created",      "owners": [        "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="      ]    }  }'
Empty
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Drop a ledger

DELETE
/ledger

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Request Body

application/json

Ledger drop body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

text/plain

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:3000/v2/ledger" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3"    },    "hash": "690991880046a704481e4f75e32dcf7331960606fbf00d5046f246d9e888c1d2",    "luid": "$ldg.-01dNJEZnRJC2YjP5",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",          "digest": "ef8ad39c9c0d86bda17927fce52c851a3106c38867445bf2039fbce689ba6e62",          "result": "dMLHHBGtoGNodR7qXj54S04qEfppDrSiEhNvE40Z8sY9LsUkYWqJt3Oc/0OW67YDvmNWfRZOUPscpw7UU2WUAw==",          "custom": {            "moment": "2025-03-13T16:41:55.976Z",            "status": "dropped"          }        }      ],      "status": "created",      "owners": [        "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="      ]    }  }'
""
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Update a Ledger instance

PUT
/ledger

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Request Body

application/json

Ledger instance body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3000/v2/ledger" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "ff720aff30241370d4521576a9ce29066f7b6c6462876266ac1b3060074b8aa7",    "luid": "$ldg.-01dNJEZnRJC2YjP5",    "data": {      "handle": "open-ledger",      "signer": "system",      "custom": {        "city": "New York",        "country": "USA"      },      "access": [        {          "action": "any",          "record": "any"        }      ],      "config": {        "anchor.walletRequired": true,        "request.journalingEnabled": true,        "intent.expiryThresholdMinutes": 70,        "intent.creditorInitiatedTransfersEnabled": false,        "policy.scheduleProcessorEnabled": false      },      "parent": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",          "digest": "0ef03051dde6dde38a750d8c6027a1e81b5962e9bc733e8d4a36e06bbd2f0749",          "result": "M2tvblKkKjxl6gO0LpFE0KvfTrpkg+oLmUMgn11W6mxR0k1pkbe9UVajW71bdK2Gvsh36xF4HEwtF4deW8UsDg==",          "custom": {            "moment": "2025-03-13T16:41:54.872Z"          }        }      ]    }  }'
{
  "hash": "ff720aff30241370d4521576a9ce29066f7b6c6462876266ac1b3060074b8aa7",
  "data": {
    "parent": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
    "handle": "open-ledger",
    "signer": "system",
    "custom": {
      "city": "New York",
      "country": "USA"
    },
    "access": [
      {
        "action": "any",
        "record": "any"
      }
    ],
    "config": {
      "anchor.walletRequired": true,
      "request.journalingEnabled": true,
      "intent.expiryThresholdMinutes": 70,
      "intent.creditorInitiatedTransfersEnabled": false,
      "policy.scheduleProcessorEnabled": false
    }
  },
  "luid": "$ldg.-01dNJEZnRJC2YjP5",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-03-13T16:41:54.872Z"
        },
        "digest": "0ef03051dde6dde38a750d8c6027a1e81b5962e9bc733e8d4a36e06bbd2f0749",
        "method": "ed25519-v2",
        "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
        "result": "M2tvblKkKjxl6gO0LpFE0KvfTrpkg+oLmUMgn11W6mxR0k1pkbe9UVajW71bdK2Gvsh36xF4HEwtF4deW8UsDg=="
      },
      {
        "custom": {
          "luid": "$ldg.-01dNJEZnRJC2YjP5",
          "moment": "2025-03-13T16:41:54.895Z"
        },
        "digest": "684ee9e7b4b74cc7caa3228d6c412e15091afd83964d721ddb0a23acaed8d6e6",
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "result": "VQifH9KGqdHGOH3uDBZmpvClmY5Z5P/qVIuMfGCJLX82Ty0SmDsomrSs1vTEcdOhu5r6Odma6U8R8EopBTeQAA=="
      }
    ],
    "status": "created",
    "moment": "2025-03-13T16:41:54.893Z",
    "owners": [
      "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}
{
  "hash": "9e518d3f4a7c8b67ad43fcf9b6a21e0c5f9b2a5e7d6c3b8a1f4e7d0c9b8a7f5e",
  "data": {
    "reason": "record.duplicated",
    "detail": "Ledger with handle ach already exists."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "QpI4V3K6NzJLbRWCGxdHF7XYT9w2jVkArMpLoFa84s4=",
        "digest": "9e518d3f4a7c8b67ad43fcf9b6a21e0c5f9b2a5e7d6c3b8a1f4e7d0c9b8a7f5e",
        "result": "jR3PQvN7Dy4GcXshzZIa5qd6me9CyiTUwRlJo8fkHpv2jlYE+Hx/D0FSrT2y6MCcSjFnV3dlUmWxJrb5F+kzDQ=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Sign a ledger

POST
/ledger/proofs

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Request Body

application/json

Proof body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/ledger/proofs" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "method": "ed25519-v2",    "public": "fIMGdPIslGuhtlT5w6+nPw060KTDc55/3ELFjjgW0HA=",    "digest": "6ebfac0df8c394c54a15a0b27c1bd7af7986721ac8e06ca86b933183ad7cfa3c",    "result": "83X0wtplg9fZ2JUqd1Ag+dEFqe5J1i9R58QIXRNk07erp4r3XUUCg6uvmo164p4xAJvi7qHqp0fOkdl3DcRxBw==",    "custom": {      "moment": "2025-03-13T19:53:57.329Z",      "status": "active"    }  }'
{
  "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
  "data": {
    "handle": "open-ledger",
    "signer": "system",
    "custom": {
      "city": "New York",
      "country": "USA"
    },
    "access": [
      {
        "action": "any",
        "record": "any"
      }
    ],
    "config": {
      "anchor.walletRequired": true,
      "request.journalingEnabled": true,
      "intent.expiryThresholdMinutes": 60,
      "intent.creditorInitiatedTransfersEnabled": false,
      "policy.scheduleProcessorEnabled": false
    }
  },
  "luid": "$ldg.-01dNJEZnRJC2YjP5",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-03-13T16:41:54.566Z",
          "status": "created"
        },
        "digest": "86e558550aae3de3ac6ad53fb2cc2f879d42f7db896ad6aaf3cb292ada2c4048",
        "method": "ed25519-v2",
        "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",
        "result": "UN7NEkTYpsrG+JVq+3q/S+1GK2AHxlKAzpqCEi7+01b9UiUTHsJwlAwWRbQ580uLTVwrilu1v0vJGJ/yDjvMCQ=="
      },
      {
        "custom": {
          "luid": "$ldg.-01dNJEZnRJC2YjP5",
          "moment": "2025-03-13T16:41:54.654Z",
          "status": "created"
        },
        "digest": "9d2424469066b8c10248f89cf23ef7d74bdab024047fe2088a67e5ef1c0644d3",
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "result": "/AERNZ/QFhEJnEz7lP3CVQboV+7r4ZGc0QGVO1hUyZON3o7KNnwJVo5W4iK9W8099ypcHSWrs3dz7VTJEVfCBQ=="
      },
      {
        "custom": {
          "moment": "2025-03-13T19:53:57.329Z",
          "status": "active"
        },
        "digest": "6ebfac0df8c394c54a15a0b27c1bd7af7986721ac8e06ca86b933183ad7cfa3c",
        "method": "ed25519-v2",
        "public": "fIMGdPIslGuhtlT5w6+nPw060KTDc55/3ELFjjgW0HA=",
        "result": "83X0wtplg9fZ2JUqd1Ag+dEFqe5J1i9R58QIXRNk07erp4r3XUUCg6uvmo164p4xAJvi7qHqp0fOkdl3DcRxBw=="
      }
    ],
    "status": "active",
    "moment": "2025-03-13T19:53:57.162Z",
    "owners": [
      "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Check access in a ledger instance

POST
/ledger/access/\!check

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Request Body

application/json

Access check payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/ledger/access/\!check" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "82ec2db864a10213d3a53faf0c48b482adf95be5b7cecfa05fdce05887db0a70",    "data": {      "action": "update"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "5/D70vBo3RcMvfJFKgpfuW4t7MhJNhSPA510WGJhHHE=",          "digest": "5d68f5440e5e5dbc4773d038a9e06b7e3dae49d3f4ca804846630f21490ca759",          "result": "Et5mTXlWVoMKMUhB2z+VA7LeXjXFT0WPWjBL+A2WjWRw6DsPNy/0FTRYncFk+aYrAHFGksnqETAZ3GGImErvCw==",          "custom": {            "moment": "2025-03-13T16:41:55.015Z"          }        }      ]    }  }'
{
  "hash": "f8d18bb947f0c5be7dfb77bb704d6c3a23d1a4750603e6a579043a48d6628c47",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "digest": "555e59607e3684493200cd3628b0aa970c9ae3ed298ffb72161a4942558ec949",
        "result": "ycvz61RWZ3KwJmpWRIFVtVQuEFeUuQgBVCWtJyidSxGLqwDitTfuq+iVjRLO3Gd6pzUMsM00j9aVSWq7EhbtAA==",
        "custom": {
          "moment": "2025-03-13T16:41:55.031Z"
        }
      }
    ]
  },
  "data": [
    {
      "hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
      "data": {
        "action": "any",
        "record": "any"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
            "digest": "4a3be8a88feb5c4a29c77ba9e289357a827abf5fd5fb40407f8a4e42bb7a8bce",
            "result": "MqTBOJ1b/ZX9tnGEc7JU2P0oI+rO8y900g9B/Vwi/jrQXseJu/TTErLKF/xFE46vc+j9d5li0zsOG4DpzUfWDw==",
            "custom": {
              "moment": "2025-03-13T16:41:55.030Z"
            }
          }
        ]
      }
    }
  ]
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

List ledger instance changes

GET
/ledger/changes

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Query Parameters

page?

Page query parameters

filter?

Base filter parameters

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3000/v2/ledger/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "b83be3bfb697ae59e3078b6e0ab93c0a58506423687cd4599f15199dc00275b4",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "m2NwLlBdic4a4fJgX18gy4QnaFXcIHCs6msJcQbzsUA=",
        "digest": "1319c6c787204102d542d5f26a7105b4cdefc7f1c5d4182cd05a2f6205cb7279",
        "result": "xlrWNtWk2pFPg1EM5hKO1EPaP71BxJlv1X3Lg5mfanA4/7tV6Kh3tmq8yt9o7iZTXi/0XEXvY+DGOlNzrcYGAA==",
        "custom": {
          "moment": "2025-03-13T16:41:54.998Z"
        }
      }
    ]
  },
  "data": [
    {
      "hash": "ff720aff30241370d4521576a9ce29066f7b6c6462876266ac1b3060074b8aa7",
      "luid": "$ldg.-01dNJEZnRJC2YjP5",
      "meta": {
        "moment": "2025-03-13T16:41:54.893Z",
        "change": 2,
        "action": "update"
      },
      "data": {
        "parent": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
        "handle": "open-ledger",
        "signer": "system",
        "custom": {
          "city": "New York",
          "country": "USA"
        },
        "access": [
          {
            "action": "any",
            "record": "any"
          }
        ],
        "config": {
          "anchor.walletRequired": true,
          "request.journalingEnabled": true,
          "intent.expiryThresholdMinutes": 70,
          "intent.creditorInitiatedTransfersEnabled": false,
          "policy.scheduleProcessorEnabled": false
        }
      }
    },
    {
      "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
      "luid": "$ldg.-01dNJEZnRJC2YjP5",
      "meta": {
        "moment": "2025-03-13T16:41:54.645Z",
        "change": 1,
        "action": "create"
      },
      "data": {
        "handle": "open-ledger",
        "signer": "system",
        "custom": {
          "city": "New York",
          "country": "USA"
        },
        "access": [
          {
            "action": "any",
            "record": "any"
          }
        ],
        "config": {
          "anchor.walletRequired": true,
          "request.journalingEnabled": true,
          "intent.expiryThresholdMinutes": 60,
          "intent.creditorInitiatedTransfersEnabled": false,
          "policy.scheduleProcessorEnabled": false
        }
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 10,
    "total": 2
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

Read a ledger change

GET
/ledger/changes/{change}

Authorization

BearerAuth
AuthorizationBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Path Parameters

change*integer

The change number of the record

Range1 <= value

Header Parameters

x-ledger?|

The unique identifier of ledger in context for multi tenant requests.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3000/v2/ledger/changes/3" \  -H "x-ledger: rtp-ledger"
{
  "hash": "d241123510d957df7dc371feb52a5129545d81b15af1fde2893eccb2079858e3",
  "luid": "$ldg.-01dNJEZnRJC2YjP5",
  "meta": {
    "moment": "2025-03-13T16:41:54.645Z",
    "change": 1,
    "action": "create"
  },
  "data": {
    "handle": "open-ledger",
    "signer": "system",
    "custom": {
      "city": "New York",
      "country": "USA"
    },
    "access": [
      {
        "action": "any",
        "record": "any"
      }
    ],
    "config": {
      "anchor.walletRequired": true,
      "request.journalingEnabled": true,
      "intent.expiryThresholdMinutes": 60,
      "intent.creditorInitiatedTransfersEnabled": false,
      "policy.scheduleProcessorEnabled": false
    }
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

{
  "hash": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
  "data": {
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\"",
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\\\-+.]+$\""
        }
      ]
    }
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "vL8jKxm5PqTnJfEaRs2uOdY7gzX4CS9WbHlN3cAiBV0=",
        "digest": "3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4c7b0a3f6e",
        "result": "uYxJLd2QGkEfT8rP7mCn1lHVzBvIaSK4jFqpO5ZwW9oADnMbg6yeiUsvN3tcXj0RwYxkrq5aLm9f4y2Ko8WwDw=="
      }
    ]
  }
}

{
  "hash": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "KxiLpB3v8VEdmYsT2RwNq5o1Cz9gHJfU4aAySt7D0X8=",
        "digest": "e1d4c7b0a3f6e9d2c5b8a1f4e7d0c3b6a9f2e5d8c1b4a7f0e3d6c9b2a5f8e1d4",
        "result": "LzRmNh7x5TQYoqjw30BKDaZnbGcFUsX8v4tpEsr9P6iW1dyJkVC2uALfY8HdpM3eX9w0On12cqYxEtveKoFZDQ=="
      }
    ]
  }
}

API Reference

Complete REST API reference for the Minka Ledger. Browse endpoints by resource.

Intent

An Intent represents a request to perform one or more balance movements in the ledger. It is composed of claims, each describing a specific action, such as transferring funds from one wallet to another. The ledger processes all claims within an intent atomically, ensuring that either all actions succeed or none do, maintaining data integrity. Each intent has a unique handle for idempotency and easy retrieval. Additionally, intents can include custom metadata to provide context about the operation, such as invoice numbers or payment descriptions.

On this page

No Headings