API Reference
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.
List domains
Authorization
BearerAuth AuthorizationBearer <token>
JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.
In: header
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/domains?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "11a98942d1e443cfc9eb987c91e142348260dd60a7bef8336c60012cb3cbaf63",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "7cdfe6ce8ff32fc51ca24c42798d68cf27fa5c03cb936e11c7ad9916a1521ebd",
"result": "LhOBv1nRYyMVuoz18CegIwQKu997FTVVbNVep16TJhl4Le3kE4S4JEfffxbahCuFMhbCZR9ha1Ymliv8cz7OBQ==",
"custom": {
"moment": "2025-04-02T05:10:33.173Z"
}
}
],
"moment": "2025-04-02T05:10:33.173Z"
},
"data": [
{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
},
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "certified",
"operation": "certification"
},
"digest": "107f4adab78d11204fc474c9cc0ec16b078aab77e60dbec367c5b908343ab115",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "tNPxrKOHxEU4aRLaVSjwmGKpj41uNrI/+HqQlncrEKe8XBYr5Hv39qkHTAlkhqK9mMPOcXm2o0LXUM+Rj9LvDQ=="
}
],
"status": "certified",
"moment": "2025-04-02T05:10:32.061Z",
"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 domain
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
Domain 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/domains" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051", "data": { "handle": "bank-wallet", "schema": "bank", "custom": { "bankBic": "76rQPuIa", "bankName": "Pagac Group" }, "access": [ { "policy": "studio-navigation@teslabank.io" }, { "policy": "owner@teslabank.io" }, { "policy": "admin@teslabank.io" }, { "policy": "security@teslabank.io" }, { "policy": "operation@teslabank.io" }, { "policy": "support@teslabank.io" }, { "policy": "bridge@teslabank.io" }, { "policy": "reporting-bridge@teslabank.io" } ] }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "cf59ef810dd389c2b2e6c07d60c8fcec26077127ec09f16ff2e07f89830ee923", "result": "pzhMmwa0vhEHOUs+NlWhZdgSIDdP9oN5UkP4PSWabh50t7S2lCxbbO34LqeG1oLVChzrOqxrynbVfDXbOqwDCg==", "custom": { "moment": "2025-04-02T05:10:31.572Z", "status": "created" } } ] } }'{
"hash": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"data": {
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"bankBic": "76rQPuIa",
"bankName": "Pagac Group"
},
"access": [
{
"policy": "studio-navigation@teslabank.io"
},
{
"policy": "owner@teslabank.io"
},
{
"policy": "admin@teslabank.io"
},
{
"policy": "security@teslabank.io"
},
{
"policy": "operation@teslabank.io"
},
{
"policy": "support@teslabank.io"
},
{
"policy": "bridge@teslabank.io"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
},
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.572Z",
"status": "created"
},
"digest": "cf59ef810dd389c2b2e6c07d60c8fcec26077127ec09f16ff2e07f89830ee923",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "pzhMmwa0vhEHOUs+NlWhZdgSIDdP9oN5UkP4PSWabh50t7S2lCxbbO34LqeG1oLVChzrOqxrynbVfDXbOqwDCg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:31.583Z",
"status": "created"
},
"digest": "a0c36a75a047f24c6ab593d41d02689f1b0a3f183ec4f75f463715baa2d0a7f4",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "6m/G2ILClAzkEKNASntb38kfe+OOYNj8zie+auHK06wN2enSUodHFE3w7iHSVEzzvijsqSvtFIeAwGyl99NKCg=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.580Z",
"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 domain
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. Tied to multi tenancy.
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/domains/string" \ -H "x-ledger: rtp-ledger"{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
},
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "certified",
"operation": "certification"
},
"digest": "107f4adab78d11204fc474c9cc0ec16b078aab77e60dbec367c5b908343ab115",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "tNPxrKOHxEU4aRLaVSjwmGKpj41uNrI/+HqQlncrEKe8XBYr5Hv39qkHTAlkhqK9mMPOcXm2o0LXUM+Rj9LvDQ=="
}
],
"status": "certified",
"moment": "2025-04-02T05:10:32.061Z",
"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 domain
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. Tied to multi tenancy.
Header Parameters
x-ledger?|
The unique identifier of ledger in context for multi tenant requests.
Request Body
application/json
Domain 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/domains/string" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade", "luid": "$dom.-08478wtauYqBlBzc", "data": { "handle": "bank-wallet", "schema": "bank", "custom": { "bankBic": "EXMPUS33", "bankName": "Example Bank International", "address": "123 Financial St, New York, NY 10001", "phoneNumber": "+1-212-555-0123" }, "access": [ { "policy": "owner@example-bank.com" }, { "policy": "admin@example-bank.com" }, { "policy": "security@example-bank.com" }, { "policy": "operation@example-bank.com" }, { "policy": "support@example-bank.com" }, { "policy": "bridge@example-bank.com" }, { "policy": "reporting-bridge@example-bank.com" }, { "policy": "reporting-bridge@teslabank.io" } ], "parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051" }, "meta": { "proofs": [ { "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b", "result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg==", "custom": { "moment": "2025-04-02T05:10:32.036Z" } } ] } }'{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
},
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.061Z",
"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 domain
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. Tied to multi tenancy.
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/domains/string/proofs" \ -H "x-ledger: rtp-ledger" \ -H "Content-Type: application/json" \ -d '{ "method": "ed25519-v2", "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=", "digest": "107f4adab78d11204fc474c9cc0ec16b078aab77e60dbec367c5b908343ab115", "result": "tNPxrKOHxEU4aRLaVSjwmGKpj41uNrI/+HqQlncrEKe8XBYr5Hv39qkHTAlkhqK9mMPOcXm2o0LXUM+Rj9LvDQ==", "custom": { "moment": "2025-04-02T05:10:30.823Z", "status": "certified", "operation": "certification" } }'{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
},
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "certified",
"operation": "certification"
},
"digest": "107f4adab78d11204fc474c9cc0ec16b078aab77e60dbec367c5b908343ab115",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "tNPxrKOHxEU4aRLaVSjwmGKpj41uNrI/+HqQlncrEKe8XBYr5Hv39qkHTAlkhqK9mMPOcXm2o0LXUM+Rj9LvDQ=="
}
],
"status": "certified",
"moment": "2025-04-02T05:10:32.061Z",
"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 domain 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. Tied to multi tenancy.
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/domains/string/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \ -H "x-ledger: rtp-ledger"{
"hash": "9828b2d92417c906b1ca6d9acf324af9512adb9cf8fc443b506a7eed176a74e2",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "877ceb9a5bb11dba76ba71690930d36a0f23726c58fc70c437d568b0ef8c3a3b",
"result": "1Szi5P4NzUIS7JjPqhXiwKvlOvDQgwOCHC47pWqqNJRQMvXPEmEwDunnWhC4qx6dofU1lFevWLU4WtOxD0l1Aw==",
"custom": {
"moment": "2025-04-02T05:10:33.204Z"
}
}
],
"moment": "2025-04-02T05:10:33.204Z"
},
"data": [
{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
},
{
"custom": {
"moment": "2025-04-02T05:10:30.823Z",
"status": "certified",
"operation": "certification"
},
"digest": "107f4adab78d11204fc474c9cc0ec16b078aab77e60dbec367c5b908343ab115",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "tNPxrKOHxEU4aRLaVSjwmGKpj41uNrI/+HqQlncrEKe8XBYr5Hv39qkHTAlkhqK9mMPOcXm2o0LXUM+Rj9LvDQ=="
}
],
"status": "certified",
"moment": "2025-04-02T05:10:32.412Z",
"change": 3,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
}
},
{
"hash": "28603ea974e9a96ff058a9a57f8913ed8465c622e46a03c8921d429d452cbade",
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:32.036Z"
},
"digest": "b28740ed7475ea8998b033eef7767426a3ba9da6f7d1e7278817435d4cfc5a0b",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "gjRVapVhYfdmw++DOcPxVFVfSE9/iaWxVLzelh6zaZQVIcrxNis3yH0qDgLqkII287wJb2OqtojdUWdBsw2MBg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:32.063Z"
},
"digest": "decb5a672d90aa86e883cc62f7a498a61a4280bd7e5350fc04fb4bb55dbd38d3",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "05YL4kuV/WM14Y8M0DPliqhJXVxmVkuFBb4BPMRcyhpNX1XBEDua0l6TdkgBzhjvQkwDFQ3RpdFP/4C1ah+9Cw=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:32.061Z",
"change": 2,
"action": "update",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"parent": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"address": "123 Financial St, New York, NY 10001",
"bankBic": "EXMPUS33",
"bankName": "Example Bank International",
"phoneNumber": "+1-212-555-0123"
},
"access": [
{
"policy": "owner@example-bank.com"
},
{
"policy": "admin@example-bank.com"
},
{
"policy": "security@example-bank.com"
},
{
"policy": "operation@example-bank.com"
},
{
"policy": "support@example-bank.com"
},
{
"policy": "bridge@example-bank.com"
},
{
"policy": "reporting-bridge@example-bank.com"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
}
},
{
"hash": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.572Z",
"status": "created"
},
"digest": "cf59ef810dd389c2b2e6c07d60c8fcec26077127ec09f16ff2e07f89830ee923",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "pzhMmwa0vhEHOUs+NlWhZdgSIDdP9oN5UkP4PSWabh50t7S2lCxbbO34LqeG1oLVChzrOqxrynbVfDXbOqwDCg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:31.583Z",
"status": "created"
},
"digest": "a0c36a75a047f24c6ab593d41d02689f1b0a3f183ec4f75f463715baa2d0a7f4",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "6m/G2ILClAzkEKNASntb38kfe+OOYNj8zie+auHK06wN2enSUodHFE3w7iHSVEzzvijsqSvtFIeAwGyl99NKCg=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.580Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"bankBic": "76rQPuIa",
"bankName": "Pagac Group"
},
"access": [
{
"policy": "studio-navigation@teslabank.io"
},
{
"policy": "owner@teslabank.io"
},
{
"policy": "admin@teslabank.io"
},
{
"policy": "security@teslabank.io"
},
{
"policy": "operation@teslabank.io"
},
{
"policy": "support@teslabank.io"
},
{
"policy": "bridge@teslabank.io"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
}
}
],
"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=="
}
]
}
}Check access in a domain
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/domains/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": "440633d89dcbcfff70dd681ce32bfc0cced9ef7259fe124cf470f7c40f32c66a", "result": "tOtavlqxj5KjvsobuZ5g+RMEMt0FcITveCx/F+WWsv8v1cFvCNUZ5+hNZmFntwuNC55CoLnAl6z4O/ZE5FNSAQ==", "custom": { "moment": "2025-04-02T05:10:32.788Z" } } ] } }'{
"hash": "9e10268adc24f417aa55ceea1bd7ee81949734b663852d56729e1a69a3951f53",
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "9b42eb46f4306bfefaa80c1699ed28d8d19e01c455cd5eb7656ccd36aff2b280",
"result": "Bvc2qnqkyY8x4poDWyleQ/nteCnam/2uu/MlBM2aB/yUYuaCfS+5QinmkOLCPsEdaYo39MIQpoXIr6yPFkHtDg==",
"custom": {
"moment": "2025-04-02T05:10:32.800Z"
}
}
],
"moment": "2025-04-02T05:10:32.800Z"
},
"data": [
{
"hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
"data": {
"action": "any",
"record": "any"
},
"meta": {
"proofs": [
{
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"digest": "4c14f07ad6512c4c8a4bc40f3ea06a4e7ad2183ba60f2f946b0bf5fd508cb2b4",
"result": "ReBuTvIn1zlzJKG7zMo4Ygoj6bgzl0/JUbvMfNKNgiBtM8tMz6SoxUhv89uVhCoFOz6eNEr/abn8VHVj52C1DA==",
"custom": {
"moment": "2025-04-02T05:10:32.799Z"
}
}
],
"moment": "2025-04-02T05:10:32.799Z"
}
}
]
}{
"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 domain 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. Tied to multi tenancy.
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/domains/string/changes/3" \ -H "x-ledger: rtp-ledger"{
"hash": "ce30949e169f365c85186bd407f46165cc0a9e8006b57be17873fbb345506051",
"luid": "$dom.-08478wtauYqBlBzc",
"meta": {
"proofs": [
{
"custom": {
"moment": "2025-04-02T05:10:31.572Z",
"status": "created"
},
"digest": "cf59ef810dd389c2b2e6c07d60c8fcec26077127ec09f16ff2e07f89830ee923",
"method": "ed25519-v2",
"public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
"result": "pzhMmwa0vhEHOUs+NlWhZdgSIDdP9oN5UkP4PSWabh50t7S2lCxbbO34LqeG1oLVChzrOqxrynbVfDXbOqwDCg=="
},
{
"custom": {
"luid": "$dom.-08478wtauYqBlBzc",
"moment": "2025-04-02T05:10:31.583Z",
"status": "created"
},
"digest": "a0c36a75a047f24c6ab593d41d02689f1b0a3f183ec4f75f463715baa2d0a7f4",
"method": "ed25519-v2",
"public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
"result": "6m/G2ILClAzkEKNASntb38kfe+OOYNj8zie+auHK06wN2enSUodHFE3w7iHSVEzzvijsqSvtFIeAwGyl99NKCg=="
}
],
"status": "created",
"moment": "2025-04-02T05:10:31.580Z",
"change": 1,
"action": "create",
"owners": [
"gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
],
"labels": null
},
"data": {
"handle": "bank-wallet",
"schema": "bank",
"custom": {
"bankBic": "76rQPuIa",
"bankName": "Pagac Group"
},
"access": [
{
"policy": "studio-navigation@teslabank.io"
},
{
"policy": "owner@teslabank.io"
},
{
"policy": "admin@teslabank.io"
},
{
"policy": "security@teslabank.io"
},
{
"policy": "operation@teslabank.io"
},
{
"policy": "support@teslabank.io"
},
{
"policy": "bridge@teslabank.io"
},
{
"policy": "reporting-bridge@teslabank.io"
}
]
}
}{
"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=="
}
]
}
}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.
Effect
An Effect is a ledger component that defines automated behaviors triggered by changes in ledger data. When a change occurs, such as a transaction or update to a record, the ledger broadcasts an event identified by a specific signal. Effects can be configured to listen for these signals and, based on defined filters, execute actions like notifying external systems via webhooks or integrating with other services. Effects are crucial for extending the ledger's capabilities and integrating it with external workflows or systems.