get-document

POST

/public/envelope/get-document

• Enclave API server

Download the latest version of a document from an envelope.

Request Body ^required

object

workspaceUuid

Optional. When omitted, the team’s default workspace is used.

string

>= 36 characters <= 36 characters

envelopeUuid

required

The UUID of the envelope to get the document from.

string

>= 36 characters <= 36 characters

documentUuid

required

The UUID of the document to download.

string

>= 36 characters <= 36 characters

Responses

200

Default Response

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND ENVELOPE_NOT_FOUND DOCUMENT_NOT_FOUND DOCUMENT_REVISION_NOT_FOUND DOCUMENT_CORRUPTED 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

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

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

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

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

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

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

details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object

path

required

JSON path to the invalid field

Array<string>

message

required

Validation error message for this field

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