API Reference

Wallet

A Wallet is a ledger record that represents an entity capable of holding balances of various symbols, such as currencies or points. Each wallet is identified by a unique, user-defined handle, which can be a phone number, email, or any memorable identifier relevant to the use case. Wallets are versatile and can model a wide range of financial concepts, including bank accounts, loyalty programs, subscriptions, or loans, by associating them with appropriate symbols and balances.

List wallets

GET
/wallets

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/wallets?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "06adb44c9fae5c167ee823a6b59dc9d73dbf85d16ef6d74d77b6d6539c4f73b2",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "7e046ac4f6280bbbf336f4fcf5017b0fce19f7ec55365c3ae95fe5e677a2cdee",
        "result": "RQyL7UBk6qzJYAmqZbUjQfIZN19Vv/ZDGTC8sl+KSMibBT5s+ZNfBTu++PLjaVUoBnnJd2tBGZQEsQmme5xLCw==",
        "custom": {
          "moment": "2025-04-02T05:10:33.685Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.684Z"
  },
  "data": [
    {
      "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
      "data": {
        "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
        "handle": "bank-wallet",
        "custom": {
          "name": "Updated Bank Wallet",
          "status": "active",
          "description": "Updated primary wallet for banking operations"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$wlt.-08478ypxQPyJOg5b",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:32.267Z"
            },
            "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478ypxQPyJOg5b",
              "moment": "2025-04-02T05:10:32.283Z"
            },
            "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "onboarded",
              "operation": "onboarding"
            },
            "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA=="
          }
        ],
        "status": "onboarded",
        "moment": "2025-04-02T05:10:32.281Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    },
    {
      "hash": "e4283b7f2b9b93a879609b3c83c86f38fff90ea36f770b12b66562bdba97e131",
      "data": {
        "handle": "tel:7027156866",
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$wlt.-08478TCnzVICBPIM",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.453Z",
              "status": "created"
            },
            "digest": "ebbbb086c45a3c16f850f4dd5b8b271920b757023bce74c5721a8b8bbd851c2a",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "vBTsJMxdDUryw+31y/k5eUo/gF4UdrgIc7vh2PQvMTt1eRBlmQMGHUxDrbqQTE55r4xfkgpFqOxNQpD3L2DcBQ=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478TCnzVICBPIM",
              "moment": "2025-04-02T05:10:31.472Z",
              "status": "created"
            },
            "digest": "b85d6c459d8966414e77390891ea4fd0a2f9d1ea18cfec4a81f0514133653d7e",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "QpCA9r5WP289GCsfTAemLbiSsWawLupEP3g9G/P1AzbFSbMddpeffRIVySYrdrES8HeTAjXi/TXmjXU90tI0Aw=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.470Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    },
    {
      "hash": "7caee952bb9c0bd30c21db10771d81c35db7be9e5e818254ad3f8e74dc5e9eeb",
      "data": {
        "handle": "tran:254085257323@minka.io",
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$wlt.-08478v8v7tjld-ao",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.073Z",
              "status": "created"
            },
            "digest": "9703fac828fe9d48d3a5053743c60d4d1149e6d321970f09fb3d70b1a7e99c03",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "kCvVPLe5ryb6qa0vnNzfO5Iw+81PryG+dusMvVzD3RJYDIhWlPeY+mw1LrcgPE5ihqH86P6Wn/0KUImncS7jAQ=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478v8v7tjld-ao",
              "moment": "2025-04-02T05:10:31.086Z",
              "status": "created"
            },
            "digest": "56cdebab93220075b890efe1c1669af1ef53fd4bcce2ad8c5a27578ccdba856a",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "WdLvZGsPn1QSDO/4WwsssSTCps5R1X5MLY7PuxZj6UPTEw2Cu0EgJb8zqXZ7W76GuavKH6M0bLpb8CiOScbBAA=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.083Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    },
    {
      "hash": "7b354caad389eea3df23c9f693f04ce92d071daf587b9265c91abd62daa3a196",
      "data": {
        "handle": "svgs:452203815337@teslabank.io",
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$wlt.-08478bWHzeCAJFEh",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.050Z",
              "status": "created"
            },
            "digest": "94634e9a08933211cc69c2318175508bc3ffbb62af4f8db640a62b520e116665",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "L2pA3yOBbQoCishbP8z8whV3oKCACn4qa5LeKEJgkXqloxt7ptn6GyYQRcg9UkVgPfKcyzxJdmVH/3BLIsDhCA=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478bWHzeCAJFEh",
              "moment": "2025-04-02T05:10:31.063Z",
              "status": "created"
            },
            "digest": "bf0acf496c7767970ed6eff34526587865fb5230ba12434393d1b1b3e2ce369b",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "ELJhUhlzqFzjQbtUzhSvlJIvvs5AvZZXkP6HEiNwIQWP3dAx2AfVhXvltfnAnCe+nCdGQalwjfwCozU8UiB0Aw=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.060Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 10
  }
}
{
  "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 wallet

POST
/wallets

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

Wallet 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/wallets" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",    "data": {      "handle": "bank-wallet",      "access": [        {          "action": "any",          "signer": {            "$record": "owner"          }        },        {          "action": "read",          "bearer": {            "$signer": {              "$record": "owner"            }          }        }      ]    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "8b85e49e5eb9a8175119c90828e14f7ccdc029653541c1899abc2df706315604",          "result": "JXzIM0pOrfEUlMqEodFVtKF4Q7rH5IlR2YIufJr0fn2srLEx97Mu/zytXsl/9lpJcho32/jHW9QKdWSVJqs+CQ==",          "custom": {            "moment": "2025-04-02T05:10:31.095Z",            "status": "created"          }        }      ]    }  }'
{
  "hash": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
  "data": {
    "handle": "bank-wallet",
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.095Z",
          "status": "created"
        },
        "digest": "8b85e49e5eb9a8175119c90828e14f7ccdc029653541c1899abc2df706315604",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "JXzIM0pOrfEUlMqEodFVtKF4Q7rH5IlR2YIufJr0fn2srLEx97Mu/zytXsl/9lpJcho32/jHW9QKdWSVJqs+CQ=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:31.109Z",
          "status": "created"
        },
        "digest": "b1e5a0da2b6cd6c51bbbc83239ebea2f7a5efa249719b4c4ffde60361119bd8e",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "UjF6mkKH3MHflh9T8ksBceQwXe1Qok3bkQKL+XEzf1vFEX8RsEfhz89WsIblBXrrlcTKpQM1E/RpUbCFaUaICQ=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.106Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "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": "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 wallet

