Create Signer

post

https://api.resly.se/v2/envelopes/{envelopeId}/participants/signers

Adds a signer to an envelope and returns it. Choose how the signer is invited (inviteMethod), how they sign (signingMethods) and their place in the signing order (signingGroup). Send ssn to lock BankID and Freja signing to that person. On a draft envelope nothing is sent until you publish. On a published envelope, add the signer to an existing group that has not finished signing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

envelopeId

string

required

ID of the envelope.

Body Params

Create Signer

A signer to add to the envelope.

name

string

required

Full name of the signer.

string

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

ssn

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.

phone

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

signingGroup

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:

inviteMethod

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:

country

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.

200Success.

400Invalid request. See code and errors.

401Missing or invalid API key.

403The API key is not allowed to perform this operation.

404Not found.

500Unexpected server error.