POST
/
signature-request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

input
object
required

Input to create a signature request.

Body

application/json
input
object
required

Input to create a signature request.

Response

200 - application/json

A signature request is an entity that represents a piece of data that needs to be signed by a user.

anonymousKey
string
required

Key for sharing the sharing the signature request. Can be used to access the signature request without authentication.

content
object
required

The content data to be signed.

createdAt
any
required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

draft
boolean
required

Whether the document is a draft or not. A draft signature request won't allow invites to sign and will skip processing notifications.

finalized
boolean
required

Whether the document is finalized or not. A finalized request won't allow new invites and won't process any new notifications.

id
any
required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

invites
object[]
required

Invites to sign the content.

name
string
required

Custom name for the signature request.

organization
object
required

The organization requesting the signature.

pending
any
required

Amount of invites that have not signed the content.

rejected
any
required

Amount of invites that have rejected the content.

signed
any
required

Amount of invites that have signed the content.

updatedAt
any
required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

witness
object
required

Witness that attest the content using a merkle proof

rejectedAt
any

Date when the signature request was rejected. Only present if rejected.