sign

POST

/public/envelope/sign

• Enclave API server

Sign a document in an envelope as a recipient.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace containing the envelope.

string

>= 36 characters <= 36 characters

envelopeUuid

required

The UUID of the envelope containing the document to sign.

string

recipientEmail

required

The email of the recipient who is signing.

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

signatureImage

Base64 encoded signature image to be merged with the watermark.

string

<= 2000000 characters

Responses

200

Default Response

object

success

required

Whether the document was successfully signed.

boolean

documentUuid

required

The UUID of the signed document.

string

>= 36 characters <= 36 characters

revisionVersion

required

The version number of the signed document revision.

number

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND INVALID_TOKEN ENVELOPE_INVITATION_EXPIRED ENVELOPE_INVITATION_NOT_PENDING ENVELOPE_NOT_FOUND DOCUMENT_NOT_FOUND DOCUMENT_REVISION_NOT_FOUND ENVELOPE_ALREADY_SIGNED INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string