Create a new anchor.

post

https://api.woleet.io/v1/anchor

Use this operation to create a new anchor of one of these two types:

a data anchor (to generate a proof of timestamp allowing to prove the existence of a data at some point in time)
a signature anchor (to generate a proof of seal allowing to prove the existence of the signature of a data at some point in time, the validity of the signature and the identity of the signer)

The properties id, created, lastModified, status, timestamp and confirmations are read-only and so must not be provided: they are managed by the platform and added to the returned anchor.

For data anchors, only the properties name and hash are required: the hash property must be the SHA256 hash of the data to anchor, and must be computed caller side. This allows not to leak the original data.

For signature anchors, only the properties name, signedHash, signature and pubKey are required.

Be sure to have at least 1 timestamp credit (for a data anchor) or 1 seal credit (for a signature anchor).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Anchor object to create.

name

string

required

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

hash

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.

signedHash

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.

signedIdentity

string

X500 Distinguished Name representing the signed identity.

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

signedIssuerDomain

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.

pubKey

string

Public key of the signer.

Currently only Bitcoin addresses are supported.

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

signature

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.

identityURL

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.

public

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).

notifyByEmail

boolean

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

200The created anchor.