API Reference

Report

A Report is a ledger record that contains generated data or documents based on the ledger's information. The structure and content of a report are determined by its schema, while specific generation parameters are stored in the custom field. Reports can be used for auditing, compliance, reconciliation or providing insights into ledger activities.

List reports

GET
/reports

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/reports?limit=20&index=0" \  -H "x-ledger: rtp-ledger"
{
  "hash": "d76f4e7ce3a2965b2afc1ff7f06b9390fc1964b6c9a07af4f55951cde296a366",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "64dba73fd2a2c1fcdbc79972a5dc44b5c998a543eb7e4dd07e09bc648abb6896",
        "result": "CLcje/qWSkwvBLdMpg4f2OD1AWp5wi1laIu+gGWa+HOOnnY76Jc+HJ23GbWzs1dI2VvCe+ZbsvBnJKOJN1YeDA==",
        "custom": {
          "moment": "2025-04-02T05:10:33.409Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.409Z"
  },
  "data": [
    {
      "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
      "data": {
        "handle": "KpZmFAAi4zGs6wLybqKAI",
        "schema": "settlement",
        "custom": {
          "end": "2024-11-01T00:00:00.000Z",
          "date": "2024-10-01",
          "batch": "01",
          "start": "2024-10-01T00:00:00.000Z",
          "symbol": "usd"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
              }
            }
          }
        ]
      },
      "luid": "$rep.-08478N7L2zxNC4vH",
      "meta": {
        "assets": [
          {
            "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
            "output": "gs://ledger-reports/example_report.csv"
          }
        ],
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.834Z",
              "status": "created"
            },
            "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
          },
          {
            "custom": {
              "luid": "$rep.-08478N7L2zxNC4vH",
              "moment": "2025-04-02T05:10:31.855Z",
              "status": "created"
            },
            "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
          },
          {
            "custom": {
              "assets": [
                {
                  "handle": "Reconciliation_example_bank_ooyiCPbhQXW1_nE_usd.csv",
                  "output": "gs://ledger-reports/example_report_7TK4lti4X8Py.csv"
                }
              ],
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "pending"
            },
            "digest": "a3b423fcda2d9eca017f99be1fcca2fba25a29033c4f697c3a6cda8bfe9b7537",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "FCWwXCdtFLdbGhSDPP80jBIbsa7QUhZf8cZwwKay1r4AcyvcPg8O/86Qy8gMVtv4ToJrDvkIrQ/14veoqaxFBQ=="
          }
        ],
        "status": "pending",
        "moment": "2025-04-02T05:10:31.852Z",
        "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 report

POST
/reports

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

Report 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/reports" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",    "data": {      "handle": "KpZmFAAi4zGs6wLybqKAI",      "schema": "settlement",      "custom": {        "end": "2024-11-01T00:00:00.000Z",        "date": "2024-10-01",        "batch": "01",        "start": "2024-10-01T00:00:00.000Z",        "symbol": "usd"      },      "access": [        {          "action": "any",          "signer": {            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="          }        },        {          "action": "read",          "bearer": {            "$signer": {              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="            }          }        }      ]    },    "meta": {      "status": "created",      "assets": [        {          "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",          "output": "gs://ledger-reports/example_report.csv"        }      ],      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",          "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ==",          "custom": {            "moment": "2025-04-02T05:10:31.834Z",            "status": "created"          }        }      ]    }  }'
{
  "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
  "data": {
    "handle": "KpZmFAAi4zGs6wLybqKAI",
    "schema": "settlement",
    "custom": {
      "end": "2024-11-01T00:00:00.000Z",
      "date": "2024-10-01",
      "batch": "01",
      "start": "2024-10-01T00:00:00.000Z",
      "symbol": "usd"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
          }
        }
      }
    ]
  },
  "luid": "$rep.-08478N7L2zxNC4vH",
  "meta": {
    "assets": [
      {
        "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
        "output": "gs://ledger-reports/example_report.csv"
      }
    ],
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.834Z",
          "status": "created"
        },
        "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
      },
      {
        "custom": {
          "luid": "$rep.-08478N7L2zxNC4vH",
          "moment": "2025-04-02T05:10:31.855Z",
          "status": "created"
        },
        "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.852Z",
    "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 report

GET
/reports/{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/reports/admin" \  -H "x-ledger: rtp-ledger"
{
  "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
  "data": {
    "handle": "KpZmFAAi4zGs6wLybqKAI",
    "schema": "settlement",
    "custom": {
      "end": "2024-11-01T00:00:00.000Z",
      "date": "2024-10-01",
      "batch": "01",
      "start": "2024-10-01T00:00:00.000Z",
      "symbol": "usd"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
          }
        }
      }
    ]
  },
  "luid": "$rep.-08478N7L2zxNC4vH",
  "meta": {
    "assets": [
      {
        "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
        "output": "gs://ledger-reports/example_report.csv"
      }
    ],
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.834Z",
          "status": "created"
        },
        "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
      },
      {
        "custom": {
          "luid": "$rep.-08478N7L2zxNC4vH",
          "moment": "2025-04-02T05:10:31.855Z",
          "status": "created"
        },
        "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
      },
      {
        "custom": {
          "assets": [
            {
              "handle": "Reconciliation_example_bank_ooyiCPbhQXW1_nE_usd.csv",
              "output": "gs://ledger-reports/example_report_7TK4lti4X8Py.csv"
            }
          ],
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "pending"
        },
        "digest": "a3b423fcda2d9eca017f99be1fcca2fba25a29033c4f697c3a6cda8bfe9b7537",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "FCWwXCdtFLdbGhSDPP80jBIbsa7QUhZf8cZwwKay1r4AcyvcPg8O/86Qy8gMVtv4ToJrDvkIrQ/14veoqaxFBQ=="
      }
    ],
    "status": "pending",
    "moment": "2025-04-02T05:10:31.852Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Drop a report

