Skip to main content
POST
Create a signature request

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Body

application/json
name
string
required

Document / submission name.

Maximum string length: 200
Example:

"Order confirmation"

fields
object[]
required

Fields to place on the document. Areas use normalized (0–1) coordinates with a top-left origin and 1-indexed pages — the same model as DocuSeal.

Minimum array length: 1
signers
object[]
required

One to ten signers. Array order determines the sequence when signingOrder is sequential.

Required array length: 1 - 10 elements
whatsappPhoneNumberId
string

Registered WhatsApp sender phone ID

signingOrder
enum<string>
default:parallel

Sequential invites signers in array order, after the previous signer completes.

Available options:
parallel,
sequential
file
string

The source PDF, base64-encoded (max 20 MB decoded). Send exactly one of file and files.

Example:

"JVBERi0xLjcKJ..."

files
string[]

Several source PDFs, base64-encoded, signed as one document in this order: page 1 of the second PDF follows the last page of the first. Together at most 20 MB and 200 pages. Send exactly one of file and files.

Required array length: 1 - 10 elements
expiresAt
string

ISO-8601 timestamp after which signing links stop working.

Example:

"2026-12-31T23:59:59.000Z"

language
enum<string>

Language for signing, notifications and the signature record.

Available options:
en,
de,
fr,
es,
no,
nl,
it,
pl,
se,
tr,
da,
pt,
ru,
uk
Example:

"de"

completedRedirectUrl
string<uri>

URL the signer is sent to after completing (DocuSeal completed_redirect_url).

Example:

"https://app.example.com/contracts/123/signed"

requireOtp
boolean

Require email OTP verification. This expresses the FES intent and requires the Suite plan or above. When omitted, the company default applies (off unless an admin turned it on). Every signer then needs an email address.

Example:

true

otpChannel
enum<string>
default:email

Where the one-time code goes when requireOtp is on. sms sends it to each signer's phone, so every signer then needs a mobile number, and the audit trail records the confirmed mobile number instead of the email address.

Available options:
email,
sms
Example:

"sms"

emailTexts
object

This request's own email wording. Omitted kinds use the company's standard text. Applies to email delivery only; SMS and WhatsApp keep their fixed text.

sendSignedCopyToSigners
boolean

Email every signer the finished document when the request completes. Defaults to true. Set false when you distribute the signed document yourself.

Example:

true

sendCopyToRequester
boolean

Email the finished document to the user sending the request (the API key's acting user) once everyone has signed. Left out, the company's e-signature setting decides.

Example:

true

automaticReminders
boolean

Send unfinished signers a reminder every three days, up to three reminders.

Example:

true

whatsappTemplateName
string

Approved WhatsApp template name used by signers whose delivery channel is WhatsApp.

Maximum string length: 200
Example:

"signature_invitation"

whatsappTemplateLanguage
string

Language code of the selected WhatsApp template.

Maximum string length: 35
Example:

"de"

Response

Signature request created with its signer links.

signingOrder
enum<string>
required
Available options:
parallel,
sequential
activeSignerIds
string[]
required

Signers whose turn is currently open.

id
string
required

Signature request id.

name
string
required

Document name.

schemaVersion
number
required

Persisted envelope schema version.

revision
number
required

Current request revision.

status
enum<string>
required

Overall status.

Available options:
pending,
in_progress,
finalizing,
finalization_failed,
completed,
cancelled
signers
object[]
required

The signers and their signing links.

automaticReminders
boolean
required

Whether automatic reminders are enabled.

createdAt
string<date-time>
required

Creation time.

signedDocumentUrl
string | null

Time-limited download URL for the signed (audit-paged, cryptographically signed) PDF. Present once status is "completed".

completedAt
string<date-time> | null

When all signers completed.

expiresAt
string<date-time> | null

When signing links expire (null = never).