GET
/wallets/{id}

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

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/wallets/string" \  -H "x-ledger: rtp-ledger"
{
  "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
  "data": {
    "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
    "handle": "bank-wallet",
    "custom": {
      "name": "Updated Bank Wallet",
      "status": "active",
      "description": "Updated primary wallet for banking operations"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:32.267Z"
        },
        "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:32.283Z"
        },
        "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "onboarded",
          "operation": "onboarding"
        },
        "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA=="
      }
    ],
    "status": "onboarded",
    "moment": "2025-04-02T05:10:32.281Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "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 wallet

DELETE
/wallets/{id}

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Header Parameters

x-ledger?|

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

Request Body

application/json

Wallet 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/wallets/string" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "e4283b7f2b9b93a879609b3c83c86f38fff90ea36f770b12b66562bdba97e131"    },    "hash": "690991880046a704481e4f75e32dcf7331960606fbf00d5046f246d9e888c1d2",    "luid": "$wlt.-08478TCnzVICBPIM",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "ef8ad39c9c0d86bda17927fce52c851a3106c38867445bf2039fbce689ba6e62",          "result": "dMLHHBGtoGNodR7qXj54S04qEfppDrSiEhNvE40Z8sY9LsUkYWqJt3Oc/0OW67YDvmNWfRZOUPscpw7UU2WUAw==",          "custom": {            "moment": "2025-04-02T05:10:33.976Z",            "status": "dropped"          }        }      ],      "status": "created",      "owners": [        "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="      ]    }  }'
""
{
  "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 wallet

PUT
/wallets/{id}

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Header Parameters

x-ledger?|

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

Request Body

application/json

Wallet 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/wallets/string" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",    "luid": "$wlt.-08478ypxQPyJOg5b",    "data": {      "handle": "bank-wallet",      "access": [        {          "action": "any",          "signer": {            "$record": "owner"          }        },        {          "action": "read",          "bearer": {            "$signer": {              "$record": "owner"            }          }        }      ],      "custom": {        "name": "Updated Bank Wallet",        "description": "Updated primary wallet for banking operations",        "status": "active"      },      "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",          "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw==",          "custom": {            "moment": "2025-04-02T05:10:32.267Z"          }        }      ]    }  }'
{
  "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
  "data": {
    "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
    "handle": "bank-wallet",
    "custom": {
      "name": "Updated Bank Wallet",
      "status": "active",
      "description": "Updated primary wallet for banking operations"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:32.267Z"
        },
        "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:32.283Z"
        },
        "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:32.281Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "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 wallet

POST
/wallets/{id}/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

Path Parameters

id*|

The unique identifier of the record - it is luid or handle (address).

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/wallets/admin/proofs" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "method": "ed25519-v2",    "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",    "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",    "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA==",    "custom": {      "moment": "2025-04-02T05:10:30.823Z",      "status": "onboarded",      "operation": "onboarding"    }  }'
{
  "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
  "data": {
    "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
    "handle": "bank-wallet",
    "custom": {
      "name": "Updated Bank Wallet",
      "status": "active",
      "description": "Updated primary wallet for banking operations"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:32.267Z"
        },
        "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:32.283Z"
        },
        "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "onboarded",
          "operation": "onboarding"
        },
        "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA=="
      }
    ],
    "status": "onboarded",
    "moment": "2025-04-02T05:10:32.281Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "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 wallet instance

