Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

documentId
string<guid>
required

The target document's unique identifier A document's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

packageId
string<guid>
required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Body

application/json

Actions to be performed on Draft document with IsActionNeeded flag

Document actions to be performed on Draft document with IsActionNeeded flag set to true.

KeepSignatures
boolean
default:false

When true, existing signatures detected in the document are applied to the document file. Default is false. Cannot be true at the same time as KeepFormFields.

KeepSigningFields
boolean
default:false

When true, detected signing field markers are converted to actual signing fields. Default is false.

KeepFormFields
boolean
default:false

When true, detected form field markers are converted to actual form fields. Default is false. Cannot be true at the same time as KeepSignatures.

Response

Document is in Draft status, no action required