Skip to content
Subnoto Logo Subnoto Documentation

Sign Envelope

POST
/public/envelope/sign
 
curl --request POST \
  --url https://enclave.subnoto.com/public/envelope/sign \
  --header 'Content-Type: application/json' \
  --data '{ "workspaceUuid": "example", "envelopeUuid": "example", "recipientEmail": "[email protected]", "signatureImage": "example", "inputValues": { "additionalProperty": "example" } }'

Sign a document in an envelope as a recipient.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
workspaceUuid

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

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. Must match the API key owner’s email.

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
inputValues

Input block values keyed by block uuid.

object
key
additional properties
Any of:
string
Example generated
{
  "workspaceUuid": "example",
  "envelopeUuid": "example",
  "recipientEmail": "[email protected]",
  "signatureImage": "example",
  "inputValues": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
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
Example generated
{
  "success": true,
  "documentUuid": "example",
  "revisionVersion": 1
}

400

Section titled “400 ”

Default Response

Media type application/json
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 RECIPIENT_EMAIL_MISMATCH INVALID_REQUEST 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
Example 
{
  "error": {
    "code": "WORKSPACE_NOT_FOUND"
  }
}

401

Section titled “401 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "AUTHENTICATION_ERROR"
  }
}

403

Section titled “403 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "AUTHORIZATION_ERROR"
  }
}

500

Section titled “500 ”

Default Response

Media type application/json
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
Example 
{
  "error": {
    "code": "INTERNAL_SERVER_ERROR"
  }
}