POST
/wallets/{id}/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

Path Parameters

id*|

The unique identifier of the record - it is luid or handle (address).

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/wallets/admin/access/\!check" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "82ec2db864a10213d3a53faf0c48b482adf95be5b7cecfa05fdce05887db0a70",    "data": {      "action": "update"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "93bdfe3d0549aa887e2b3a1ac23813476862b52815cdc232bd4cce68eca02ea9",          "result": "d1oui5DhuFhA469TsBO0HCkgPhETxgZQeS3tfro2RZac2tMYJsf7NTOISQx8MAeipH9wMjvWSWFPYVhvfzfSDg==",          "custom": {            "moment": "2025-04-02T05:10:32.912Z"          }        }      ]    }  }'
{
  "hash": "472a7244cdc88cbef6a50e4bd19cf50140b3aeffc74f18103c719a0cf77c8ca1",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "a1b60cf3cef24cff8d0c2cb9b06ffb716cba14ca237b7a046612ff77ab16ad30",
        "result": "NBkdjqaAUZB9AtgXh9X39KXvMbETpbUxMkN1T+l/65FWWEGlIqW0TO1/OOeDwHVSkLF+cbsCKmtwcAfqb03uAA==",
        "custom": {
          "moment": "2025-04-02T05:10:32.926Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:32.926Z"
  },
  "data": [
    {
      "hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
      "data": {
        "action": "any",
        "record": "any"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "cb5da5ae1cfe4d7a9fc188bcc92c7452f97e3577515b07e41f75ee555131762d",
            "result": "XJ/PDjlIjb75lApxwMepF2k4yBe4ExYGM0CFcnlwKFrkkWLcsoSGgRPRkrxgNMkT8GgcFeyOzk7HU+K461ncAQ==",
            "custom": {
              "moment": "2025-04-02T05:10:32.925Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.925Z"
      }
    },
    {
      "hash": "43574ed3e43e589e649ec6afc05f45386887d62eea3a11d346fa959121c969cb",
      "data": {
        "action": "any",
        "record": "wallet"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "c0747b7c13fd3759225e0685e1d21c9ac0c149f08fac019f5ba8372c12cb1a15",
            "result": "1YrfxFuOxPyh8WRrAHi4ViH8Ur6qHX2cWXiBC2at3r08CTTsvB1d7bu03LTpPFm2OnkVeNveJeQuU+G0iqlJAA==",
            "custom": {
              "moment": "2025-04-02T05:10:32.925Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.925Z"
      }
    }
  ]
}
{
  "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 wallet

POST
/wallets/{id}/drop

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Header Parameters

x-ledger?|

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

Request Body

application/json

Wallet 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 POST "http://localhost:3000/v2/wallets/string/drop" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "e4283b7f2b9b93a879609b3c83c86f38fff90ea36f770b12b66562bdba97e131"    },    "hash": "690991880046a704481e4f75e32dcf7331960606fbf00d5046f246d9e888c1d2",    "luid": "$wlt.-08478TCnzVICBPIM",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "ef8ad39c9c0d86bda17927fce52c851a3106c38867445bf2039fbce689ba6e62",          "result": "dMLHHBGtoGNodR7qXj54S04qEfppDrSiEhNvE40Z8sY9LsUkYWqJt3Oc/0OW67YDvmNWfRZOUPscpw7UU2WUAw==",          "custom": {            "moment": "2025-04-02T05:10:33.976Z",            "reason": "Wallet is no longer needed. Dropped by user.",            "status": "dropped"          }        }      ],      "status": "created",      "owners": [        "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="      ]    }  }'
""
{
  "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 wallet limits

GET
/wallets/{id}/limits

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

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/wallets/string/limits" \  -H "x-ledger: rtp-ledger"
{
  "hash": "2de4b6bf92187370f55f948c55b0871b7bd3e830c4ef709fc72fc0dff2dba651",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "3f942d8ab967fe9b695f6ac4e9f9cc340cb45baa8f5248f406e2b41c775629f8",
        "result": "UG2qM/N1uEaleIuBL4DzRtp6SayHiQS2iUtpJFbMZhNZA+Gb1aZvR3v9UUrX52F3Egj40yVcQ1snYH5HYM4CCQ==",
        "custom": {
          "moment": "2025-04-02T05:10:33.710Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.710Z"
  },
  "data": [
    {
      "hash": "340ba8bd7b006370f246453bbe2d379a071f1f4186c72719a552bc3c59dae4bd",
      "data": {
        "wallet": "bank-wallet",
        "symbol": "usd",
        "metric": "dailyAmount",
        "amount": 200000000
      },
      "luid": "$wbl.-08478tSGEZJxrLgM",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.233Z"
            },
            "digest": "4354eaca21ec6536f3630cb7942f99b9b9dd5d166e5ae6043fa3a513ee80df15",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "Poc9BDXuUbuF3RB0N3zOp8k9vYE4o3Qc+lWGUWcm0tYdQB0DYXOHZj4hZ0xAxGVgpmnsZZ9iedjZovVbggL/Aw=="
          }
        ],
        "moment": "2025-04-02T05:10:31.228Z"
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 20,
    "total": 1
  }
}
{
  "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 wallet anchors

GET
/wallets/{id}/anchors

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Query Parameters

page?

Page query parameters

filter?

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/wallets/string/anchors?limit=20&index=0" \  -H "x-ledger: rtp-ledger"
{
  "hash": "731a445edbeb8d29532891798c753e6834eb012ec15d7f7f507bec56426fa2cb",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "f7e9f5a7fbbdba616b10223cded8b44a7856fa662a2be29f1d6797dfaba01d93",
        "result": "gVT3dUdhEoSRiflesXTXARnXajMI7/IivtLXYIB9esteeJct81wSYmM2tqWXTAw6n/UVvWel0EYEgjZ6JEzDBw==",
        "custom": {
          "moment": "2025-04-02T05:10:33.764Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.764Z"
  },
  "data": [
    {
      "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
      "data": {
        "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
        "handle": "svgs:-vqibKLJKikP@teslabank.io",
        "wallet": "tel:7027156866",
        "target": "tran:254085257323@minka.io",
        "symbol": "usd",
        "custom": {
          "name": "Keyon",
          "idType": "nidn",
          "status": "verified",
          "idNumber": "IJdEsSmS",
          "entityType": "individual",
          "lastUpdated": "2025-04-02T05:10:30.822Z"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      },
      "luid": "$anc.-0847869HxNkGI2-Z",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.934Z"
            },
            "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
          },
          {
            "custom": {
              "luid": "$anc.-0847869HxNkGI2-Z",
              "moment": "2025-04-02T05:10:31.951Z"
            },
            "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "connected",
              "operation": "connection"
            },
            "digest": "4d0795a5f34af6a593572b743ba0632855866b940273e6042d6b4d928f120eae",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "B5qfgUhvwY+MnAY+zvmwZwRrmQcD25cUl7pBpfgMKpAUR8CzLA6MIj2zdRnQtsWGnLEj7xsj9dNhkgbjt71YCA=="
          }
        ],
        "status": "connected",
        "moment": "2025-04-02T05:10:31.950Z",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ]
      }
    }
  ]
}
{
  "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=="
      }
    ]
  }
}

