Create and Publish Envelope

Creates an envelope with its signers and files and publishes it in one request, so invitations go out right away. Files are base64-encoded PDF or Word (.pdf, .docx) files. The whole request body may be at most 50 MB, so the base64 files can total about three quarters of that; for larger files use Upload Content. To build an envelope step by step or upload files as multipart, use Create Envelope, Create Signer, Upload Content and Publish Envelope instead. If validation fails, nothing is created; if a later step fails, the created envelope is deleted. Like Publish Envelope, it counts toward the team's e-sign usage and can fail with 402 on a free plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to false

When true, validates the request without creating or sending anything, and a valid request returns 200 with {}. Team rules (SMS verification, blocked publishing) are checked like a real publish. File contents (for example encrypted or already signed PDFs) and the free-plan e-sign limit are not checked, so a real request can still fail on those.

Allowed:
Body Params

Create and Publish Envelope

Envelope settings, signers and files to create and publish in one request.

envelope
object

Envelope settings.

signers
array of objects
required
length ≥ 1

The signers of the envelope, invited in signing order (signingGroup).

signers*

A signer to add to the envelope.

string
required

Full name of the signer.

string

Email address of the signer. Required when inviteMethod is EMAIL (the default).

string

Personal identity number, validated against country. Send it to lock BankID and Freja signing to this person. When omitted, anyone with the signing link and a Swedish BankID can sign with BankID, and Freja asks the signer to enter their SSN.

string

Mobile number with country code, for example +46701234567. Required when inviteMethod is SMS or signingMethods includes SMS. SMS needs a verified team (contact [email protected]).

integer
Defaults to 0

Signing order. Signers in the lowest group are invited first; the next group is invited when everyone in the current group has signed. Signers in the same group sign in parallel.

signingMethods
array of strings
Defaults to BANKID

Signing methods the signer can use: BANKID (Swedish BankID, country SE only), FREJA (Freja eID, countries SE, DK, NO, FI), SMS (needs phone and a verified team), BASIC (simple electronic signature, SES).

signingMethods
Allowed:
string
enum
Defaults to EMAIL

How the signer is invited: EMAIL sends an email (needs email), SMS sends an SMS (needs phone and a verified team), ONSPOT sends nothing and you open the signer's publicSigningUrl yourself, for example in your own app. ONSPOT signers cannot be reminded.

Allowed:
string
Defaults to SE

ISO 3166-1 alpha-2 country code of the signer, for example SE. Decides which signing methods are allowed and how phone and ssn are validated.

metadata
object

Your own key/value data, such as an ID from your system. Returned unchanged on the participant and in webhook payloads. At most 4096 characters as JSON.

files
array of objects
required
length ≥ 1

The documents to sign: PDF or Word (.pdf, .docx) files, base64-encoded.

files*
string
required

The file content as standard base64 on a single line, without line breaks or a data: prefix.

string
required

Name of the file, for example agreement.pdf.

string | null

A JSON object as a string, for example {"customerName":"Jane Doe"}. Its values fill the template fields of a Word (.docx) file. Sending it with a PDF returns 400 FILE_TEMPLATE_DATA_REQUIRES_WORD. The filled document is converted to PDF when the envelope is published. Template syntax: https://docs.apryse.com/core/guides/generate-via-template/data-model/#general-principles

options
object

Publishing options.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json