# Woleet Documentation

> Digital Truth Provider. Woleet secures your documents with a universal time-stamped proof of existence or signature thanks to the Bitcoin blockchain.

## Guides
- [The Woleet software suite](https://doc.woleet.io/docs/woleet-software-suite.md)
- [Frequently Asked Questions](https://doc.woleet.io/docs/frequently-asked-questions.md)
- [Data anchoring](https://doc.woleet.io/docs/data-anchoring.md)
- [Signature anchoring](https://doc.woleet.io/docs/signature-anchoring.md)
- [Identity management](https://doc.woleet.io/docs/identity-management.md)
- [Seal and signature proofs](https://doc.woleet.io/docs/signature-proofs.md)
- [Which tool for my needs?](https://doc.woleet.io/docs/which-tool-for-my-needs.md)
- [How to integrate certification and e-signature in my application?](https://doc.woleet.io/docs/how-to-integrate-in-my-application.md)
- [What is Woleet Dashboard?](https://doc.woleet.io/docs/woleet-dashboard.md)
- [What is Woleet Sign?](https://doc.woleet.io/docs/woleet-sign.md)
- [What is Woleet Auditor?](https://doc.woleet.io/docs/woleet-auditor.md)
- [What is ProofKeeper?](https://doc.woleet.io/docs/woleet-proofkeeper.md)
- [How to install ProofKeeper?](https://doc.woleet.io/docs/installation-1.md)
- [How to configure the folders to timestamp and seal](https://doc.woleet.io/docs/configure-the-folders-to-timestamp-and-seal.md)
- [What is Woleet CLI?](https://doc.woleet.io/docs/woleet-cli.md)
- [What is Woleet.ID Server?](https://doc.woleet.io/docs/woleetid-server.md)
- [Verifying identities](https://doc.woleet.io/docs/verifying-identities.md)
- [How to create an identity in Woleet.ID Server](https://doc.woleet.io/docs/how-to-create-an-identity-in-woleetid-server.md)
- [Manager and admin profiles in Woleet.ID Server](https://doc.woleet.io/docs/user-profiles-in-woleetid-server.md)
- [Distinguishing e-signatures from e-seals](https://doc.woleet.io/docs/distinguishing-e-signatures-from-e-seals.md)
- [How to register a key with the Woleet signature service](https://doc.woleet.io/docs/add-external-key-to-woleetid-server.md)
- [Terms of Service](https://doc.woleet.io/docs/terms-of-service.md)
- [Signature and Seal Terms of Service](https://doc.woleet.io/docs/e-signature-terms-of-service.md)
- [Woleet Sign Terms of Service](https://doc.woleet.io/docs/woleet-sign-terms-of-service.md)
- [Acceptable Use Policy](https://doc.woleet.io/docs/acceptable-use-policy.md)
- [Cookies Policy](https://doc.woleet.io/docs/cookies-policy.md)
- [Privacy Policy](https://doc.woleet.io/docs/privacy-policy.md)
- [Support](https://doc.woleet.io/docs/support.md)
- [Legal Information](https://doc.woleet.io/docs/legal-information.md)

## API Reference
- [Purpose](https://doc.woleet.io/reference/purpose.md)
- [Creating proofs](https://doc.woleet.io/reference/creating-proofs.md)
- [About public and private anchors](https://doc.woleet.io/reference/about-public-and-private-anchors.md)
- [About credits](https://doc.woleet.io/reference/about-credits.md)
- [Verifying proofs](https://doc.woleet.io/reference/verifying-proofs.md)
- [About the verification process](https://doc.woleet.io/reference/about-the-verification-process.md)
- [Requesting signatures](https://doc.woleet.io/reference/requesting-signatures.md)
- [Signature request life cycle](https://doc.woleet.io/reference/signature-request-life-cycle.md)
- [Signature workflow customization](https://doc.woleet.io/reference/signature-workflow-customization.md)
- [Proof auditor customization](https://doc.woleet.io/reference/auditor-customization.md)
- [Configure file hosting services](https://doc.woleet.io/reference/configure-file-hosting-services.md)
- [Basics](https://doc.woleet.io/reference/basics.md)
- [Authentication](https://doc.woleet.io/reference/authentication.md)
- [Using domains](https://doc.woleet.io/reference/using-domains.md)
- [Using callback URLs](https://doc.woleet.io/reference/using-callbacks.md)
- [Rate limiter](https://doc.woleet.io/reference/rate-limiter.md)
- [Ask for signature](https://doc.woleet.io/reference/ask-for-signature.md)
- [Timestamp data](https://doc.woleet.io/reference/quick-timestamp.md)
- [Seal data](https://doc.woleet.io/reference/quick-seal.md)
- [Verify data](https://doc.woleet.io/reference/quick-verify.md)
- [Create a new anchor.](https://doc.woleet.io/reference/createanchor.md): 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.<br> 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.<br> For signature anchors, only the properties `name`, `signedHash`, `signature` and `pubKey` are required.<br> Be sure to have at least 1 timestamp credit (for a data anchor) or 1 seal credit (for a signature anchor).
- [Delete an anchor.](https://doc.woleet.io/reference/deleteanchor.md): Use this operation to delete an anchor.<br> **WARNING: You should never delete an anchor, otherwise you will no longer be able to download its proof receipt.<br> Use this for test purpose only.**
- [Get an anchor by its identifier.](https://doc.woleet.io/reference/getanchor.md): Use this operation to retrieve an anchor by its identifier.
- [Update an anchor.](https://doc.woleet.io/reference/updateanchor.md): Use this operation to update an anchor.<br> Only the properties `name`, `public`, `tags`, `metadata` and `callbackURL` can be modified.
- [Download the Proof Attestation document of an anchor.](https://doc.woleet.io/reference/getanchorattestation.md): Use this operation to retrieve the Proof Attestation document of an anchor.<br> This PDF file is only available once the anchor status is CONFIRMED.
- [Search for public anchor identifiers.](https://doc.woleet.io/reference/searchanchorids.md): Use this operation to retrieve the identifiers of all public anchors having a given `hash` and/or `signedHash` property.<br> Only public anchor identifiers are returned.<br> This is a publicly accessible endpoint: authentication is not required to retrieve public anchor identifiers.<br> Paging is supported.
- [Search for anchors.](https://doc.woleet.io/reference/searchanchors.md): Use this operation to retrieve all anchors having a given `name`, `hash`, `signedHash` and/or `tags` property.<br> Only anchors belonging to the authenticated user are returned.<br> Paging and sorting is supported.
- [Get the proof receipt of an anchor.](https://doc.woleet.io/reference/getreceipt.md): Use this operation to retrieve the proof receipt associated to a given anchor.<br> This JSON file is only available once the anchor status is SENT.<br> This is a publicly accessible endpoint: authentication is not required to retrieve a proof receipt (but the anchor identifier needs to be known).
- [Get the proof receipt of an anchor (OpenTimestamps proof format).](https://doc.woleet.io/reference/getotsreceipt.md): Use this operation to retrieve the OpenTimestamps proof receipt associated to a given data anchor (note that this operation is NOT available for signature anchors).<br> This binary file is only available once the anchor status is SENT.<br> This is a publicly accessible endpoint: authentication is not required to retrieve a proof receipt (but the anchor identifier needs to be known).
- [Verify a proof receipt.](https://doc.woleet.io/reference/verifyreceipt.md): Use this operation to verify a proof receipt and get the timestamp of the proof.<br> For a proof of seal/signature receipt, this operation also verifies the signature.<br> If the proof of seal/signature receipt includes an identity URL, this operation also verifies the identity of the signer.<br> This is a publicly accessible endpoint: authentication is not required to verify a proof receipt.
- [Create a new signature request.](https://doc.woleet.io/reference/createsignaturerequest.md): Use this operation to create a new signature request.<br> The properties `id`, `created` and `lastModified` are read-only and so must not be provided: they are managed by the platform and added to the returned request.<br> Only the properties `name` and `hashToSign` are required: the `hashToSign` property must be the SHA256 hash of the file to sign.<br> Be sure to have at least 1 signature request credit, plus enough signature and SMS credits to fulfill the signature request.<br>
- [Change the state of a signature request.](https://doc.woleet.io/reference/transitionsignaturerequest.md): Use this operation to transition a **stateful** signature request to a new state.<br> Possible transitions are: - from DRAFT to PENDING: start the signature request: the platform waits for the activation date (only if set) and transitions the signature request to IN_PROGRESS automatically - from PENDING to DRAFT: suspend the signature request so that it can be updated - from PENDING to CANCELED: cancel the signature request without waiting for the activation date - from IN_PROGRESS to CLOSED: close the signature request before all signatures get collected - from IN_PROGRESS to CANCELED: cancel the signature request before all signatures get collected  Note that **stateless** signature requests can only be transitioned to CLOSED or CANCELED, which triggers the generation of the audit trail and its signature by the platform.
- [Send a reminder email to a set of signers of a signature request.](https://doc.woleet.io/reference/sendsignaturerequestreminder.md): Use this operation to send a reminder email to a set of signers of a signature request.<br> This email reminds them that they have a document to sign.
- [Generate and send an OTP to a signer of a signature request.](https://doc.woleet.io/reference/sendsignaturerequestotp.md): Use this operation to generate and send a new OTP (One Time Password) by SMS to a signer of a signature request.<br> This OTP can be used to sign during a maximum period of 10 mn.
- [Sign a signature request by registering a signature.](https://doc.woleet.io/reference/signsignaturerequest.md): A signer can use this operation to sign a signature request by registering a signature he produced on his own.<br> The signature is automatically anchored on behalf of the owner of the signature request.<br> The signature anchor created is added to the list of signature anchors of the signature request.<br> This is a publicly accessible endpoint: authentication is not required to register a signature (authentication of the signer rely on the knowledge of his secret identifier and OTP, or on the control of his public key).
- [Sign a signature request by delegating the signature.](https://doc.woleet.io/reference/delegatesignsignaturerequest.md): A signer can use this operation to sign a signature request by delegating the signature to the platform.<br> When using this signature mode, the signature key of the signer is controlled by the platform, which acts as a trusted third party.<br> The signature is automatically anchored on behalf of the owner of the signature request.<br> The signature anchor created is added to the list of signature anchors of the signature request.<br> This is a publicly accessible endpoint: authentication is not required to delegate a signature (authentication of the signer rely on the knowledge of his secret identifier and OTP).
- [Report a feedback about a signature request.](https://doc.woleet.io/reference/reportsignaturerequestfeedback.md): A signer can use this operation to report a feedback to the owner of a signature request.<br> This is a publicly accessible endpoint: authentication is not required to report a feedback (authentication of the signer rely on the knowledge of his secret identifier).
- [Report an event on a signature request.](https://doc.woleet.io/reference/reportsignaturerequestevent.md): A signer can use this operation to report an event on a signature request.<br> Events reported are included in the audit trail of the signature request.<br> This is a publicly accessible endpoint: authentication is not required to report an event (authentication of the signer rely on the knowledge of his secret identifier).
- [Download the Signature Attestation document of a signature request.](https://doc.woleet.io/reference/getsignaturerequestattestation.md): Use this operation to retrieve the Signature Attestation document of a signature request.<br> This PDF file summarizes the signature request and includes the proof bundle as an attachment.<br> The proof bundle is a JSON file containing all the pieces of evidence: - the audit trail - the proof receipt of the signature of the audit trail by the platform - the proof receipts of the signature of the file by the signers  Consequently, the signature attestation is only available once all the following conditions are met: - the signature request is COMPLETED (by the platform) or CLOSED (by the requester) - all the proof receipts are available (ie. all signatures have been anchored) - the audit trail is generated and signed by the platform and its proof receipt is available (ie. its signature has been anchored)  Once these conditions are met, the platform sets the `proofBundleComplete` property to `true`.<br> This is a publicly accessible endpoint: authentication is not required to retrieve the signature attestation of a signature request (but its identifier needs to be known).
- [Get the proof bundle of a signature request.](https://doc.woleet.io/reference/getsignaturerequestproofbundle.md): Use this operation to retrieve the proof bundle of a signature request.<br> The proof bundle is a JSON file containing all the pieces of evidence: - the audit trail - the proof receipt of the signature of the audit trail by the platform - the proof receipts of the signature of the file by the signers  Consequently, the proof bundle is only available once all the following conditions are met: - the signature request is COMPLETED (by the platform) or CLOSED (by the requester) - all the proof receipts are available (ie. all signatures have been anchored) - the audit trail is generated and signed by the platform and its proof receipt is available (ie. its signature has been anchored)  Once these conditions are met, the platform sets the `proofBundleComplete` property to `true`.<br> If this endpoint is called before all these conditions are met, it returns only the available proof receipts (with a 202 status).<br> This is a publicly accessible endpoint: authentication is not required to retrieve the proof bundle of a signature request (but its identifier needs to be known).
- [Download the file to sign.](https://doc.woleet.io/reference/downloadsignaturerequestfile.md): Use this operation to download the file to be signed for a signature request.<br> If the signature request is CLOSED or COMPLETED and the signed file is a PDF document that was uploaded to Woleet, this operation can also be used to download the amended document: this document is basically the signed file concatenated with the Signature Attestation document. The amended document contains the proof bundle as attachment, and is certified by Woleet.<br> The name of the file is included in the `Content-Disposition` header (see https://www.ietf.org/rfc/rfc6266.txt).<br> This is a publicly accessible endpoint: authentication is not required to download the file to be signed for a signature request (but its identifier needs to be known).
- [Upload the file to sign.](https://doc.woleet.io/reference/uploadsignaturerequestfile.md): Use this operation to upload the file to be signed for a signature request.<br> The SHA256 hash of the uploaded file must be equal to the `hashToSign` property of the signature request or the upload fails.<br> Once uploaded, the file is stored and the `fileURL` property of the signature request is set, so that it can be used by a signature application to download and present the file to the signers.<br> Only **stateless** signature requests or **stateful** signature request in DRAFT state can be updated. **WARNING: the storage of the file to be signed is provided for convenience only: it is not required, and you should never upload a file if you have any concern about its privacy.**
- [Extend the deadline of a signature deadline.](https://doc.woleet.io/reference/extendsignaturerequestdeadline.md): Use this operation to extend the deadline of a signature request.<br> Only **stateless** signature requests or **stateful** signature request in IN_PROGRESS state can be updated.<br> The new deadline cannot be earlier than the original deadline.<br>
- [Delete a signature request.](https://doc.woleet.io/reference/deletesignaturerequest.md): Use this operation to delete a signature request.<br> **WARNING: You should never delete a signature request, otherwise you will no longer be able to download its proof bundle or Signature Attestation document.<br> Use this for test purpose only.**
- [Get a signature request by its identifier.](https://doc.woleet.io/reference/getsignaturerequest.md): Use this operation to retrieve a signature request by its identifier.<br> This is a publicly accessible endpoint: authentication is not required to retrieve a signature request (but its identifier needs to be known).<br> Nevertheless, if the caller is authenticated as the owner of the signature request, additional information is returned.
- [Update a signature request.](https://doc.woleet.io/reference/updatesignaturerequest.md): Use this operation to update a signature request.<br> Only the properties `name`, `public`, `callbackURL`, `activation`, `deadline`, `identityURL`, `fileName`, `fileURL`, `lang`, `vars`, `maxSignatures` and `authorizedSignees` can be modified.<br> Only **stateless** signature requests or **stateful** signature request in DRAFT state can be updated.
- [Search for public signature request identifiers.](https://doc.woleet.io/reference/searchsignaturerequestids.md): Use this operation to retrieve the identifiers of all public signature requests having a given `hashToSign` property.<br> Only public signature request identifiers are returned.<br> This is a publicly accessible endpoint: authentication is not required to retrieve public signature request identifiers.<br> Paging is supported.
- [Search for signature requests.](https://doc.woleet.io/reference/searchsignaturerequests.md): Use this operation to retrieve all signature requests having a given `name` and/or `hashToSign` property.<br> Only requests belonging to the authenticated user are returned.<br> Paging and sorting is supported.
- [Revoke a JWT token.](https://doc.woleet.io/reference/revoketoken.md): Use this operation to revoke a JWT token.<br> JWT tokens have no expiration date so are always valid: if you need to invalidate a token (eg. because you think it is compromised) you need to use this endpoint to inform the platform that this token must no longer be accepted.
- [Generate a JWT token.](https://doc.woleet.io/reference/generatetoken.md): Use this operation to generate a new JWT token.<br> JWT tokens can be used to authenticate to the API, using the `Bearer` scheme of the `Authorization` header, like:<br> `Authorization: Bearer {JWT token}`
- [Get user's credits.](https://doc.woleet.io/reference/getcredits.md): Use this operation to get the remaining credits of the authenticated user.
- [Get user's registered JWT tokens.](https://doc.woleet.io/reference/gettokens.md): Use this operation to list all JWT tokens registered for the authenticated user.
- [Update user's registered JWT tokens.](https://doc.woleet.io/reference/puttokens.md): Use this operation to update the list of JWT tokens registered for the authenticated user.
- [Get the current callback secret (null if not set).](https://doc.woleet.io/reference/getcallbacksecret.md): Use this operation to get the API callback secret.
- [Generates a new callback secret.](https://doc.woleet.io/reference/updatecallbacksecret.md): Use this operation to generate the API callback secret.

## Changelog
- [Woleet 1.15.0 release note](https://doc.woleet.io/changelog/woleet-1150-release-note.md)
- [Woleet 1.14.0 release note](https://doc.woleet.io/changelog/woleet-1140-release-note.md)
- [Woleet 1.13.0 release note](https://doc.woleet.io/changelog/woleet-1130-release-note.md)
- [Woleet 1.12.0 release note](https://doc.woleet.io/changelog/woleet-1120-release-note.md)
- [Woleet 1.11.1 release note](https://doc.woleet.io/changelog/woleet-1111-release-note.md)