create

POST

/public/envelope/create

• Enclave API server

Create an envelope and the first document placeholder, returning pre-signed S3 parameters for document upload.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace to create the envelope in.

string

>= 36 characters <= 36 characters

envelopeTitle

required

The title of the envelope being created.

string

<= 255 characters

Responses

200

Default Response

object

envelopeUuid

required

The unique identifier of the created envelope.

string

documentUuid

required

The unique identifier of the first document.

string

presignedS3Params

required

Pre-signed S3 parameters for document upload.

object

url

required

The pre-signed S3 URL for uploading the document.

string

fields

required

Fields required for the S3 upload.

object

bucket

required

The S3 bucket name.

string

key

required

The S3 key.

string

content-type

required

The S3 content type.

string

x-amz-algorithm

required

The S3 algorithm.

string

x-amz-credential

required

The S3 credential.

string

x-amz-date

required

The S3 date.

string

policy

required

The S3 policy.

string

x-amz-signature

required

The S3 signature.

string

revisionEncryptionKey

required

The encryption key in base64 for the document revision to be used for encryption.

string

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_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 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