These docs are for v1.5.1. Click to read the latest docs for v1.15.1.

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
required

SHA256 hash (ie. the fingerprint) of the original data to anchor.

This property must not be provided when creating a signature anchor: it is set at creation time to the SHA256 hash of the signature property provided (so the signature is what is actually anchored in this case).

string

SHA256 hash (ie. the fingerprint) of the original data to sign.

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

string

Public key of the signee.

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 stored in the pubKey property.

Only Bitcoin signatures are currently supported.

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

string

Web hook to use to verify the signee's identity.

Calling this URL allows to verify that the owner of the URL (identified by the associated TLS certificate) also owns the public key used to produce the signature, by asking the URL to sign some random data.

This URL must use an HTTPS scheme with a valid and non expired TLS certificate.

This URL must implement the following GET operation:

input:

  • pubKey: the public key to be verified
  • leftData: the left part of the random data to be signed (generated by the caller)

    output:
  • rightData: the right part of the random data signed (generated by the callee)
  • signature: the signature of the string leftData + rightData produced using the public key pubKey
boolean

true (or unset) if the anchor is public. false if the anchor is private.

If this field is not set at creation time, the anchor is public by default.

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
string

Web hook to be called by the platform whenever the anchor status change:
the platform does a POST request on this URL with the anchor as a JSON object in the request body.
Verifying the authenticity of the callback can be done by checking the HMAC-SHA1 signature of the request body provided by Woleet in the x-woleet-signature header.
For more information see the documentation.

Responses

400

Invalid anchor object. 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