API Reference

Anchor

An Anchor is a ledger record that establishes a connection between a user's wallet in the ledger and an external identifier, such as a bank account number, email, or phone number. This linkage is critical for onboarding users and enabling seamless interactions between the ledger and external systems.

List anchors

GET
/anchors

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

page?

Page query parameters

filter?

Header Parameters

x-ledger?|

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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

POST
/anchors

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Header Parameters

x-ledger?|

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

Request Body

application/json

Anchor 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/anchors" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",    "data": {      "handle": "svgs:-vqibKLJKikP@teslabank.io",      "wallet": "tel:7027156866",      "target": "tran:254085257323@minka.io",      "symbol": "usd",      "custom": {        "name": "Chaz",        "idType": "nidn",        "idNumber": "IJdEsSmS",        "entityType": "individual"      },      "access": [        {          "action": "any",          "signer": {            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="          }        },        {          "action": "read",          "bearer": {            "$signer": {              "$record": "owner"            }          }        }      ]    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "88bd7a67baa761c8c68032b4d9aaef82ff1e89149b3ab6c532723836c6f88a3c",          "result": "UaQ97057qBTyl8SanZ64TL1IvGZdXQKDkktCMt/BaSJFdLO/oJvm3NC/MM64ZEUlDWGskrU7kVRUG/hfaxF4Bw==",          "custom": {            "moment": "2025-04-02T05:10:31.483Z",            "status": "created"          }        }      ]    }  }'
{
  "hash": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
  "data": {
    "handle": "svgs:-vqibKLJKikP@teslabank.io",
    "wallet": "tel:7027156866",
    "target": "tran:254085257323@minka.io",
    "symbol": "usd",
    "custom": {
      "name": "Chaz",
      "idType": "nidn",
      "idNumber": "IJdEsSmS",
      "entityType": "individual"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$anc.-0847869HxNkGI2-Z",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.483Z",
          "status": "created"
        },
        "digest": "88bd7a67baa761c8c68032b4d9aaef82ff1e89149b3ab6c532723836c6f88a3c",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "UaQ97057qBTyl8SanZ64TL1IvGZdXQKDkktCMt/BaSJFdLO/oJvm3NC/MM64ZEUlDWGskrU7kVRUG/hfaxF4Bw=="
      },
      {
        "custom": {
          "luid": "$anc.-0847869HxNkGI2-Z",
          "moment": "2025-04-02T05:10:31.503Z",
          "status": "created"
        },
        "digest": "1d2c782e3fefb90213d77e3970ece504f7e50ac0a869383c8e917586b484f166",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "O2Wt+7bw7QOM1FbAL/uwTc+zoh0E/WoRqSk5+9hmBI/NZGCOfYntFs7yjpKozb20KPS0UYqfkh9gbyQf160zBA=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.498Z",
    "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 an anchor

GET
/anchors/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

The unique identifier of the 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/anchors/admin" \  -H "x-ledger: rtp-ledger"
{
  "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
  "data": {
    "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
    "handle": "svgs:-vqibKLJKikP@teslabank.io",
    "wallet": "tel:7027156866",
    "target": "tran:254085257323@minka.io",
    "symbol": "usd",
    "custom": {
      "name": "Keyon",
      "idType": "nidn",
      "status": "verified",
      "idNumber": "IJdEsSmS",
      "entityType": "individual",
      "lastUpdated": "2025-04-02T05:10:30.822Z"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$anc.-0847869HxNkGI2-Z",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.934Z"
        },
        "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
      },
      {
        "custom": {
          "luid": "$anc.-0847869HxNkGI2-Z",
          "moment": "2025-04-02T05:10:31.951Z"
        },
        "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "connected",
          "operation": "connection"
        },
        "digest": "4d0795a5f34af6a593572b743ba0632855866b940273e6042d6b4d928f120eae",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "B5qfgUhvwY+MnAY+zvmwZwRrmQcD25cUl7pBpfgMKpAUR8CzLA6MIj2zdRnQtsWGnLEj7xsj9dNhkgbjt71YCA=="
      }
    ],
    "status": "connected",
    "moment": "2025-04-02T05:10:31.950Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Drop an anchor

DELETE
/anchors/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

Header Parameters

x-ledger?|

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

Request Body

application/json

Anchor 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/anchors/admin" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f"    },    "hash": "b8f478d31f1a8f161753e0a78128b097bf1876dd24de404193cad4e347d5e17c",    "luid": "$anc.-0847869HxNkGI2-Z",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "65af3595159da5ccddce35a989aa83d182bbe361b8d6fd7ce3b12fcff4ad72c7",          "result": "HU/pUMm9RGuvVjvH8ybcV3Lj97N/wgP8rN7DLMTrNFmrhLl70QWMpnzikvUs+kH12tvk7v0oCgONiglIb6dEDQ==",          "custom": {            "moment": "2025-04-02T05:10:33.895Z",            "status": "dropped"          }        }      ],      "status": "connected",      "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 an anchor

PUT
/anchors/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

Header Parameters

x-ledger?|

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

Request Body

application/json

Anchor 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/anchors/admin" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",    "luid": "$anc.-0847869HxNkGI2-Z",    "data": {      "handle": "svgs:-vqibKLJKikP@teslabank.io",      "wallet": "tel:7027156866",      "target": "tran:254085257323@minka.io",      "symbol": "usd",      "custom": {        "name": "Keyon",        "idType": "nidn",        "idNumber": "IJdEsSmS",        "entityType": "individual",        "lastUpdated": "2025-04-02T05:10:30.822Z",        "status": "verified"      },      "access": [        {          "action": "any",          "signer": {            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="          }        },        {          "action": "read",          "bearer": {            "$signer": {              "$record": "owner"            }          }        }      ],      "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec"    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",          "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw==",          "custom": {            "moment": "2025-04-02T05:10:31.934Z"          }        }      ]    }  }'
{
  "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
  "data": {
    "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
    "handle": "svgs:-vqibKLJKikP@teslabank.io",
    "wallet": "tel:7027156866",
    "target": "tran:254085257323@minka.io",
    "symbol": "usd",
    "custom": {
      "name": "Keyon",
      "idType": "nidn",
      "status": "verified",
      "idNumber": "IJdEsSmS",
      "entityType": "individual",
      "lastUpdated": "2025-04-02T05:10:30.822Z"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$anc.-0847869HxNkGI2-Z",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.934Z"
        },
        "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
      },
      {
        "custom": {
          "luid": "$anc.-0847869HxNkGI2-Z",
          "moment": "2025-04-02T05:10:31.951Z"
        },
        "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.950Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}
{
  "hash": "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 an anchor

POST
/anchors/{id}/proofs

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

Header Parameters

x-ledger?|

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

Request Body

application/json

Proof body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/anchors/admin/proofs" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "method": "ed25519-v2",    "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",    "digest": "4d0795a5f34af6a593572b743ba0632855866b940273e6042d6b4d928f120eae",    "result": "B5qfgUhvwY+MnAY+zvmwZwRrmQcD25cUl7pBpfgMKpAUR8CzLA6MIj2zdRnQtsWGnLEj7xsj9dNhkgbjt71YCA==",    "custom": {      "moment": "2025-04-02T05:10:30.823Z",      "status": "connected",      "operation": "connection"    }  }'
{
  "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
  "data": {
    "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
    "handle": "svgs:-vqibKLJKikP@teslabank.io",
    "wallet": "tel:7027156866",
    "target": "tran:254085257323@minka.io",
    "symbol": "usd",
    "custom": {
      "name": "Keyon",
      "idType": "nidn",
      "status": "verified",
      "idNumber": "IJdEsSmS",
      "entityType": "individual",
      "lastUpdated": "2025-04-02T05:10:30.822Z"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "$record": "owner"
          }
        }
      }
    ]
  },
  "luid": "$anc.-0847869HxNkGI2-Z",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.934Z"
        },
        "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
      },
      {
        "custom": {
          "luid": "$anc.-0847869HxNkGI2-Z",
          "moment": "2025-04-02T05:10:31.951Z"
        },
        "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
      },
      {
        "custom": {
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "connected",
          "operation": "connection"
        },
        "digest": "4d0795a5f34af6a593572b743ba0632855866b940273e6042d6b4d928f120eae",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "B5qfgUhvwY+MnAY+zvmwZwRrmQcD25cUl7pBpfgMKpAUR8CzLA6MIj2zdRnQtsWGnLEj7xsj9dNhkgbjt71YCA=="
      }
    ],
    "status": "connected",
    "moment": "2025-04-02T05:10:31.950Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Check access in an anchor