DELETE
/reports/{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

Report 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/reports/admin" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead"    },    "hash": "3e781e0b268461c247321b64651b7122d2e4b4652d391532886fb058d2da879a",    "luid": "$rep.-08478N7L2zxNC4vH",    "meta": {      "assets": [        {          "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",          "output": "gs://ledger-reports/example_report.csv"        }      ],      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "e9aefb63c19ac72b4393b16dfd597d6956a4ff556cecfa44ba186780387ca310",          "result": "4v4UCu6wcuyvpbCEiJUE6j8di7pfXkWPFWmCnw5KKm32pe/aUdR1/1WxjSFunV63RjCi1zHnfBMTWaUhLjNGAg==",          "custom": {            "moment": "2025-04-02T05:10:33.951Z",            "status": "dropped"          }        }      ],      "status": "pending",      "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=="
      }
    ]
  }
}

Sign a report

POST
/reports/{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/reports/admin/proofs" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "method": "ed25519-v2",    "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",    "digest": "a3b423fcda2d9eca017f99be1fcca2fba25a29033c4f697c3a6cda8bfe9b7537",    "result": "FCWwXCdtFLdbGhSDPP80jBIbsa7QUhZf8cZwwKay1r4AcyvcPg8O/86Qy8gMVtv4ToJrDvkIrQ/14veoqaxFBQ==",    "custom": {      "moment": "2025-04-02T05:10:30.823Z",      "status": "pending",      "assets": [        {          "handle": "Reconciliation_example_bank_ooyiCPbhQXW1_nE_usd.csv",          "output": "gs://ledger-reports/example_report_7TK4lti4X8Py.csv"        }      ]    }  }'
{
  "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
  "data": {
    "handle": "KpZmFAAi4zGs6wLybqKAI",
    "schema": "settlement",
    "custom": {
      "end": "2024-11-01T00:00:00.000Z",
      "date": "2024-10-01",
      "batch": "01",
      "start": "2024-10-01T00:00:00.000Z",
      "symbol": "usd"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
          }
        }
      }
    ]
  },
  "luid": "$rep.-08478N7L2zxNC4vH",
  "meta": {
    "assets": [
      {
        "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
        "output": "gs://ledger-reports/example_report.csv"
      }
    ],
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.834Z",
          "status": "created"
        },
        "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
      },
      {
        "custom": {
          "luid": "$rep.-08478N7L2zxNC4vH",
          "moment": "2025-04-02T05:10:31.855Z",
          "status": "created"
        },
        "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
      },
      {
        "custom": {
          "assets": [
            {
              "handle": "Reconciliation_example_bank_ooyiCPbhQXW1_nE_usd.csv",
              "output": "gs://ledger-reports/example_report_7TK4lti4X8Py.csv"
            }
          ],
          "moment": "2025-04-02T05:10:30.823Z",
          "status": "pending"
        },
        "digest": "a3b423fcda2d9eca017f99be1fcca2fba25a29033c4f697c3a6cda8bfe9b7537",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "FCWwXCdtFLdbGhSDPP80jBIbsa7QUhZf8cZwwKay1r4AcyvcPg8O/86Qy8gMVtv4ToJrDvkIrQ/14veoqaxFBQ=="
      }
    ],
    "status": "pending",
    "moment": "2025-04-02T05:10:31.852Z",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ]
  }
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Check access in a report instance

