Skip to main content
POST
Create a signature request

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Body

application/json

Provide fileId. documentId is a deprecated alias still accepted for backwards compatibility; supply exactly one.

fileId
string<uuid>

The ID of the file to create the signature request for.

documentId
string<uuid>
deprecated

Deprecated — use fileId. Accepted for backwards compatibility.

Response

Signature request created successfully.

id
string<uuid>
required

Unique identifier for the signature request.

createdOn
string<date-time>
required

Timestamp when the signature request was created.

file
object
required
completedOn
string<date-time>

Timestamp when the signature request was completed.

signedBy
string

The user ID that signed the document.

Minimum string length: 1
notarizedBy
string

The user ID that notarized the document.

Minimum string length: 1
completedFileUrl
string

A URL where the completed file can be downloaded from.

Minimum string length: 1
document
object
deprecated

Deprecated — use file. Retained for backwards compatibility.