Update an anchor.

Use this operation to update an anchor.

Only the properties name, public, tags, metadata and callbackURL can be modified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of anchor to update.

Body Params

Anchor object to update.

string
required

Name of the anchor (doesn't need to be unique).

string

SHA256 hash of the data to anchor.

The value must be provided as an hexadecimal lowercase string. The hash of the empty file is forbidden.

This property must not be provided when creating a signature anchor: it is automatically set at creation time to the SHA256 hash of the signature property provided, meaning that the signature is the actual anchored data.

string

SHA256 hash of the signed data.

The value must be provided as an hexadecimal lowercase string. The hash of the empty file is forbidden.

This property must not be provided when creating a data anchor.

string

X500 Distinguished Name representing the signed identity.

This property must not be provided when creating a data anchor.

string

Domain name of the identity server.

If set, the domain name of the identity URL must be included in the signedIssuerDomain domain name.

This property must not be provided when creating a data anchor.

string

Public key of the signer.

Currently only Bitcoin addresses are supported.

This property must not be provided when creating a data anchor.

string

Signature of the signedHash property using the public key pubKey, or, if any of the signedIdentity or signedIssuerDomain properties are provided,
signature of SHA256(signedHash + signedIdentity + signedIssuerDomain) using the public key pubKey.

Only Bitcoin signatures are currently supported.

This property must not be provided when creating a data anchor.

string

Web hook of the identity server to use to verify the signer's identity.

It is used to verify that the server knows the pubKey public key and to get or check the identity of the user owning that key.

For proofs of seal, it is also used to verify that the identity server (itself identified by the TLS certificate of the URL)
controls the key used to sign (ie. owns the private part of the key pair) by requesting it to sign some random data.

Please refer to Woleet.ID Server documentation for more details.

boolean

true (or unset) if the anchor is public (ie. discoverable by its hash or signedHash) or false if it must be private (ie. not discoverable).

boolean

true if the proof receipt must be sent by email once available, or false (or unset) if not.

tags
array of strings

Set of tags associated to the anchor. There is no restriction on tag names, except they cannot contain spaces.

Tags are aimed at classifying and searching anchors.

tags
metadata
object

A set of variables (key/values pairs) to store with the anchor.

Values must be of type null, boolean, string or number: nested JSON objects are not allowed.

string

Web hook to be called by the platform whenever the status property of the anchor changes.

The platform does a POST request on this URL with the anchor as a JSON object in the request body. The domain of the URL must resolve to an external IP address.

Verifying the authenticity of the callback can be done by checking the HMAC-SHA1 signature of the request body provided by the platform in the x-woleet-signature header.

Please refer to this documentation for more details.

Responses

400

Invalid request. More details are returned in the response body as a JSON object.

404

No anchor matching the given identifier.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json