ReferenceAPI ReferenceEffect

Add effect proof

POST/effects/{id}/proofs●Submit a signed proof to an effect record.

Appends a signed proof to the record. The proof must be signed against the record's current hash. Use proofs to change status, update labels, or record custom data — see About Proofs for details.

Returns the updated record with the new proof in meta.proofs.

Broadcasts the effect-proofs-added signal.

POST
/effects/{id}/proofs

Usage Examples

curl -X POST "http://localhost:3000/v2/effects/<HANDLE>/proofs" \  -H "x-ledger: <YOUR LEDGER HANDLE>" \  -H "Content-Type: application/json" \  -d '{    "method": "ed25519-v2",    "public": "dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk=",    "digest": "2e2b19bada02b52d515497f47e822cf2ed4769d89c6f0c0d8810a49392a152df",    "result": "RtFQHJNJdqh4BJa/3+JWK9imb8Y1baUn3tQpk69L1jbYhS9TtU1Tv4zMgIWSY8OrRTSpD5wv2E2/dTMTotXeDQ==",    "custom": {      "moment": "2025-04-05T14:30:10.000Z",      "status": "approved"    }  }'
{
  "luid": "$eff.-01xK5vWxY6hW8AB7",
  "hash": "92a858f132198ba17f4e9bafbfd2fa55f521236cb4780e2cb335f02c29840d55",
  "data": {
    "handle": "intent-created",
    "signal": "intent-created",
    "action": {
      "bridge": "tesla-bank-bridge"
    }
  },
  "meta": {
    "status": "approved",
    "moment": "2025-04-05T14:30:10.020Z",
    "owners": [
      "dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk="
    ],
    "proofs": [
      {
        "signer": "tesla-bank-admin",
        "method": "ed25519-v2",
        "digest": "4002631f636059f68e31bc8e517f026daf592ec6f9cf2a311af1b89048b58802",
        "public": "dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk=",
        "result": "jUI71kR80f3uIRrj2oaot+k7STGxmibE6YTIx42OxaFKgKvaOw7d1JSxIp2Qf488czdt9hurVzgElOpnZb2qBA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z",
          "status": "created"
        }
      },
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "b90e717212ccaea9f46c7bae5206905daaa67f3b5f0f9ef058dae036955c0276",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "7WaxRr3Uff7fxLs+I0wlc/htE5OwyMIi4ahIIq7p3ZG2itgBT9O+Gxqk46Zjf6HeKB1GjLjQXWMmndxMSFyvCQ==",
        "custom": {
          "luid": "$eff.-01xK5vWxY6hW8AB7",
          "moment": "2025-04-05T14:30:00.050Z",
          "status": "created"
        }
      },
      {
        "signer": "tesla-bank-admin",
        "method": "ed25519-v2",
        "digest": "2e2b19bada02b52d515497f47e822cf2ed4769d89c6f0c0d8810a49392a152df",
        "public": "dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk=",
        "result": "RtFQHJNJdqh4BJa/3+JWK9imb8Y1baUn3tQpk69L1jbYhS9TtU1Tv4zMgIWSY8OrRTSpD5wv2E2/dTMTotXeDQ==",
        "custom": {
          "moment": "2025-04-05T14:30:10.000Z",
          "status": "approved"
        }
      }
    ]
  }
}
{
  "hash": "b7eb7ccf5ffc126951e13e29a8dcfdaf95db859715d4edfc2d16f59a79d4cd58",
  "data": {
    "reason": "auth.unauthorized",
    "detail": "Invalid token."
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "3acece870c4118bfe4223118e4d2f3cfd5b8947a7093785b66d49aa57fa2890a",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "gnK63DqqWDY/UXvnZHixDKPKS6tfeGHgdARylnPiJLwQGyYxuD97TYbSg2wrzsf/bDrHwQYZaf8Gu5ryYP0UAA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}
{
  "hash": "9ec02726b50650add8acfd124c6defeb978a9ac252a5de888f9493ddc701e927",
  "data": {
    "reason": "auth.forbidden",
    "detail": "Request is not authorized"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "4f8cbdc38d73348de0c31805c783c84a0fecc6be736d7e187004ba68cd00e675",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "P3hRnveehtuobb4AIO56XBmiduvmYJbpdmOHltG/IifBEH7QSWdv/0pqled4SO9x1Ne3oXuWxJy40DzMvx1MBA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}
{
  "hash": "d6c59a6df7165fa4a75159799ca5f5e26e544cbb8769eced3d35d8021f6f7935",
  "data": {
    "reason": "record.not-found",
    "detail": "Signer not found"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "78cf86f34aefcf9da6ed4167a38aac0a2739f68f7bafb1d3e033c01ed1b6cdf1",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "9Ledk+/iAAtj+uLjGe2afq4kID7n8UQD6UpRpLBCujxFjxddq0uZ2tnYRTAXmYdHDkbF0uXqtNM9qO3xhEtpAA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

{
  "hash": "1c084e8dcfb9bb84bc8ea96e9e137b149a34b2bbd85f8e60b4263f5aba980476",
  "data": {
    "custom": {
      "errors": [
        {
          "instancePath": "/handle",
          "schemaPath": "#/properties/handle/pattern",
          "keyword": "pattern",
          "params": {
            "pattern": "^[a-zA-Z0-9_\\-+.]+$"
          },
          "message": "must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
        }
      ]
    },
    "reason": "record.schema-invalid",
    "detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "7a5febb431719b6f43d7e88e79211308e16ac651b71b339276373fdb4e7c3760",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "2/1zYw4AaIzsIHfOIC6V/CHw6owbjYHt48cwmFOig0ibeT0IbojLmj1RCRi8W00ka0udPa9WsacWDd7ObMY8CA==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

{
  "hash": "93a5f4d97a42c2df97f827c58ff7768d02568c15aca931e22b81fa3160ba0df3",
  "data": {
    "reason": "api.unexpected-error",
    "detail": "An unexpected error occurred"
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "efaf5360143b586917d9636779ad6e08571c5b06909a20dd0f5eba4bf3be7eae",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "hERh6Aecj59iR+Fb25OQsHJScOi4t8EiffKSfjlMQdjHMccTnfDlgZFdaJzXzUtpSwy/NHq0l+7ydh3HSWCoAg==",
        "custom": {
          "moment": "2025-04-05T14:30:00.000Z"
        }
      }
    ]
  }
}

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

Delete effect DELETE

Stops event delivery and permanently removes the effect record. Events that were already delivered are not affected. The [change history](/ledger/reference/api/effect/list-effect-changes) remains accessible after deletion — use the record's LUID to query it. Previous record versions can be retrieved for auditing. A [POST alternative](/ledger/reference/api/effect/drop-effect-post) is available for clients that cannot send request bodies with DELETE requests. Broadcasts the `effect-dropped` signal.

Activate effect POST

**Kept for backward compatibility.** Use `POST /effects/{id}/events/retry` instead, which is the preferred endpoint going forward. Retries effect event deliveries that have failed or are still scheduled but not delivered. For each affected event to be delivered, any existing scheduled jobs are cancelled and a new delivery is queued with the retry backoff reset to its initial value. Use the `maxAge` parameter to limit retries to events whose last delivery attempt was created within the past N minutes (default: 60, max: 48 hours enforced server-side). Set `maxAge` to 0 to retry all events for the effect regardless of age. **Required access action:** `activate`