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"

file
string
required

The source PDF, base64-encoded (max 20 MB decoded).

Example:

"JVBERi0xLjcKJ..."

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 parallel signers.

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>

Signing-page language. Supported: "en", "de". Defaults to English.

Available options:
en,
de
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.

Example:

true

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

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.

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).