ReferenceAPI ReferenceAnchor

Update anchor

PUT/anchors/{id}●Submit a new version of an anchor.

The request must include the current record hash in data.parent to prevent conflicts from concurrent updates. If the parent hash does not match the record's current hash, the request is rejected with a 422 error.

When forwarding is configured, this request may be validated or proxied through a bridge before being committed locally. See Anchor Forwarding.

Broadcasts the anchor-updated signal. Use effects to subscribe.

PUT
/anchors/{id}

Usage Examples

curl -X PUT "http://localhost:3000/v2/anchors/<HANDLE>" \  -H "x-ledger: <YOUR LEDGER HANDLE>" \  -H "Content-Type: application/json" \  -d '{    "luid": "$anc.-01xK1rTtU2dS4wX3",    "hash": "494e7e3d6eb5743eba61ba2982ea0a106bb4d3ff2f79858fdc1cf5855417e89e",    "data": {      "handle": "tel:+1234567890",      "parent": "dee7cd9ae3aff0395882aee8b26469fb0e43d8e34e3892ed086026eb6ee866e2",      "target": {        "handle": "svgs:2002002345@tesla-bank.com",        "custom": {          "name": "John Doe"        }      },      "symbol": "usd",      "custom": {        "title": "Personal phone alias"      }    },    "meta": {      "proofs": [        {          "method": "ed25519-v2",          "digest": "bda131589cef281e5949893dcf1b964bff60c0fb9e7e45e3c04e7a8c6d8908bd",          "public": "RyXTVL6wSgoBMSZRmTnnKBc82dQGLn5y4Nlp8KRwMLA=",          "result": "JbC304+FyjfKxVmZ4IY76BNPaArhvJkNpwbRVwLRG7mwqFTzrVhGa3vqp6+4LV9HO4wkaCB5kIYTaEtu8cOYDQ==",          "custom": {            "moment": "2025-04-05T14:30:00.200Z"          }        }      ]    }  }'
{
  "luid": "$anc.-01xK1rTtU2dS4wX3",
  "hash": "494e7e3d6eb5743eba61ba2982ea0a106bb4d3ff2f79858fdc1cf5855417e89e",
  "data": {
    "handle": "tel:+1234567890",
    "parent": "dee7cd9ae3aff0395882aee8b26469fb0e43d8e34e3892ed086026eb6ee866e2",
    "target": {
      "handle": "svgs:2002002345@tesla-bank.com",
      "custom": {
        "name": "John Doe"
      }
    },
    "symbol": "usd",
    "custom": {
      "title": "Personal phone alias"
    }
  },
  "meta": {
    "status": "created",
    "moment": "2025-04-05T14:30:00.220Z",
    "owners": [
      "RyXTVL6wSgoBMSZRmTnnKBc82dQGLn5y4Nlp8KRwMLA="
    ],
    "proofs": [
      {
        "signer": "tesla-bank-bridge",
        "method": "ed25519-v2",
        "digest": "bda131589cef281e5949893dcf1b964bff60c0fb9e7e45e3c04e7a8c6d8908bd",
        "public": "RyXTVL6wSgoBMSZRmTnnKBc82dQGLn5y4Nlp8KRwMLA=",
        "result": "JbC304+FyjfKxVmZ4IY76BNPaArhvJkNpwbRVwLRG7mwqFTzrVhGa3vqp6+4LV9HO4wkaCB5kIYTaEtu8cOYDQ==",
        "custom": {
          "moment": "2025-04-05T14:30:00.200Z"
        }
      },
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "ca3e55294338c49258be33d9c8898306ce6e7d0da69c553cd9ac689e193f492e",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "v7EHJakuMs6lx0cz6OyrleCIeKRkkFePGGKyADyyGBavqBbAuZDJEQgE9xrjZaU5nJtYwAzWEYRE84+lsy/tCw==",
        "custom": {
          "luid": "$anc.-01xK1rTtU2dS4wX3",
          "moment": "2025-04-05T14:30:00.220Z"
        }
      }
    ]
  }
}
{
  "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": "dc973d46dd35baa27b0ec5a107e2ee3a8cc57116d086dd868dd0f044a8de7d92",
  "data": {
    "reason": "record.duplicated",
    "detail": "Ledger with handle instant-payments already exists."
  },
  "meta": {
    "proofs": [
      {
        "signer": "system",
        "method": "ed25519-v2",
        "digest": "3e1317cc165d132f95ec2f6374890063c162d905d86b33270f97416f8441a872",
        "public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
        "result": "b+0gSDCUzjEKlZQ/c40yqNpZoyQxCFsbV1Ut5/0zM2wM46xmHMBj3qeo3/GDaFD4NgSNm2G8n1f9c9rfvkl3BA==",
        "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

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

Get anchor GET

When forwarding is configured with the `fallback` strategy, the bridge is queried if the anchor is not found locally. With `proxy`, the bridge is always queried. See [Anchor Forwarding](/ledger/moving-money/anchor-forwarding).

Delete anchor DELETE

Permanently removes the anchor record. If anchor forwarding is configured, the deletion may be validated or proxied through the assigned bridge before being committed. The [change history](/ledger/reference/api/anchor/list-anchor-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/anchor/drop-anchor-post) is available for clients that cannot send request bodies with DELETE requests. Broadcasts the `anchor-dropped` signal. Use [effects](/ledger/reference/api/effect) to subscribe.