API Reference
Circle
A Circle is a ledger record that defines a group or role comprising multiple signers. By grouping signers into circles, administrators can streamline access control management, granting permissions to entire groups rather than individual signers. This simplifies the process of managing access rules and enhances security by centralizing control.
List circles
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/circles?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "f35058cf3b7d5455a4774276fac8b4776bf704bea96d2833040f7d3a1d68690a",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "781db3ff380ca26e71cb48953b5807d2336b1ce4280e7310dff4f5918c0f957d",
"result": "HxcFBnjivvxlkwqspZ7OUMGZY8MUaP9C0glNcCDuE9oq1WAHXg/DI02Uguje8hwAHBz/brjKBtz25lRf7vuhAw==",
"custom": {
"moment": "2025-04-02T05:10:33.058Z"
}
}
],
"moment": "2025-04-02T05:10:33.058Z"
},
"data": [
{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "verified",
"operation": "verification"
},
"digest": "68b498915db068fc1855260841444eae3414002b21352fbb340aed6669ba4cd4",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "RRqHxHkvQNWksHbY1yQjlvvKvh9lKb/AR9R+heyRGkfr7tzeZBWQcL7pMBIcxar0YWluh27b6x8r+l1OzVnyBQ=="
}
],
"status": "verified",
"moment": "2025-04-02T05:10:32.013Z",
"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 circle
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
Circle 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/circles" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7", "data": { "handle": "support", "access": [ { "action": "any", "signer": { "$record": "owner" } }, { "action": "read", "bearer": { "$signer": { "$record": "owner" } } } ] }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "73fb95031971bb9a6f40cc77493f1352df914804a57306d07d1fdb2b045e1f5a", "result": "cUsYY6gB05SH908KlJKoYlVxm5v389XYDnZZjPJgD8382S0WATrhCpbpFCw2u9+mSSWvnboNqaokn2O67GNJCQ==", "custom": { "moment": "2025-04-02T05:10:31.548Z", "status": "created" } } ] } }'{
"hash": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"data": {
"handle": "support",
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.548Z",
"status": "created"
},
"digest": "73fb95031971bb9a6f40cc77493f1352df914804a57306d07d1fdb2b045e1f5a",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "cUsYY6gB05SH908KlJKoYlVxm5v389XYDnZZjPJgD8382S0WATrhCpbpFCw2u9+mSSWvnboNqaokn2O67GNJCQ=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:31.563Z",
"status": "created"
},
"digest": "fafc6ef642c38c80a77822fa721684f7106ed56406e251a873cfa576ece88002",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "x4AvrUKSgZOsqjGBrCdp7xwzk7XHp5Tkj4BBDPsILykXY5O3rBczhGstf7hKgp9xIAnB35BMKsLpoHY0v+4zCA=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.558Z",
"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 circle
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/circles/admin" \ -H "x-ledger: rtp-ledger"{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "verified",
"operation": "verification"
},
"digest": "68b498915db068fc1855260841444eae3414002b21352fbb340aed6669ba4cd4",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "RRqHxHkvQNWksHbY1yQjlvvKvh9lKb/AR9R+heyRGkfr7tzeZBWQcL7pMBIcxar0YWluh27b6x8r+l1OzVnyBQ=="
}
],
"status": "verified",
"moment": "2025-04-02T05:10:32.013Z",
"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 circle
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
Circle 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/circles/admin" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6", "luid": "$crc.-08478gWrOcERYyA1", "data": { "handle": "support", "access": [ { "action": "any", "signer": { "$record": "owner" } }, { "action": "read", "bearer": { "$signer": { "$record": "owner" } } } ], "custom": { "description": "Administrative access circle", "lastUpdated": "2025-04-02T05:10:30.822Z" }, "parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7" }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41", "result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg==", "custom": { "moment": "2025-04-02T05:10:32.000Z" } } ] } }'{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.013Z",
"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 circle
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/circles/admin/proofs" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "68b498915db068fc1855260841444eae3414002b21352fbb340aed6669ba4cd4", "result": "RRqHxHkvQNWksHbY1yQjlvvKvh9lKb/AR9R+heyRGkfr7tzeZBWQcL7pMBIcxar0YWluh27b6x8r+l1OzVnyBQ==", "custom": { "moment": "2025-04-02T05:10:30.823Z", "status": "verified", "operation": "verification" } }'{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
},
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "verified",
"operation": "verification"
},
"digest": "68b498915db068fc1855260841444eae3414002b21352fbb340aed6669ba4cd4",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "RRqHxHkvQNWksHbY1yQjlvvKvh9lKb/AR9R+heyRGkfr7tzeZBWQcL7pMBIcxar0YWluh27b6x8r+l1OzVnyBQ=="
}
],
"status": "verified",
"moment": "2025-04-02T05:10:32.013Z",
"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 circle
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/circles/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": "5c295885514eddac5d743d310f4747b8cdf933f0d2fe74435dbccebd590f71ad", "result": "xS0T8n04IkLHGtxJzJB6NNi8qSVJa8iqJWjqzAoN26Nb1r+s62lTAmNML/T1PUQrXSOXskvo2jsJjOxysfoIDQ==", "custom": { "moment": "2025-04-02T05:10:32.772Z" } } ] } }'{
"hash": "820cab6f11ce52211e578fffa9e23e02b62857c1cde2d036a144eac3fcf6f2ec",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "f81aa40743a233da61fad82e556d54f86fc5b52c42b006602d5719251c1318b6",
"result": "e5VWnFGPgfDFyEDngi38WjH/7Mrp/kL/SlzT9YtZzSFxFytRcnyPA8YUThKydxfhYVFUVdYhHFDPmmghydAhBA==",
"custom": {
"moment": "2025-04-02T05:10:32.785Z"
}
}
],
"moment": "2025-04-02T05:10:32.785Z"
},
"data": [
{
"hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
"data": {
"action": "any",
"record": "any"
},
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "14921c94d5cd2eb41cc8493ad9e95f25a018dd7199640922f5aeebe853beba91",
"result": "z/+d0Nwr9Onhv7wm5qGd10r9tqA2SCP66BKHnVwyBg3hv6oVumIGT0sF49mTRPmhDqveYiMyOdZ1XrcT/b1BCg==",
"custom": {
"moment": "2025-04-02T05:10:32.784Z"
}
}
],
"moment": "2025-04-02T05:10:32.784Z"
}
},
{
"hash": "eb4f94d008a9ad03b25518f7f4abb35843d775ef3a4adc927c465d7dac19ef4a",
"data": {
"action": "any",
"record": "circle"
},
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "14be0d04ca959c86365087aacdf1a412f6603830ac2c7ef42abbced04e75762d",
"result": "M4Ovf2offRGdHkGDhznvSB+m1kIIjm6l5/NdXtH8kiEmXcJStCfxTXhapmtAwI3AjdS1DWW8dxthShqt8s5wCQ==",
"custom": {
"moment": "2025-04-02T05:10:32.784Z"
}
}
],
"moment": "2025-04-02T05:10:32.784Z"
}
}
]
}{
"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 circle signers
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/circles/admin/signers?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "bf83d56fac9edd2aa95e27409352583e531b401db904373ed899a235bba3b46e",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "b74e817afbc1f354a8652962063ea09b02d0434e056bac83038c698e42c4632e",
"result": "FCSeeeO8GcUcleFW7AdhqShR/AcygZEnwmTRbmv4EnCZwE0Qf7k5z5QNxiafdgck9Ihx9tF/RfWSLIsfRi9fDg==",
"custom": {
"moment": "2025-04-02T05:10:33.102Z"
}
}
],
"moment": "2025-04-02T05:10:33.101Z"
},
"data": [
{
"hash": "da9cfa8db0f4951d4a3f8584fad8cd9f03dd6e85820ccc7f0b299a2313c4e6c8",
"data": {
"circle": "support",
"signer": "support-nsQbg3",
"custom": {
"role": "support-support-nsQbg3",
"assignedAt": "2025-04-02T05:10:30.822Z",
"permissions": [
"read",
"write",
"execute"
]
}
},
"luid": "$csn.-08478l6MpiAE3Fac",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.900Z",
"status": "created"
},
"digest": "042cab880ae4e89aa5ecba5cb5744f5f89faf0e71fc93b287f3d07093893a7c5",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "DeNsV2Br4dV4Q+M2bISlvphMCwU+z9YdcyIC0f1k7ma/CAEcghUPLn36s8yeLQZLRoqL+WdC0lp8vrjKiQozAg=="
},
{
"custom": {
"luid": "$csn.-08478l6MpiAE3Fac",
"moment": "2025-04-02T05:10:31.915Z",
"status": "created"
},
"digest": "bd3082aaee88664f597b9a88616f4bb49b766895fd651912ba39bbe93ad32b68",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "sZn5Jj+nbHG2kdDoLojb+D/4PsrzYXMxEfR3+ieZCNeVgZMFjYRp+mpxVFyd1jwkSRMxNv9Af12iPFmAA7hqBw=="
}
],
"moment": "2025-04-02T05:10:31.916Z",
"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": "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=="
}
]
}
}Assign a signer to a circle
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
Circle signer 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/circles/admin/signers" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a", "meta": { "proofs": [ { "method": "ed25519-v2", "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=", "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a", "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==" } ] }, "data": { "circle": "string", "signer": "string" } }'{
"hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
"digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
"result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==",
"custom": {
"any": "data",
"moment": "2019-08-24T14:15:22Z",
"status": "string",
"labels": {
"$pop": 1
},
"reason": "string",
"failId": "string",
"detail": "string"
}
}
],
"owners": [
"WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
],
"moment": "2019-08-24T14:15:22Z",
"status": "string",
"labels": [
"preferred"
]
},
"luid": "$rec.6sTUVWXY-Z6AbCdEf",
"data": {
"schema": "string",
"circle": "string",
"signer": "string",
"custom": {
"any": "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 circle signer link
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).
link*|
The unique identifier of the record linked - 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/circles/admin/signers/string" \ -H "x-ledger: rtp-ledger"{
"hash": "da9cfa8db0f4951d4a3f8584fad8cd9f03dd6e85820ccc7f0b299a2313c4e6c8",
"data": {
"circle": "support",
"signer": "support-nsQbg3",
"custom": {
"role": "support-support-nsQbg3",
"assignedAt": "2025-04-02T05:10:30.822Z",
"permissions": [
"read",
"write",
"execute"
]
}
},
"luid": "$csn.-08478l6MpiAE3Fac",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.900Z",
"status": "created"
},
"digest": "042cab880ae4e89aa5ecba5cb5744f5f89faf0e71fc93b287f3d07093893a7c5",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "DeNsV2Br4dV4Q+M2bISlvphMCwU+z9YdcyIC0f1k7ma/CAEcghUPLn36s8yeLQZLRoqL+WdC0lp8vrjKiQozAg=="
},
{
"custom": {
"luid": "$csn.-08478l6MpiAE3Fac",
"moment": "2025-04-02T05:10:31.915Z",
"status": "created"
},
"digest": "bd3082aaee88664f597b9a88616f4bb49b766895fd651912ba39bbe93ad32b68",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "sZn5Jj+nbHG2kdDoLojb+D/4PsrzYXMxEfR3+ieZCNeVgZMFjYRp+mpxVFyd1jwkSRMxNv9Af12iPFmAA7hqBw=="
}
],
"moment": "2025-04-02T05:10:31.916Z",
"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=="
}
]
}
}Remove a signer of a circle
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).
link*|
The unique identifier of the record linked - 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
Circle signer 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/circles/admin/signers/string" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "data": { "parent": "da9cfa8db0f4951d4a3f8584fad8cd9f03dd6e85820ccc7f0b299a2313c4e6c8" }, "hash": "3833460ee4460dc5653c0c794099268bf4f84a1313c6b16c62d31272d5cb9fb8", "luid": "$csn.-08478l6MpiAE3Fac", "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "f43cc700ac8db4a95058668166241148cd87b0508d486c409898937fb1cd1d59", "result": "y7ZR/HqpEg+qz1URw5psLwL+ywHFhU0lLfrF0kJ1+5BiTenp3wnbY84ETy+MuExqznjHZgCIWpig1fuVeAdYCg==", "custom": { "moment": "2025-04-02T05:10:33.929Z", "status": "dropped" } } ], "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=="
}
]
}
}Remove a signer of a circle
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).
link*|
The unique identifier of the record linked - 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
Circle signer 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/circles/admin/signers/string/drop" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "data": { "parent": "da9cfa8db0f4951d4a3f8584fad8cd9f03dd6e85820ccc7f0b299a2313c4e6c8" }, "hash": "3833460ee4460dc5653c0c794099268bf4f84a1313c6b16c62d31272d5cb9fb8", "luid": "$csn.-08478l6MpiAE3Fac", "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "f43cc700ac8db4a95058668166241148cd87b0508d486c409898937fb1cd1d59", "result": "y7ZR/HqpEg+qz1URw5psLwL+ywHFhU0lLfrF0kJ1+5BiTenp3wnbY84ETy+MuExqznjHZgCIWpig1fuVeAdYCg==", "custom": { "moment": "2025-04-02T05:10:33.929Z", "reason": "Offboarded from circle", "status": "dropped" } } ], "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 a circle 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/circles/admin/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "1e6ebcbf5f434cc5a676d2d75ddb40cdb50fc1e7396a2be4bc3b5156403c7a8d",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "b50d6491fd19b126270adbd0569fc2f05cd7d9350a333c83b73346777c396c6c",
"result": "q6h7P8HxJSLwv8lX1zkO7IJtY8DaWO5ZJy6EJbpg/TDCsszMjFXxCVrrA5VvfWmYCWrid5Lprw7hPkMoAWZ/BQ==",
"custom": {
"moment": "2025-04-02T05:10:33.139Z"
}
}
],
"moment": "2025-04-02T05:10:33.138Z"
},
"data": [
{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "verified",
"operation": "verification"
},
"digest": "68b498915db068fc1855260841444eae3414002b21352fbb340aed6669ba4cd4",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "RRqHxHkvQNWksHbY1yQjlvvKvh9lKb/AR9R+heyRGkfr7tzeZBWQcL7pMBIcxar0YWluh27b6x8r+l1OzVnyBQ=="
}
],
"status": "verified",
"moment": "2025-04-02T05:10:32.380Z",
"change": 3,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
}
},
{
"hash": "a17fb521832e91cd8a32277a4335026a1bd15413a77f68cb4668af017cebcba6",
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.000Z"
},
"digest": "37cfef6ca365018b2e01db959479690a211b206ccbc7eaec136d2c94a1538c41",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "Xb//mUvXqj5ht68XkwwR8Yffu/vGu3yDizSa2FZv7MTdrBQc77h6SuNAYyyKoxyZTt4A1deuLgHbhpYkYavPCg=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:32.015Z"
},
"digest": "66db705aafb52d0158f6fd882603f93bb06b44c7580b06f0ca5205d3ce6e70d6",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "FXdSdLUF6xQ0lxvphuxjYW1/6uCUDwum3cUXblwWF+ssFIOPg6bI1csK/l5A3wUtUEbiYPM8AZvAzubw/7XiAQ=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.013Z",
"change": 2,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"handle": "support",
"custom": {
"description": "Administrative access circle",
"lastUpdated": "2025-04-02T05:10:30.822Z"
},
"access": [
{
"action": "any",
"signer": {
"$record": "owner"
}
},
{
"action": "read",
"bearer": {
"$signer": {
"$record": "owner"
}
}
}
]
}
},
{
"hash": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.548Z",
"status": "created"
},
"digest": "73fb95031971bb9a6f40cc77493f1352df914804a57306d07d1fdb2b045e1f5a",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "cUsYY6gB05SH908KlJKoYlVxm5v389XYDnZZjPJgD8382S0WATrhCpbpFCw2u9+mSSWvnboNqaokn2O67GNJCQ=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:31.563Z",
"status": "created"
},
"digest": "fafc6ef642c38c80a77822fa721684f7106ed56406e251a873cfa576ece88002",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "x4AvrUKSgZOsqjGBrCdp7xwzk7XHp5Tkj4BBDPsILykXY5O3rBczhGstf7hKgp9xIAnB35BMKsLpoHY0v+4zCA=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.558Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "support",
"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 circle 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/circles/admin/changes/3" \ -H "x-ledger: rtp-ledger"{
"hash": "e08b5d31ca9287c8dd9f6d295b5ef6e7a0ff916e86f3d7dbc78e38227cebf7c7",
"luid": "$crc.-08478gWrOcERYyA1",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.548Z",
"status": "created"
},
"digest": "73fb95031971bb9a6f40cc77493f1352df914804a57306d07d1fdb2b045e1f5a",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "cUsYY6gB05SH908KlJKoYlVxm5v389XYDnZZjPJgD8382S0WATrhCpbpFCw2u9+mSSWvnboNqaokn2O67GNJCQ=="
},
{
"custom": {
"luid": "$crc.-08478gWrOcERYyA1",
"moment": "2025-04-02T05:10:31.563Z",
"status": "created"
},
"digest": "fafc6ef642c38c80a77822fa721684f7106ed56406e251a873cfa576ece88002",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "x4AvrUKSgZOsqjGBrCdp7xwzk7XHp5Tkj4BBDPsILykXY5O3rBczhGstf7hKgp9xIAnB35BMKsLpoHY0v+4zCA=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.558Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "support",
"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=="
}
]
}
}Bridge
A Bridge is a configuration record in the ledger that facilitates integration with external services or systems. It acts as a connector, enabling the ledger to interact with remote services, such as banking cores, to execute operations like debits and credits in response to changes in ledger balances. Bridges are essential for extending the ledger's functionality and integrating it with other financial systems. Bridges support multiple authentication mechanisms through their secure configuration: - OAuth2: Client credentials flow for token-based authentication - Header: Custom header-based authentication (multiple headers can be configured) - Generic: Flexible key-value authentication for custom implementations Multiple security rules can be applied simultaneously, with OAuth2 and header-based authentication working together.
Domain
A Domain is a namespace within the ledger that organizes and contains other ledger records. It provides a mechanism for data separation, allowing different sets of records to be managed independently. Domains help structure the ledger's data hierarchy and can be used to implement multi-tenancy or segregate records for different purposes or entities.