API Reference

Create and Publish Envelope

post
https://api.resly.se/v2/envelopes/create-and-publish

Use this URI to create, validate and publish an envelope in a single request.

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

Validates sent data without creating and publishing an envelope. In very specific rare cases, envelope creation can still fail even if data validates correctly. Success if server responds with 200; the response body is then an empty object instead of an envelope.

Allowed:
Body Params

Create and Publish Envelope

The create and publish envelope input object.

envelope
object

The envelope input object.

signers
array of objects
required
length ≥ 1

The signers of the envelope.

signers*

The participant input object.

string
required

Participant name.

string

Participant email.

string

If empty, let's signee specify their own SSN before signing for Bank ID and Freja eID signing methods.

string

Phone number including country code that invite will be sent to. Required if inviteMethod or signingMethod is set to SMS.

integer
Defaults to 0

Signing group of the participant.

signingMethods
array of strings
Defaults to BANKID

Participant allowed signing methods.

signingMethods
Allowed:
string
enum
Defaults to EMAIL

Participant invite method.

Allowed:
string
Defaults to SE

ISO Alpha-2 country code.

metadata
object

This metadata field is a versatile storage option that allows you to save any string-based information related to an object, with a substantial limit of up to 4096 characters.

files
array of objects
required
length ≥ 1

The documents of the envelope.

files*
string
required

Base64-encoded file.

string
required

Name of the file.

string | null

Stringified JSON-object that will replace template literals when sent together with .doc or .docx document. Filled document will be converted into PDF. Information about templating language can be found here https://docs.apryse.com/core/guides/generate-via-template/data-model/#general-principles

options
object

Additional options for the request.

Responses

Updated 3 days ago

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

Updated 3 days ago

Did this page help you?