API Reference

Use this URI to add a signee on envelope object.

Log in to see full request history
Path Params
string
required

id of the envelope

Body Params
string
required

Name of the signee.

string

Email where invite will be sent. Required if inviteMethod is set to EMAIL.

string
Defaults to BANKID

Signing method.

string
Defaults to SE

ISO Alpha-2 country code.

string | null

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

string | null

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

number | null
0 to 255
string
Defaults to EMAIL

Method which is used for notifying signe about documents that need signing. Value of ONSPOT skips email sendout. See "Advanced use cases" for more info.

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

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