Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Use envelope

POST
/envelope/use
curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/use \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'payload={ "envelopeId": "example", "externalId": "example", "recipients": [ { "id": 1, "email": "", "name": "example", "signingOrder": 1 } ], "distributeDocument": true, "customDocumentData": [ { "identifier": "example", "envelopeItemId": "example" } ], "folderId": "example", "prefillFields": [ { "id": 1, "type": "text", "label": "example", "placeholder": "example", "value": "example" } ], "override": { "title": "example", "subject": "example", "message": "example", "timezone": "example", "dateFormat": "yyyy-MM-dd hh:mm a", "redirectUrl": "example", "distributionMethod": "EMAIL", "emailSettings": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true }, "language": "de", "typedSignatureEnabled": true, "uploadSignatureEnabled": true, "drawSignatureEnabled": true, "allowDictateNextSigner": true, "envelopeExpirationPeriod": { "unit": "day", "amount": 1 } }, "attachments": [ { "label": "example", "data": "https://example.com", "type": "link" } ], "formValues": { "additionalProperty": "example" } }' \
  --form files=example

Create a document envelope from a template envelope. Upload custom files to replace the template PDFs and map them to specific envelope items using identifiers.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typemultipart/form-data
object
payload
required
object
envelopeId
required
string
externalId
string
recipients
Array<object>
object
id
required
number
email
required
Any of:
string
Allowed values: ""
name
string
<= 255 characters
signingOrder
number
distributeDocument
boolean
customDocumentData
Array<object>
object
identifier
required
Any of:
string
envelopeItemId
required
string
folderId
string
prefillFields
Array
object
id
required
number
One of:
object
type
required
string
Allowed values: text
label
string
placeholder
string
value
string
override
object
title
string
>= 1 characters <= 255 characters
subject
string
<= 254 characters
message
string
<= 5000 characters
timezone
string
dateFormat
string
Allowed values: yyyy-MM-dd hh:mm a yyyy-MM-dd dd/MM/yyyy dd-MM-yyyy MM/dd/yyyy yy-MM-dd MMMM dd, yyyy EEEE, MMMM dd, yyyy dd/MM/yyyy hh:mm a dd/MM/yyyy HH:mm dd-MM-yyyy hh:mm a dd-MM-yyyy HH:mm MM/dd/yyyy hh:mm a MM/dd/yyyy HH:mm dd.MM.yyyy dd.MM.yyyy HH:mm yyyy-MM-dd HH:mm yy-MM-dd hh:mm a yy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss MMMM dd, yyyy hh:mm a MMMM dd, yyyy HH:mm EEEE, MMMM dd, yyyy hh:mm a EEEE, MMMM dd, yyyy HH:mm yyyy-MM-dd'T'HH:mm:ss.SSSXXX
redirectUrl
string
distributionMethod
string
Allowed values: EMAIL NONE
emailSettings
object
recipientSigningRequest
boolean
default: true
recipientRemoved
boolean
default: true
recipientSigned
boolean
default: true
documentPending
boolean
default: true
documentCompleted
boolean
default: true
documentDeleted
boolean
default: true
ownerDocumentCompleted
boolean
default: true
ownerRecipientExpired
boolean
default: true
ownerDocumentCreated
boolean
default: true
language
string
Allowed values: de en fr es it nl pl pt-BR ja ko zh
typedSignatureEnabled
boolean
uploadSignatureEnabled
boolean
drawSignatureEnabled
boolean
allowDictateNextSigner
boolean
envelopeExpirationPeriod
Any of:
object
unit
required
string
Allowed values: day week month year
amount
required
integer
>= 1
attachments
Array<object>
object
label
required
string
>= 1 characters
data
required
string format: uri
type
string
default: link
Allowed values: link
formValues
object
key
additional properties
Any of:
string
files
Array<string>

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
id
required
string
recipients
required
Array<object>
object
id
required
number
name
required
string
email
required
string
token
required
string
role
required
string
Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT
signingOrder
required
number | null
signingUrl
required
string
Example
{
  "recipients": [
    {
      "role": "CC"
    }
  ]
}

400

Section titled “400”

Invalid input data

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Section titled “401”

Authorization not provided

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Section titled “403”

Insufficient access

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}