Create Envelope

post https://api.resly.se/v1/envelopes

Use this URI to create a new envelope object.

Body Params

name

string

Name of the envelope.

autoSendOut

boolean

Defaults to true

Sends out email to signees with link to download sealed documents when envelope is sealed.

globalMessage

string

Message to the signees. Included in invite to sign email and on the signing webpage.

autoReminderInterval

number

Defaults to 0

Number of days between automatic reminder. Value of 0 results in no automatic reminder.

archiveData

object

responsibleUserEmail

string

Responsible user. Currently, apikey owner is always the responsible user and this will always be the default behavior. If the email matches an existing user, that user will be the responsible user. If the email does not match an existing user, the default apikey owner will be the responsible user.

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.

Responses

Response body

object

string

Uniqe id of the envelope.

name

string

Name of the envelope.

status

string

Status of the envelope. Most common are NEW, PENDING and DONE.

responsibleUserId

string

The user id of the responsible for the envelope.

autoSendOut

boolean

Sends out email to signees with link to download sealed documents when envelope is sealed.

globalMessage

string

Message to the signees. Included in invite to sign email and on the signing webpage.

autoReminderInterval

number | null

Number of days between automatic reminder. Value of 0 results in no automatic reminder.

1 2 3 4 5 6 7 10 14

signees

array of objects

signees

object

string

Signee ID.

name

string

Signee name.

string | null

Signee email.

invited

boolean

Tells if signee is invited.

signed

boolean

Tells if signee has signed its documents.

hasViewed

boolean

Tells if signee has opened the signing webpage.

signingMethod

string

Signee signing method.

BANKID FREJAID SMS SIMPLE

country

string

Signee country of origin. Used for validating signing method, phone number and SSN.

unknownSsn

boolean

Tells if signee is allowed to specify its own SSN when signing using BankID or Freja eID. True if was not specified, false otherwise.

ssn

string | null

Signee SSN.

phone

string | null

Signee phone number.

signingOrder

number | null

Signee signing order.

signedAt

date-time | null

Time at which signee signed the documents.

invitedAt

date-time | null

Time at which invite email or sms went out.

remindedAt

date-time | null

Time at which signee was reminded using email or sms.

inviteMethod

string

Signee invite method.

EMAIL SMS ONSPOT

deliveryStatus

string | null

Delivery status of the invite email. Only available for EMAIL invite method.

publicSigningUrl

string | null

Unique URL of webpage where signee will sign its documents. "successRedirectUrl" query param can manually be added to this URL before redirecting user. Value needs to be URL-encoded. See "Advanced use cases" for more information.

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.

Has additional fields

files

array of objects

files

object

fileId

string

File ID.

filename

string

File filename.

originalname

string

File original filename.

mimetype

string

File mimetype.

sealed

boolean

Tells if file is sealed.

archiveData

object

active

boolean | null

Determines if envelope will be handled by agreement archive.

validFrom

date-time | null

validTo

date-time | null

notes

string | null

Versatile notes field.

remindAtDaysBefore

array of numbers | null

remindAtDaysBefore

createdBy

string

User id that originally created the envelope object.

createdAt

date-time

The time the envelope object was created.

updatedAt

date-time

The time the envelope object was updated.

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.

Has additional fields

200OK. Expand for details.

400Bad Request. Expand for details.

401Unauthorized. Expand for details.

500Please contact support at support@resly.se or call +46372-21111.