Signer

The model used when changing signer information:

ChangeEmailModel
Name Type Description Optional
OrderId Guid Order id.
OldEmail String Old e-mail address of signer.
Email String New e-mail address.
SignerReference String Signer Reference. If not set, will change email on the first signer matching OldEmail. yes


SignerModel
Name Type Description Optional
Name String Name of signer.
Email String E-mail of signer.
Identification String Identification of signer. This can be Social Security Number (DK, NO or SE) or Company Registration Number (DK). yes
ApproverId Int ApproverId. Is this filled, that means the signer is an approver. yes
CustomData String Custom data associated with this signer. This will be played back in status call. String will be truncated after 1024 characters. yes
PrivateNote String Private note only for this signer. yes
DocumentIds List<Int32> Ids of documents that this signer can see and sign. yes
AttachmentIds List<Int32> Ids of attachments that this signer can see. yes
Title String Formal title of person (director of board, chairman, ...) yes
Roles List<RoleModel> Roles of this signer. yes
OnBehalfOf String Who or what is this signer signing on behalf of? yes
EmailTemplateKey String Extra selector for emails sent to this signer. yes
HideAttachments Boolean Are attachments hidden for this signer? yes
AppendixOptional Boolean Should opening appendix be optional? yes
MailSubject String Subject line for invitation and reminder emails. yes
SignerPdfFields List<SignerPdfFieldModel> Signer field definitions for fields to merge into documents - only for this signer. yes
SignerPdfGroups List<SignerPdfGroupModel> Signer field definitions for fields to merge into documents - only for this signer. yes
IsTwoFactorSign Boolean Enable Two-factor signing for this signer. yes
UnknownSigner Boolean Signer is an unknown signer, and will be updated by a signer yes
TwoFactorPhoneNumber String Destination mobile phonenumber for the Two-factor shortcode. yes
TwoFactorSharedSecret String Shared secret for Two-factor sign. yes
RedirectUrl String Address to url, where user gets redirected on order completion. yes
NoSignatureRequired Boolean Is a signature required for this signer? yes
EmptyAttachmentIdsOverridesDefault Boolean Should all attachments be shown for a user with AttachmentIds where no AttachmentIds are given?
SignerId Int Signer ID used in RequiredToSignGroups - must be 0 or unique across entire order. yes



Update signer

Description

Change email address of signer.

Synopsis

POST api.esignatur.dk/Signer/Update

JSON Input

{
  "OrderId": "126c41bd-8028-4c82-8da9-533b535dd4dd",
  "OldEmail": "test@local.dk",
  "Email": "test@local.local"
}


Remind

Description

Send reminder to signer. You must specify the user owning the signer or a company administrator in the x-eSignatur-CreatorId HTTP header.

Synopsis

GET api.esignatur.dk/Signer/Remind/{signer-reference}


Remove

Description

Remove a signer from an order. You must specify the user owning the order or a company administrator in the x-eSignatur-CreatorId HTTP header. The number of mandatory signers on the step, must be lower then the total number of signers.

Synopsis

GET api.esignatur.dk/Signer/Remove/{signer-reference}


ChangeSigner

Description

Change a signer. The SignerModel is the same used as in the Order/Create call.

Synopsis

POST api.esignatur.dk/Signer/ChangeSigner/{signer-reference}

JSON Input

{
  "Name": "Signer Name",
  "ApproverId": 0,
  "HideAttachments": false,
  "AppendixOptional": false,
  "IsTwoFactorSign": false,
  "UnknownSigner": false,
  "EmptyAttachmentIdsOverridesDefault": false,
  "SignerId": 0,
  "IsPaymentSigner": false,
  "PaymentAmount": 0
}


MoveSigner

Description

Move a signer to a new step. A signer cannot be moved if attempting to move to a completed step, the signer has signed or the signer is part of a SignerGroup. If the NewStepNumber > number of steps, a new step is created at the end.

Synopsis

POS api.esignatur.dk/Signer/MoveSigner

JSON Input

{
  "Reference": "dkasdjlasdjasldasd",
  "NewStepNumber": 2
}