API Reference
Symbol
A Symbol is a ledger record that defines a unit of exchange, such as a currency, loyalty points, or any countable asset. Each balance in the ledger is associated with a specific symbol, indicating what the balance represents. The owner of a symbol has the authority to issue new units of that symbol, controlling its supply. However, once units are issued and transferred to other wallets, the symbol owner cannot control their circulation; the holders of the balances have full control over their assets.
List symbols
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/symbols?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "4df4ccc24879e1b4056d855b63e518584da4cef4e72d412360ed9ba8a305941e",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "38e66954d9b9dea7fa5908316b727d7286b5655d85d19a3b71b3cc0ab904cf5f",
"result": "fRBcTMmK2StBZynnhcpX/qJPLIcIcCpUleo6aT203qbmDzKX49ktDTOIZm5m5iPMNwi9CG9WFEHfYhG5NmS0CQ==",
"custom": {
"moment": "2025-04-02T05:10:33.585Z"
}
}
],
"moment": "2025-04-02T05:10:33.585Z"
},
"data": [
{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "issued",
"operation": "activation"
},
"digest": "6a2ab03d5ca4b178597782e6dc47c6053c8415a5ac49ca40e1dd4df620087fae",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "7v8W9yk9bWlYw/g+KI/odBQIQXC1ouTvMB8GOoU5dxNvJh8EOxyhW/fZOtRGxHOdYK+lRoF7Kwcddfd/wi/aBQ=="
}
],
"status": "issued",
"moment": "2025-04-02T05:10:32.248Z",
"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 symbol
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
Symbol 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/symbols" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd", "data": { "handle": "usd", "factor": 100, "access": [ { "action": "any", "signer": { "$record": "owner" } }, { "action": "read", "bearer": { "$signer": { "$record": "owner" } } } ] }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "69008f870722dc9fd369f057a3cb62a974e3d676793bdd57c3e7f6dc08b59847", "result": "yqFriL7EUBiPr1IvTqGl6YAzuP5sMWes8VS12G2MvDcrNlBE/S6Q4r/FFh7Y79hV8NNL7BLtVpfmmJHcDN6NAQ==", "custom": { "moment": "2025-04-02T05:10:30.823Z", "status": "created" } } ] } }'{
"hash": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"data": {
"handle": "usd",
"factor": 100,
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "created"
},
"digest": "69008f870722dc9fd369f057a3cb62a974e3d676793bdd57c3e7f6dc08b59847",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "yqFriL7EUBiPr1IvTqGl6YAzuP5sMWes8VS12G2MvDcrNlBE/S6Q4r/FFh7Y79hV8NNL7BLtVpfmmJHcDN6NAQ=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:30.851Z",
"status": "created"
},
"digest": "c3fdd35cdef278ba05bea51dd807548091a59ff1dc7dcd6456a13531b958a9a0",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "Q16JX9S5ZJmF1OPirIVI7UB2EZqY4Zhq0TxhQ4qqj/3ipv9Z05rSAgmjtWky9HHExAimkq1zmlb7lrcMG6wxBw=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:30.845Z",
"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 symbol
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.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:3000/v2/symbols/admin" \ -H "x-ledger: rtp-ledger"{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "issued",
"operation": "activation"
},
"digest": "6a2ab03d5ca4b178597782e6dc47c6053c8415a5ac49ca40e1dd4df620087fae",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "7v8W9yk9bWlYw/g+KI/odBQIQXC1ouTvMB8GOoU5dxNvJh8EOxyhW/fZOtRGxHOdYK+lRoF7Kwcddfd/wi/aBQ=="
}
],
"status": "issued",
"moment": "2025-04-02T05:10:32.248Z",
"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 Symbol
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
Symbol 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/symbols/admin" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928", "luid": "$sym.-08477FJUBVHzk-xc", "data": { "handle": "usd", "factor": 100, "access": [ { "action": "any", "signer": { "$record": "owner" } }, { "action": "read", "bearer": { "$signer": { "$record": "owner" } } } ], "custom": { "name": "US Dollar", "symbol": "$", "code": "USD", "description": "United States Dollar" }, "parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd" }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f", "result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA==", "custom": { "moment": "2025-04-02T05:10:32.234Z" } } ] } }'{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.248Z",
"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 symbol
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/symbols/admin/proofs" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "6a2ab03d5ca4b178597782e6dc47c6053c8415a5ac49ca40e1dd4df620087fae", "result": "7v8W9yk9bWlYw/g+KI/odBQIQXC1ouTvMB8GOoU5dxNvJh8EOxyhW/fZOtRGxHOdYK+lRoF7Kwcddfd/wi/aBQ==", "custom": { "moment": "2025-04-02T05:10:30.823Z", "status": "issued", "operation": "activation" } }'{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "issued",
"operation": "activation"
},
"digest": "6a2ab03d5ca4b178597782e6dc47c6053c8415a5ac49ca40e1dd4df620087fae",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "7v8W9yk9bWlYw/g+KI/odBQIQXC1ouTvMB8GOoU5dxNvJh8EOxyhW/fZOtRGxHOdYK+lRoF7Kwcddfd/wi/aBQ=="
}
],
"status": "issued",
"moment": "2025-04-02T05:10:32.248Z",
"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 symbol instance
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/symbols/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": "f9f05e64b2f2edd4c3b89075c48bb0f878ba54e047f93d5dd040437f6bb50654", "result": "NE/3QqmJ1/D2Dq/joOYsEPoM4l2ryWl4iE4+hOPDycC6TJ4yBvFag8FK7a7Z9/aoA/234k+UcN6sOV+FxjyiAQ==", "custom": { "moment": "2025-04-02T05:10:32.895Z" } } ] } }'{
"hash": "b45bd8afb48afd29cbe05290327e4ffbc8bf009a984229523f9d13a5dbe5c17f",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "f2fc89238a192ab5ddaaf31aa1a696c02d8fcf75acc11bc336ccb716ba5f8044",
"result": "uwgYXN9+XIfcy2T1dnZ2l8PILKG4GAFXX2qOmGUVXXa9miHh8sSYCNitHgLpgko31SpqEi34mAkYRQTrJ+AcDA==",
"custom": {
"moment": "2025-04-02T05:10:32.909Z"
}
}
],
"moment": "2025-04-02T05:10:32.909Z"
},
"data": [
{
"hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
"data": {
"action": "any",
"record": "any"
},
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "3f5e8e03a0a76dfe9878690a4271c129eb2ea41c5ae1ae43d2ce5c53837f266e",
"result": "FWlt8pNmEp4tIN/N/gscJ6hGvef9ffpreVPExYwkZnVBXqYi4EOtOPDqqAMeQDkk9nqyLvhTJNI4IafBeAbeDQ==",
"custom": {
"moment": "2025-04-02T05:10:32.908Z"
}
}
],
"moment": "2025-04-02T05:10:32.908Z"
}
},
{
"hash": "43f5c90ed05c403743466bad47cabc85ca371e260d00ab680c10c46439361e42",
"data": {
"action": "any",
"record": "symbol"
},
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "b18dadb49ee91352226bf317573d131a8a807324cbfcff8ed97b285cf38f45c9",
"result": "G+bfSCYtcLCsDMjj0hCj03OIVMnzsMPFe1xqWCo3InPa7O56buIoGs+62hzjd2lm5vRNJ5zHIFksMMj7HKbeAQ==",
"custom": {
"moment": "2025-04-02T05:10:32.908Z"
}
}
],
"moment": "2025-04-02T05:10:32.908Z"
}
}
]
}{
"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 symbol 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 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/symbols/admin/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "6675ef6811e64eaff74b0c81ce949b58ceb051b6d4c73ed12f13daad5ed6f74c",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "012ebcce881f94beee3eb76eeb872ccb5d0ca4102ec46c30f3909b3c90243cb4",
"result": "zeZpy+/j9h9jvE3Dumq0hQG8S4LrdQoTGhzY+xoYrqfMyyOPPy6bS9wbOe52qUwtJHmsuaAOkAftaidcwxpECg==",
"custom": {
"moment": "2025-04-02T05:10:33.629Z"
}
}
],
"moment": "2025-04-02T05:10:33.629Z"
},
"data": [
{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "issued",
"operation": "activation"
},
"digest": "6a2ab03d5ca4b178597782e6dc47c6053c8415a5ac49ca40e1dd4df620087fae",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "7v8W9yk9bWlYw/g+KI/odBQIQXC1ouTvMB8GOoU5dxNvJh8EOxyhW/fZOtRGxHOdYK+lRoF7Kwcddfd/wi/aBQ=="
}
],
"status": "issued",
"moment": "2025-04-02T05:10:32.689Z",
"change": 3,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
}
},
{
"hash": "8f8462f38a05435eee5b2cef5026018171de7c39c0b38689ddfd64dcf8642928",
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.234Z"
},
"digest": "33c7f9c35492d322661802c40aeb2836c8f5f03ae556007932619f009c83be8f",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "SDDlBJs6qvb+7zu7lNRS/PYeOjSe2Bjlv8x2IswTEZAIf/oYXlmKUaXF4Gw8/2u5cCUI+V49qGh+dYyyRPKzAA=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:32.250Z"
},
"digest": "643a5038eea780a15879ffbc80e4a5fe949f7f8413fb11f8de4e8bf9d2e2d974",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "TPdziTe2IAKa15u0uprZ/C4gySi/zmklv+YOUmLuQsI8u6TUNLRBDTlxyTOu/e9y6EBF7I76Bu7o9K/rrPhDBg=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.248Z",
"change": 2,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"handle": "usd",
"factor": 100,
"custom": {
"code": "USD",
"name": "US Dollar",
"symbol": "$",
"description": "United States Dollar"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
}
},
{
"hash": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "created"
},
"digest": "69008f870722dc9fd369f057a3cb62a974e3d676793bdd57c3e7f6dc08b59847",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "yqFriL7EUBiPr1IvTqGl6YAzuP5sMWes8VS12G2MvDcrNlBE/S6Q4r/FFh7Y79hV8NNL7BLtVpfmmJHcDN6NAQ=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:30.851Z",
"status": "created"
},
"digest": "c3fdd35cdef278ba05bea51dd807548091a59ff1dc7dcd6456a13531b958a9a0",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "Q16JX9S5ZJmF1OPirIVI7UB2EZqY4Zhq0TxhQ4qqj/3ipv9Z05rSAgmjtWky9HHExAimkq1zmlb7lrcMG6wxBw=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:30.845Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "usd",
"factor": 100,
"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 symbol 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
id*|
The unique identifier of the record - it is luid or handle (address).
change*integer
The change number of the record
Range
1 <= valueHeader 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/symbols/admin/changes/3" \ -H "x-ledger: rtp-ledger"{
"hash": "433b8a6231010fbb1febe6afbbf647f1e2ced9ed1bff8d6700829160558c4dcd",
"luid": "$sym.-08477FJUBVHzk-xc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "created"
},
"digest": "69008f870722dc9fd369f057a3cb62a974e3d676793bdd57c3e7f6dc08b59847",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "yqFriL7EUBiPr1IvTqGl6YAzuP5sMWes8VS12G2MvDcrNlBE/S6Q4r/FFh7Y79hV8NNL7BLtVpfmmJHcDN6NAQ=="
},
{
"custom": {
"luid": "$sym.-08477FJUBVHzk-xc",
"moment": "2025-04-02T05:10:30.851Z",
"status": "created"
},
"digest": "c3fdd35cdef278ba05bea51dd807548091a59ff1dc7dcd6456a13531b958a9a0",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "Q16JX9S5ZJmF1OPirIVI7UB2EZqY4Zhq0TxhQ4qqj/3ipv9Z05rSAgmjtWky9HHExAimkq1zmlb7lrcMG6wxBw=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:30.845Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "usd",
"factor": 100,
"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=="
}
]
}
}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.
Anchor
An Anchor is a ledger record that establishes a connection between a user's wallet in the ledger and an external identifier, such as a bank account number, email, or phone number. This linkage is critical for onboarding users and enabling seamless interactions between the ledger and external systems.