POST
/reports/{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/reports/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": "666fdc170269b0c776e9d4d327beb93f3da4f8a50bb5003f51b69dcf5c2821dd",          "result": "QbqXs46Jok21I8cHo94dfVC4BDMyfK8GLhj3yghW0OujT9HMQnydNxK8SSzFN50BrBiHWLMDIeRTYpf+qmZOAA==",          "custom": {            "moment": "2025-04-02T05:10:32.847Z"          }        }      ]    }  }'
{
  "hash": "b0b2b575c6d387eb1192848be6d9bcc7e6a6fd7bc7b4e7828ed258122fe3750f",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "d1f12ff7947d744b0af54b41b3e0f19acb5a504773662d36fdc6443a629c7cbc",
        "result": "1FQ4Bg46t0jwHwo6jAzklPDgncm0UbK8McASKxMIyoFxxOkuTLL11zBM72s6543VUZqRMWOIZ0zNUNDpaB1oCQ==",
        "custom": {
          "moment": "2025-04-02T05:10:32.859Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:32.859Z"
  },
  "data": [
    {
      "hash": "025df7863203da41282a910802a1f50a943adfdbb824152f81caea881d2a251d",
      "data": {
        "action": "any",
        "record": "any"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "895f877fae92cc5e74e95cbff64b891f5046130f8bb24b3bc8fee81beea04812",
            "result": "QLidETrix40SMzjdZk6AJpqUINvBu6H0pGU6mdkI0y0nVuSuH/HAGAd14GQllL+Y25sxpfASVecdCPJmrdT5Dw==",
            "custom": {
              "moment": "2025-04-02T05:10:32.858Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.858Z"
      }
    },
    {
      "hash": "dc8ce57498f46db01e00548158b3dd5f19039214a5e9fc57ee6abbb37cd0b781",
      "data": {
        "action": "any",
        "record": "report"
      },
      "meta": {
        "proofs": [
          {
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "digest": "ad7a9766679092af5661b609d674ac981d880f52b452ddbcaed76714130f4e55",
            "result": "xk8zd2x/Yh231nAZolAoGfCLnrPg81L8vyItWmv8ljuxD5OGON55xWCQ6F4EStr96PUInJUHI4ls892qLB9oBA==",
            "custom": {
              "moment": "2025-04-02T05:10:32.859Z"
            }
          }
        ],
        "moment": "2025-04-02T05:10:32.859Z"
      }
    }
  ]
}
{
  "hash": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "JdK8m5SqXGCiZ1TdXQbCe9ECqwL3Kg1UZxj4r9gT+cA=",
        "digest": "7846195d1e2f8bc75aa0ab35a238b70dc28c809b8fde33ea7d29e9f8d6d6841b",
        "result": "X2m5A9Yxh4FRPgj6wgJKN0dYrfgXSq3hx8UX1jnmJ7fVHtQCnAp8MepXDZQhNkMsJd7a9HPk96hmvYXTFcHzAw=="
      }
    ]
  }
}
{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ=="
      }
    ]
  }
}
{
  "hash": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "7ZMqyx5Lk3PQwNrJvGIs9eT6ahcUKXZ8SbRj4WyF2dQ=",
        "digest": "b29a7f4e1d5c3b6a8f7e0d9c2b5a8f7e0d3c6b9a8f7e1d4c7b0a3f6e9d2c5b8a",
        "result": "VFp8RxnT2h+JK9W5/nJfLZdV1uLKXHBL5RwpnbZ4qDz3J1Ks4eOj7y9QVMhmwlIa5AQlNbdT3GJcvH8xo3WhBA=="
      }
    ]
  }
}

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

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

