Create a new signature request.

post

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

Use this operation to create a new signature request.

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.

Only the properties name and hashToSign are required: the hashToSign property must be the SHA256 hash of the data to sign. This allows not to leak the original data and to keep the actual signed data small (signing the digest is equivalent to signing the original data).

Be sure to have enough signature and anchoring credits on your account to fulfill the signature request (each registered signature will cost you 1 signature and 1 anchoring credit).

Body Params

SignatureRequest object to create.

name

string

required

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

public

boolean

true (or unset) if the signature anchors created in the scope of this signature request must be public (ie. discoverable by their signedHash).

false if they must be private (ie. not dicoverable).

If this field is not set at creation time, all anchors created will be public by default.

suspended

boolean

true if the signature request is suspended, or false (or unset) if not.

When suspended, no signature can be registered.

hashToSign

string

required

SHA256 hash (ie. the fingerprint) of the original data to sign.
The value must be provided as an hexadecimal lowercase string.

deadline

int64

Deadline of the signature request (in milliseconds since Unix epoch).

When not set, null or 0, no deadline is applied.

If set, signatures registered after the deadline are refused.

identityURL

string

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

If set, it is used to verify the identity of signees at signature registration time.

maxSignatures

int32

Maximum number of signatures to accept for this signature request.

When not set, null or 0, no maximum is applied.

This property and the authorizedSignees property are mutually exclusive.

This property is only available to the owner of the signature request.

authorizedSignees

array of objects

List of all signees authorized to register their signature for this signature request (no duplicate is authorized).

When not set or null, anybody can sign the signature request.

If set, signatures registered by signees not in this list are rejected.

This property and the maxSignatures property are mutually exclusive.

This property is only available to the owner of the signature request.

authorizedSignees

anchors

array of objects

List of signature anchors created in the scope of this signature request

A signature anchor is created each time a new signature is registered.

This property is only available to the owner of the signature request.

anchors

Responses

400

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

200The created signature request.