Named query for fetching anchors

POST
/wallets/{id}/anchors/\!lookup

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Header Parameters

x-ledger?|

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

Request Body

application/json

Anchor lookup 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/wallets/string/anchors/\!lookup" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "ab2dcf2efbd4ec00b0005778e53b7d64fc1574f8d20327ab20ff6dda44b69e05",    "data": {      "wallet": "tel:7027156866"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "ef0668e3b3307cf582a8c58bdf22dccf0f3165d14c3553bed88969e25054c896",          "result": "qKWfWzMeHnAxOUbplU6ljYkUVJ3wuhWm7EFBz5DZpIxyp43XD5ksq7JaA2ZPoLLU/sKC9go1DqOIGoBm5KeXBw==",          "custom": {            "moment": "2025-04-02T05:10:33.768Z"          }        }      ]    }  }'
{
  "hash": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "8fc3d5098ffd4ba2e6f6216b2f8bde8170a2daad4e2fce239338aee9e514b299",
        "result": "HimX61Ao7D4MRf6C9UvGnB/TJ/sjgg9Gzmdp1qnRgsSodkMd3pkZgSlocLRMAA0ofBrNRw9PWLa5VHTVP2nWBQ==",
        "custom": {
          "moment": "2025-04-02T05:10:33.789Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.789Z"
  },
  "data": []
}
{
  "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 wallet domains

GET
/wallets/{id}/domains

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

Query Parameters

page?

Page query 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/wallets/string/domains?limit=20&index=0" \  -H "x-ledger: rtp-ledger"
{
  "hash": "4f53cda18c2baa0c0354bb5f9a3ecbe5ed12ab4d8e11ba873c2f11161202b945",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "20308fbb553dbbc59d36d77d578159239bb99080c53842aafc198222101f8e1d",
        "result": "ntqn/WRquWC1uV3NiyjuwaS0lklFwtw1JIHcR5ogfmnWBQQ2GfomzU5gMTlvTP53MirDjuH/PqQClfZmv5n5Cg==",
        "custom": {
          "moment": "2025-04-02T05:10:33.725Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.725Z"
  },
  "data": []
}
{
  "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 a wallet changes

GET
/wallets/{id}/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

Path Parameters

id*|

The unique identifier of the wallet record - it is luid or handle (address).

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/wallets/string/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "2764034352c996ff63b800ac3f5deaa7d4fcbc31ba5e750034698cd089283ceb",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "96f0d09f3bcfe0ded4a07ecf6fc864c7ad0544e808c5a6577bfea15ee709b13d",
        "result": "gn7vqgWTPBGJd01becbolfFeHni2nGIX3+vSibRboki08Y+He4QvHSnjdwCIE+yBjXWfJrEHB4qbxbNoTI/BAg==",
        "custom": {
          "moment": "2025-04-02T05:10:33.814Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.814Z"
  },
  "data": [
    {
      "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
      "luid": "$wlt.-08478ypxQPyJOg5b",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:32.267Z"
            },
            "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478ypxQPyJOg5b",
              "moment": "2025-04-02T05:10:32.283Z"
            },
            "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "onboarded",
              "operation": "onboarding"
            },
            "digest": "80f31d6fc8c9dedea9be9f56d75374f681d507a469a058344f96d76d8c1eb22a",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "BlBU3f1lwMlqor46VnlcG3RaaXTNWP4qaF0ekFt6x6PbDe8lZin7n+5AoHmbch01AzgI7v4Sx8VdgMGiw0oGDA=="
          }
        ],
        "status": "onboarded",
        "moment": "2025-04-02T05:10:32.729Z",
        "change": 3,
        "action": "update",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
        "handle": "bank-wallet",
        "custom": {
          "name": "Updated Bank Wallet",
          "status": "active",
          "description": "Updated primary wallet for banking operations"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      }
    },
    {
      "hash": "ea5d148b0db152db450cd8eb39bd6a08b1fffd9c5939ac9701b17aceb47e0e77",
      "luid": "$wlt.-08478ypxQPyJOg5b",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:32.267Z"
            },
            "digest": "acc4a22e416dc43e82431922bd09cdedc1a26c62c2a7760af3a3954d698e88bc",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "5eLklbr1Al/ZmYTWa38lk5gUngbc9J8bnpBthUJNXPr/0qeb8O1hXbITAO9qjX0SECyxSHiWfCQrf5TqAoAtCw=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478ypxQPyJOg5b",
              "moment": "2025-04-02T05:10:32.283Z"
            },
            "digest": "f5641460ca9dec5b6123993a65da3ea3fa513f2578a04c7a308a00572d9ae475",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "x6gDmR5EN6KTt0nPezhgpM1IIy71KAD2WDlxznsCtPCYLGZVxAHJqV/F59d3exoTFzGdc4B52vE6AMf2t/EKCg=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:32.281Z",
        "change": 2,
        "action": "update",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "parent": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
        "handle": "bank-wallet",
        "custom": {
          "name": "Updated Bank Wallet",
          "status": "active",
          "description": "Updated primary wallet for banking operations"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      }
    },
    {
      "hash": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
      "luid": "$wlt.-08478ypxQPyJOg5b",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.095Z",
              "status": "created"
            },
            "digest": "8b85e49e5eb9a8175119c90828e14f7ccdc029653541c1899abc2df706315604",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "JXzIM0pOrfEUlMqEodFVtKF4Q7rH5IlR2YIufJr0fn2srLEx97Mu/zytXsl/9lpJcho32/jHW9QKdWSVJqs+CQ=="
          },
          {
            "custom": {
              "luid": "$wlt.-08478ypxQPyJOg5b",
              "moment": "2025-04-02T05:10:31.109Z",
              "status": "created"
            },
            "digest": "b1e5a0da2b6cd6c51bbbc83239ebea2f7a5efa249719b4c4ffde60361119bd8e",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "UjF6mkKH3MHflh9T8ksBceQwXe1Qok3bkQKL+XEzf1vFEX8RsEfhz89WsIblBXrrlcTKpQM1E/RpUbCFaUaICQ=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.106Z",
        "change": 1,
        "action": "create",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "handle": "bank-wallet",
        "access": [
          {
            "action": "any",
            "signer": {
              "$record": "owner"
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 10,
    "total": 3
  }
}
{
  "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 wallet change

GET
/wallets/{id}/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
id*|

The unique identifier of the wallet record - it is luid or handle (address).

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/wallets/string/changes/3" \  -H "x-ledger: rtp-ledger"
{
  "hash": "4298573b4fec0885d45b20d7063056e9db4de15c639bc7ecf20d45954745b2d0",
  "luid": "$wlt.-08478ypxQPyJOg5b",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.095Z",
          "status": "created"
        },
        "digest": "8b85e49e5eb9a8175119c90828e14f7ccdc029653541c1899abc2df706315604",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "JXzIM0pOrfEUlMqEodFVtKF4Q7rH5IlR2YIufJr0fn2srLEx97Mu/zytXsl/9lpJcho32/jHW9QKdWSVJqs+CQ=="
      },
      {
        "custom": {
          "luid": "$wlt.-08478ypxQPyJOg5b",
          "moment": "2025-04-02T05:10:31.109Z",
          "status": "created"
        },
        "digest": "b1e5a0da2b6cd6c51bbbc83239ebea2f7a5efa249719b4c4ffde60361119bd8e",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "UjF6mkKH3MHflh9T8ksBceQwXe1Qok3bkQKL+XEzf1vFEX8RsEfhz89WsIblBXrrlcTKpQM1E/RpUbCFaUaICQ=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.106Z",
    "change": 1,
    "action": "create",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ],
    "labels": null
  },
  "data": {
    "handle": "bank-wallet",
    "access": [
      {
        "action": "any",
        "signer": {
          "$record": "owner"
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  }
}
{
  "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 balances of wallet

GET
/wallets/{id}/balances

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

id*|

The unique identifier of the wallet record - it is luid or handle (address).

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/wallets/string/balances?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "362c6ba85d1b140bb179c2aa2d718c7b9eaacfab79c3ac1f901c68b92fb8203f",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "76c179951a90a5d4044a600b40e88f4e47dae11d47dedeafaaa8fe6b35d81979",
        "result": "4CFvYQnByav39vD2qihI2+iGDUTyxNit0pJG6uGBVUZMFMVMixlRMp27SENRQ2Yp/WlkMkNKp+4uTeKWq0JoCA==",
        "custom": {
          "moment": "2025-04-02T05:10:33.738Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.738Z"
  },
  "data": [
    {
      "hash": "9e7715f1c3f4c5d308d7d1a6a0234e2341f95dfc8c97cc9460b01c2c5a8d1322",
      "data": {
        "wallet": "bank-wallet",
        "symbol": "usd",
        "amount": 12345
      },
      "luid": "$wbl.-08478eGy_dZtugTG",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.402Z"
            },
            "digest": "3252be7da9159d548fb51ad0a03eaf7607dc5c87b30146c5a419931fbe2d7106",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "56Y5s4NhFw6g5mXctdkZU6Xxg0SR4PXAyVH+iVJA3AVOyCdhxirOvJgWHsczVHZhKgjc8vYJYdQoVrt+4LKWBA=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.402Z"
            },
            "digest": "3252be7da9159d548fb51ad0a03eaf7607dc5c87b30146c5a419931fbe2d7106",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "56Y5s4NhFw6g5mXctdkZU6Xxg0SR4PXAyVH+iVJA3AVOyCdhxirOvJgWHsczVHZhKgjc8vYJYdQoVrt+4LKWBA=="
          }
        ],
        "moment": "2025-04-02T05:10:31.394Z"
      }
    }
  ],
  "page": {
    "index": 0,
    "limit": 20,
    "total": 1
  }
}
{
  "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=="
      }
    ]
  }
}

On this page

No Headings