Drop a report

POST
/reports/{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

Report 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/reports/admin/drop" \  -H "x-ledger: rtp-ledger" \  -H "Content-Type: application/json" \  -d '{    "data": {      "parent": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead"    },    "hash": "3e781e0b268461c247321b64651b7122d2e4b4652d391532886fb058d2da879a",    "luid": "$rep.-08478N7L2zxNC4vH",    "meta": {      "assets": [        {          "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",          "output": "gs://ledger-reports/example_report.csv"        }      ],      "proofs": [        {          "method": "ed25519-v2",          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",          "digest": "e9aefb63c19ac72b4393b16dfd597d6956a4ff556cecfa44ba186780387ca310",          "result": "4v4UCu6wcuyvpbCEiJUE6j8di7pfXkWPFWmCnw5KKm32pe/aUdR1/1WxjSFunV63RjCi1zHnfBMTWaUhLjNGAg==",          "custom": {            "moment": "2025-04-02T05:10:33.951Z",            "reason": "Report is no longer needed",            "status": "dropped"          }        }      ],      "status": "pending",      "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 report changes

GET
/reports/{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/reports/admin/changes?limit=20&index=0&data.publicKey.%24eq=pjcf%2Fa9F0IRXTWqsgb7rtSTbI3HdeZ8DI5l8AcP%2B25Q%3D" \  -H "x-ledger: rtp-ledger"
{
  "hash": "4cb1e6e1538b7ccc5585ce71d2839c9c2703c7801b9c7842e5bd9619ad28cad3",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "digest": "43efcca734ca8456b878538df6c431953ee17a1619d49a1a56fe2974495cbee8",
        "result": "TqCLpe+OxO4uo4n3QKDDcLklYD1L8O6ejrm7WcxLt0RjssxTGGsbuCz3US94jo3ZBdNz34L9icB6WU3AwrNeCw==",
        "custom": {
          "moment": "2025-04-02T05:10:33.434Z"
        }
      }
    ],
    "moment": "2025-04-02T05:10:33.434Z"
  },
  "data": [
    {
      "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
      "luid": "$rep.-08478N7L2zxNC4vH",
      "meta": {
        "assets": [
          {
            "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
            "output": "gs://ledger-reports/example_report.csv"
          }
        ],
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.834Z",
              "status": "created"
            },
            "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
          },
          {
            "custom": {
              "luid": "$rep.-08478N7L2zxNC4vH",
              "moment": "2025-04-02T05:10:31.855Z",
              "status": "created"
            },
            "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
          },
          {
            "custom": {
              "assets": [
                {
                  "handle": "Reconciliation_example_bank_ooyiCPbhQXW1_nE_usd.csv",
                  "output": "gs://ledger-reports/example_report_7TK4lti4X8Py.csv"
                }
              ],
              "moment": "2025-04-02T05:10:30.823Z",
              "status": "pending"
            },
            "digest": "a3b423fcda2d9eca017f99be1fcca2fba25a29033c4f697c3a6cda8bfe9b7537",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "FCWwXCdtFLdbGhSDPP80jBIbsa7QUhZf8cZwwKay1r4AcyvcPg8O/86Qy8gMVtv4ToJrDvkIrQ/14veoqaxFBQ=="
          }
        ],
        "status": "pending",
        "moment": "2025-04-02T05:10:32.566Z",
        "change": 2,
        "action": "update",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "handle": "KpZmFAAi4zGs6wLybqKAI",
        "schema": "settlement",
        "custom": {
          "end": "2024-11-01T00:00:00.000Z",
          "date": "2024-10-01",
          "batch": "01",
          "start": "2024-10-01T00:00:00.000Z",
          "symbol": "usd"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
              }
            }
          }
        ]
      }
    },
    {
      "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
      "luid": "$rep.-08478N7L2zxNC4vH",
      "meta": {
        "assets": [
          {
            "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
            "output": "gs://ledger-reports/example_report.csv"
          }
        ],
        "proofs": [
          {
            "custom": {
              "moment": "2025-04-02T05:10:31.834Z",
              "status": "created"
            },
            "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
            "method": "ed25519-v2",
            "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
            "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
          },
          {
            "custom": {
              "luid": "$rep.-08478N7L2zxNC4vH",
              "moment": "2025-04-02T05:10:31.855Z",
              "status": "created"
            },
            "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
            "method": "ed25519-v2",
            "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
            "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
          }
        ],
        "status": "created",
        "moment": "2025-04-02T05:10:31.852Z",
        "change": 1,
        "action": "create",
        "owners": [
          "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        ],
        "labels": null
      },
      "data": {
        "handle": "KpZmFAAi4zGs6wLybqKAI",
        "schema": "settlement",
        "custom": {
          "end": "2024-11-01T00:00:00.000Z",
          "date": "2024-10-01",
          "batch": "01",
          "start": "2024-10-01T00:00:00.000Z",
          "symbol": "usd"
        },
        "access": [
          {
            "action": "any",
            "signer": {
              "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
            }
          },
          {
            "action": "read",
            "bearer": {
              "$signer": {
                "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
              }
            }
          }
        ]
      }
    }
  ],
  "page": {
    "index": "0",
    "limit": "10",
    "total": 2
  }
}
{
  "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 report change

GET
/reports/{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/reports/admin/changes/3" \  -H "x-ledger: rtp-ledger"
{
  "hash": "22ec058d2b8565780d11e2382ab3e5ee164ca9039196dae491fd0487571dfead",
  "luid": "$rep.-08478N7L2zxNC4vH",
  "meta": {
    "assets": [
      {
        "handle": "Reconciliation_example_bank_IB29zjZntEKl_eG_usd.csv",
        "output": "gs://ledger-reports/example_report.csv"
      }
    ],
    "proofs": [
      {
        "custom": {
          "moment": "2025-04-02T05:10:31.834Z",
          "status": "created"
        },
        "digest": "3b109798b0363c554d3989ec8a35b4ebe494c6cfed8f713c00d4341bea302719",
        "method": "ed25519-v2",
        "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck=",
        "result": "nAm2V9oIWZHd+3aE4ypniRJdj/c28jK0XXXLcQWb0XZBqJhh/eh8fVkxYpQe+kIL98rEcgS/toJ/TDkzcBEDCQ=="
      },
      {
        "custom": {
          "luid": "$rep.-08478N7L2zxNC4vH",
          "moment": "2025-04-02T05:10:31.855Z",
          "status": "created"
        },
        "digest": "cb97c3535352ce63442751fd9e9a5704071c48faea61dcf8b9090ad8b6a416f8",
        "method": "ed25519-v2",
        "public": "SYqAsweCOCByOQrC9DSjAmIVlyocndNaB/GyjxfQY5U=",
        "result": "Q4PcVmFnG4x3g00vr8VPB+REfYYgsbdG9GdWBX1UQSuFSE13gaGxe82ncd6CdPNogeYetiBmcrmJAwSfG2dvBg=="
      }
    ],
    "status": "created",
    "moment": "2025-04-02T05:10:31.852Z",
    "change": 1,
    "action": "create",
    "owners": [
      "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
    ],
    "labels": null
  },
  "data": {
    "handle": "KpZmFAAi4zGs6wLybqKAI",
    "schema": "settlement",
    "custom": {
      "end": "2024-11-01T00:00:00.000Z",
      "date": "2024-10-01",
      "batch": "01",
      "start": "2024-10-01T00:00:00.000Z",
      "symbol": "usd"
    },
    "access": [
      {
        "action": "any",
        "signer": {
          "public": "gef6OID0o7ZFGTXutV62mh+zv5kgkFP3QLiR+N7syck="
        }
      },
      {
        "action": "read",
        "bearer": {
          "$signer": {
            "public": "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=="
      }
    ]
  }
}

Signer

A Signer is a ledger record that associates a cryptographic key pair with additional metadata. These key pairs are essential for signing and verifying requests to the ledger, ensuring authenticity and integrity. Signers can include extra information, such as security constraints or links to external records, providing context and enhancing the management of signing authorities.

System Request

A System Request is a ledger record that logs incoming and outgoing requests to the ledger, including API calls related to records, intent processing, and event dispatches. These logs capture details such as the source and target of the request, the specific record involved, and the action performed. System Requests are signed by the ledger for authenticity and can be used for auditing, monitoring, or debugging purposes.

On this page

No Headings