POST
/anchors/{id}/access/\!check

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

Header Parameters

x-ledger?|

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

Request Body

application/json

Access check payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3000/v2/anchors/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": "9c3dce208e1d6709e66bca47bb083c18c41f91293e2361561218beb6985652e1",          "result": "RGdKsSWdhj2Y+zXlBy2Y+0CWmcO0rUTjrENPuzcYad1oVQZBuuvt9I6qlJbvVj+qjxDlKlvzZ3X6+8oRNReHAQ==",          "custom": {            "moment": "2025-04-02T05:10:32.742Z"          }        }      ]    }  }'
{
  "hash": "3738b110b942ac46971ad85a100ad99f177825c1d27dfaecd114bae3ae7bb3a6",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "cf857d4b2fd3e1c6e608a74ccf3fa225eaea191ef90c23d3b978d7aa511bd580",
        "result": "3fLMgFlaOkaiuzlUmu5PfduehfdQM3ey7BTcIJU/nWnJFi5Bhp9s//Fc8UOfyhgKuPOmoX9S5ORYikWgfjLVCA==",
        "custom": {
          "moment": "2025-04-02T05:10:32.756Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:32.756Z"
  },
  "data": [
    {
      "hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
      "data": {
        "action": "any",
        "record": "any"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "361057e6a1be95a57fffc43e5a08e65395e9889ac8611114386ba263d95130ff",
            "result": "4PZ9Qjl8WNK7lC672UJ1q9MO0J9rccwh+qaRI/MJWoypq4IDW/cZHjrmZbZt896NJmux7w2iBqEfCyXJfHVUCQ==",
            "custom": {
              "moment": "2025-04-02T05:10:32.755Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.755Z"
      }
    },
    {
      "hash": "cd7cc095ef2a33408bb9dec82533d1aceb951a3f154a84d06edee58ce24227fc",
      "data": {
        "action": "any",
        "record": "anchor"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "71749c1e6ab7a3a3f52ac02939cd1ff9fe38008e8b9d220c4c3245edd0a237b2",
            "result": "tc6jEmO5LA7UJj/DfP5Q7crc7f+uD14f/PRRN9LudrcvpIhZNWrZs48Ss6rUkuaFj+bR55CFbR2uGA0v21LlDg==",
            "custom": {
              "moment": "2025-04-02T05:10:32.755Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.755Z"
      }
    }
  ]
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Drop an anchor

POST
/anchors/{id}/drop

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

Header Parameters

x-ledger?|

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

Request Body

application/json

Anchor 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/anchors/admin/drop" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f"    },    "hash": "b8f478d31f1a8f161753e0a78128b097bf1876dd24de404193cad4e347d5e17c",    "luid": "$anc.-0847869HxNkGI2-Z",    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "65af3595159da5ccddce35a989aa83d182bbe361b8d6fd7ce3b12fcff4ad72c7",          "result": "HU/pUMm9RGuvVjvH8ybcV3Lj97N/wgP8rN7DLMTrNFmrhLl70QWMpnzikvUs+kH12tvk7v0oCgONiglIb6dEDQ==",          "custom": {            "moment": "2025-04-02T05:10:33.895Z",            "reason": "Account closed by customer request",            "status": "dropped"          }        }      ],      "status": "connected",      "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 an anchor changes

GET
/anchors/{id}/changes

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

The unique identifier of the 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/anchors/admin/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "d4bfa234549aa8f375407cd6f0ff1af3fb151c631db54bf6ec2dec02df1049a7",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "c16b83b7bd26d89be289122dd935062cba1e3d84bfd9fc4a4504b581cdfdf8cc",
        "result": "EQIzN4EAYQQzIt5/4VDAfr17o9SfaxkAxk9Gpi7pNjGDHj2odrXQS2INLeXe1Nb9BzNHJoJXC40H3CCOQ7dRDg==",
        "custom": {
          "moment": "2025-04-02T05:10:32.976Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:32.976Z"
  },
  "data": [
    {
      "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
      "luid": "$anc.-0847869HxNkGI2-Z",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.934Z"
            },
            "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
          },
          {
            "custom": {
              "luid": "$anc.-0847869HxNkGI2-Z",
              "moment": "2025-04-02T05:10:31.951Z"
            },
            "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
          },
          {
            "custom": {
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "connected",
              "operation": "connection"
            },
            "digest": "4d0795a5f34af6a593572b743ba0632855866b940273e6042d6b4d928f120eae",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "B5qfgUhvwY+MnAY+zvmwZwRrmQcD25cUl7pBpfgMKpAUR8CzLA6MIj2zdRnQtsWGnLEj7xsj9dNhkgbjt71YCA=="
          }
        ],
        "status": "connected",
        "moment": "2025-04-02T05:10:32.315Z",
        "change": 3,
        "action": "update",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
        "handle": "svgs:-vqibKLJKikP@teslabank.io",
        "wallet": "tel:7027156866",
        "target": "tran:254085257323@minka.io",
        "symbol": "usd",
        "custom": {
          "name": "Keyon",
          "idType": "nidn",
          "status": "verified",
          "idNumber": "IJdEsSmS",
          "entityType": "individual",
          "lastUpdated": "2025-04-02T05:10:30.822Z"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      }
    },
    {
      "hash": "5831f42bd15da1cafa5a4a4623a398389a734766ad169fb4f3b6bdf80418712f",
      "luid": "$anc.-0847869HxNkGI2-Z",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.934Z"
            },
            "digest": "482d687c0719d02eff65be40cafb9fbfb35a850fdc95e82c90765791ea6c52b8",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "HSx4A9sj1DwwiX71pjEI5eyJGvBpV8ViBF9dCLM4nmLfK8exRB4AA47lQe1w4QrdronMUBRq+rMSYx+yzTqrCw=="
          },
          {
            "custom": {
              "luid": "$anc.-0847869HxNkGI2-Z",
              "moment": "2025-04-02T05:10:31.951Z"
            },
            "digest": "59c5885d4d526c8e42672f66df4b38f2ca3caaaea90f48b72b6951502a5938dc",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "VkJ+homwffBlEBXDNSaWOoyPolDEAxti2O5j7qvmRrm5gBtBcahneV2J3FtvD4F1yHup1r146WtvuPlVG6k6AQ=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.950Z",
        "change": 2,
        "action": "update",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "parent": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
        "handle": "svgs:-vqibKLJKikP@teslabank.io",
        "wallet": "tel:7027156866",
        "target": "tran:254085257323@minka.io",
        "symbol": "usd",
        "custom": {
          "name": "Keyon",
          "idType": "nidn",
          "status": "verified",
          "idNumber": "IJdEsSmS",
          "entityType": "individual",
          "lastUpdated": "2025-04-02T05:10:30.822Z"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "$record": "owner"
              }
            }
          }
        ]
      }
    },
    {
      "hash": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
      "luid": "$anc.-0847869HxNkGI2-Z",
      "meta": {
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.483Z",
              "status": "created"
            },
            "digest": "88bd7a67baa761c8c68032b4d9aaef82ff1e89149b3ab6c532723836c6f88a3c",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "UaQ97057qBTyl8SanZ64TL1IvGZdXQKDkktCMt/BaSJFdLO/oJvm3NC/MM64ZEUlDWGskrU7kVRUG/hfaxF4Bw=="
          },
          {
            "custom": {
              "luid": "$anc.-0847869HxNkGI2-Z",
              "moment": "2025-04-02T05:10:31.503Z",
              "status": "created"
            },
            "digest": "1d2c782e3fefb90213d77e3970ece504f7e50ac0a869383c8e917586b484f166",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "O2Wt+7bw7QOM1FbAL/uwTc+zoh0E/WoRqSk5+9hmBI/NZGCOfYntFs7yjpKozb20KPS0UYqfkh9gbyQf160zBA=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.498Z",
        "change": 1,
        "action": "create",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "handle": "svgs:-vqibKLJKikP@teslabank.io",
        "wallet": "tel:7027156866",
        "target": "tran:254085257323@minka.io",
        "symbol": "usd",
        "custom": {
          "name": "Chaz",
          "idType": "nidn",
          "idNumber": "IJdEsSmS",
          "entityType": "individual"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "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 an anchor change

GET
/anchors/{id}/changes/{change}

Authorization

BearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*|

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

change*integer

The change number of the record

Range1 <= value

Header Parameters

x-ledger?|

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3000/v2/anchors/admin/changes/3" \  -H "x-ledger: rtp-ledger"
{
  "hash": "6fbba0181fc0177365b62541ed7e94d8532ca6dd40651f23387d4c17d00967ec",
  "luid": "$anc.-0847869HxNkGI2-Z",
  "meta": {
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.483Z",
          "status": "created"
        },
        "digest": "88bd7a67baa761c8c68032b4d9aaef82ff1e89149b3ab6c532723836c6f88a3c",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "UaQ97057qBTyl8SanZ64TL1IvGZdXQKDkktCMt/BaSJFdLO/oJvm3NC/MM64ZEUlDWGskrU7kVRUG/hfaxF4Bw=="
      },
      {
        "custom": {
          "luid": "$anc.-0847869HxNkGI2-Z",
          "moment": "2025-04-02T05:10:31.503Z",
          "status": "created"
        },
        "digest": "1d2c782e3fefb90213d77e3970ece504f7e50ac0a869383c8e917586b484f166",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "O2Wt+7bw7QOM1FbAL/uwTc+zoh0E/WoRqSk5+9hmBI/NZGCOfYntFs7yjpKozb20KPS0UYqfkh9gbyQf160zBA=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.498Z",
    "change": 1,
    "action": "create",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ],
    "labels": null
  },
  "data": {
    "handle": "svgs:-vqibKLJKikP@teslabank.io",
    "wallet": "tel:7027156866",
    "target": "tran:254085257323@minka.io",
    "symbol": "usd",
    "custom": {
      "name": "Chaz",
      "idType": "nidn",
      "idNumber": "IJdEsSmS",
      "entityType": "individual"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "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=="
      }
    ]
  }
}

Symbol

A Symbol is a ledger record that defines a unit of exchange, such as a currency, loyalty points, or any countable asset. Each balance in the ledger is associated with a specific symbol, indicating what the balance represents. The owner of a symbol has the authority to issue new units of that symbol, controlling its supply. However, once units are issued and transferred to other wallets, the symbol owner cannot control their circulation; the holders of the balances have full control over their assets.

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.

On this page

No Headings