Order
Orders in the esignatur API are self contained. That is, everything needed to execute a signing request is given at once.
OrderModel
| Name |
Type |
Description |
Optional |
| CreatorId |
String |
Id of document creator. |
|
| SenderEmail |
String |
E-mail address of sender. |
|
| CommonNote |
String |
Message for all receivers of this sign order. |
yes |
| ReminderDate |
DateTime |
Date of first reminder. |
yes |
| ReminderInterval |
Int |
Days between reminders. |
yes |
| LoginIsMandatory |
Boolean |
Do users need to login to sign/download. True by default. |
yes |
| SignerCanRejectOrder |
Boolean |
Remove the option for the signer to reject the request. |
yes |
| CancelIsSilent |
Boolean |
Suppresse mails when order is cancelled? |
yes |
| EndDate |
DateTime |
End date or deadline of sign order. If not set then it defaults to 30 days from today. |
yes |
| ClientConfigurationProfile |
String |
Client Configuration Profile. |
yes |
| SignText |
String |
Text shown in the sign applet. HTML document without head and body definintions. Allowed tags are P, H1 and H2. Other tags are not styled and may be rejected by Nets. The list of documents to sign will always be shown. |
yes |
| CustomData |
String |
Custom data associated with this sign order. This will be played back in status call. String will be truncated after 1024 characters. |
yes |
| NotificationUrl |
String |
Url to receive order completed, cancelled, expired or signed events. |
yes |
| AnonymizeNotifications |
Boolean |
Anonymize notifications? |
yes |
| CustomerInvoiceNumber |
String |
Custom invoice number. This field was previously named CustomInvoiceNumber. |
yes |
| CustomSignUrl |
String |
Custom sign url |
yes |
| Documents |
List<DocumentModel> |
The documents to be signed. |
|
| Attachments |
List<DocumentModel> |
Attachments. These will not be signed. |
yes |
| Steps |
List<StepModel> |
Signer steps. |
|
| SignerPdfFields |
List<SignerPdfFieldModel> |
Signer field definitions for fields to merge into documents. |
yes |
| SignerPdfGroups |
List<SignerPdfGroupModel> |
Signer field definitions for fields to merge into documents. |
yes |
| PreloadFields |
List<PreloadFieldModel> |
Fields to be merged into documents at order creation time. |
yes |
| IsCPROrder |
Boolean |
Perform CPR validation on signer. |
yes |
| Dictionary |
Dictionary<String, String> |
Extra data used by the collector. |
yes |
| LanguageCode |
String |
Language used in email communications (da, nb, sv, en, da_en). |
yes |
| MailSubject |
String |
Subject line for invitation and reminder emails. |
yes |
| CustomContent |
SignCustomContent |
Custom content for signing envionment. |
yes |
| OwnerReminder |
Boolean |
Should owner be notified before EndDate? |
yes |
| OwnerReminderDaysBefore |
Int |
Days before Owner Reminder is set if OwnerReminder=true. 0 is valid and means same day. |
yes |
| IsFormSignerOrder |
Boolean |
Is this a FormSigner order (used in formular orders)? |
yes |
| SenderFormatter |
String |
Sender name formatter - a string with the following tokens: [CustomerName], [SenderName] and/or [SenderEmail]. |
yes |
| IsFilesOrder |
Boolean |
Set to mark this order as a Files / Sikker ePost order. Then add the files to the Files array. Documents and Attachments are not used. |
yes |
| Files |
List<DocumentModel> |
Files for the Files / Sikker ePost order. |
yes |
| SocialSecurityIdUpload |
Boolean |
Should the user always upload a social security ID (This only works when the order is a CPR order)? |
yes |
| PhotoIdUpload |
Boolean |
Should the user always upload a photo ID (This only works when the order is a CPR order)? |
yes |
| CustomerUniqueId |
Guid |
A unique (pr. order) Guid set by the customer. If we have seen another order with this Guid we will not (re-)create the order but return the former orders response. |
yes |
| InvoiceGroup |
String |
Customer invoice group. Used for grouping of invoices. String will be truncated after 1024 characters. |
yes |
| ReplyToEmail |
FriendlyEmailAddress |
Add reply to for this order. If not set, it defaults to the customers settings |
yes |
| OrderCompletedBcc |
List<FriendlyEmailAddress> |
Add recipients, that should recieve an email when the order is completed |
yes |
| AddAttachmentToOrderCompletedBcc |
Boolean |
Attach signed documents to bcc receipt emails. Requires OrderCompletedBcc to be set |
yes |
DocumentModel
| Name |
Type |
Description |
Optional |
| Title |
String |
Document title. If not set, defaults to filename. |
yes |
| Filename |
String |
Document filename. |
|
| DocumentFormat |
String |
Document format - set to Pdf for normal sign order. Do not set for Files / Sikker ePost orders. |
|
| DocumentData |
Byte[] |
Base64 encoded document. |
|
| CustomData |
String |
Custom data associated with this document. String will be truncated after 1024 characters. |
yes |
| TemplateKey |
String |
Load document with this template key. |
yes |
| DocumentId |
Int |
Document Id. Use this id in the signers DocumentIds or AttachmentIds lists. DocumentId <= 0 is reserved for internal use and is thus invalid. You should only send this if the value is 1 or greater (meaning you assign one or more signers to this document / attachment). |
yes |
| IsAttachment |
Boolean |
Is this an attachment? Attachments are not signed |
yes |
| DocumentType |
String |
Document Type. |
yes |
| DocumentCategory |
String |
Document Category. |
yes |
StepModel
| Name |
Type |
Description |
Optional |
| StartDate |
DateTime |
The start date of this step. Please note that only the date part will be used. The time part will be zeroed. |
yes |
| EndDate |
DateTime |
The end date of this step. Please note that only the date part will be used. The time part will be zeroed. |
yes |
| ReminderDate |
DateTime |
The first/next reminder date of this step. Please note that only the date part will be used. The time part will be zeroed. |
yes |
| ReminderInterval |
Int |
Number of days to next and subsequent reminders for this step. |
yes |
| Locked |
Boolean |
Is this step locked? Defaults to false. |
yes |
| RequiredToSign |
Int |
Number of signers on this step required to sign. 0 - all. |
yes |
| Signers |
List<SignerModel> |
The signers of this step. |
|
| SignerGroups |
List<SignerGroupModel> |
Signer groups. |
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 |
RoleModel
| Name |
Type |
Description |
Optional |
| Name |
String |
Role name. |
|
| DocumentIds |
List<Int32> |
Ids of documents that this role can see and sign - overrides DocumentIds on signer. |
yes |
| AttachmentIds |
List<Int32> |
Ids of attachments that this role can see - overrides AttachmentIds on signer. |
yes |
| EmailTemplateKey |
String |
EmailTemplateKey is used for propertyAdmin |
yes |
SignerGroupModel
| Name |
Type |
Description |
Optional |
| GroupType |
String |
Type of group, currently RequiredToSign or Mandatory. |
|
| SignerIds |
List<Int32> |
Signer IDs in this group. The Signer ID must be greater than 0. |
|
| MinimumMemberCount |
Int |
Minimum number of members to fullfil criteria of the group. |
|
FriendlyEmailAddress
| Name |
Type |
Description |
Optional |
| Email |
String |
Recipient email address. |
|
| Name |
String |
Recipient name. |
|
Create order
Description
Create a signing request order. Output is the order id.
Synopsis
POST api.esignatur.dk/Order/Create
JSON Input
{
"CreatorId": "Fill-in your creator-id",
"SenderEmail": "Matching email-address to the creator-id above",
"EndDate": "2023-06-11T02:16:33.4304412+02:00",
"AnonymizeNotifications": false,
"Documents": [
{
"Title": "Contract",
"Filename": "Contract.pdf",
"DocumentFormat": "Pdf",
"DocumentData": "JVBERi0xLjENCiXCpcKxw6sNCg0KMSAwIG9iag0KICA8PCAvVHlwZSAvQ2F0YWxvZw0KICAgICAvUGFnZXMgMiAwIFINCiAgPj4NCmVuZG9iag0KDQoyIDAgb2JqDQogIDw8IC9UeXBlIC9QYWdlcw0KICAgICAvS2lkcyBbMyAwIFJdDQogICAgIC9Db3VudCAxDQogICAgIC9NZWRpYUJveCBbMCAwIDU5NSAgODQyXQ0KICA+Pg0KZW5kb2JqDQoNCjMgMCBvYmoNCiAgPDwgIC9UeXBlIC9QYWdlDQogICAgICAvUGFyZW50IDIgMCBSDQogICAgICAvUmVzb3VyY2VzDQogICAgICAgPDwgL0ZvbnQNCiAgICAgICAgICAgPDwgL0YxDQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udA0KICAgICAgICAgICAgICAgICAgL1N1YnR5cGUgL1R5cGUxDQogICAgICAgICAgICAgICAgICAvQmFzZUZvbnQgL1RpbWVzLVJvbWFuDQogICAgICAgICAgICAgICA+Pg0KICAgICAgICAgICA+Pg0KICAgICAgID4+DQogICAgICAvQ29udGVudHMgNCAwIFINCiAgPj4NCmVuZG9iag0KDQo0IDAgb2JqDQogIDw8IC9MZW5ndGggNTkgPj4NCnN0cmVhbQ0KICBCVA0KICAgIC9GMSAxOCBUZg0KICAgIDIyNSA3MDAgVGQNCiAgICAoZXNpZ25hdHVyIFRlc3QpIFRqDQogIEVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQp4cmVmDQowIDUNCjAwMDAwMDAwMDAgNjU1MzUgZg0KMDAwMDAwMDAyMSAwMDAwMCBuDQowMDAwMDAwMDg2IDAwMDAwIG4NCjAwMDAwMDAxOTUgMDAwMDAgbg0KMDAwMDAwMDQ5MCAwMDAwMCBuDQp0cmFpbGVyDQogIDw8ICAvUm9vdCAxIDAgUg0KICAgICAgL1NpemUgNQ0KICA+Pg0Kc3RhcnR4cmVmDQo2MDkNCiUlRU9GDQo=",
"IsAttachment": false
}
],
"Attachments": [],
"Steps": [
{
"Signers": [
{
"Name": "your name",
"Email": "your email address",
"ApproverId": 0,
"DocumentIds": [],
"AttachmentIds": [],
"Roles": [],
"AppendixOptional": false,
"SignerPdfFields": [],
"SignerPdfGroups": [],
"IsTwoFactorSign": false,
"UnknownSigner": false,
"EmptyAttachmentIdsOverridesDefault": false,
"SignerId": 0,
"IsPaymentSigner": false,
"PaymentAmount": 0
}
],
"SignerGroups": []
}
],
"SignerPdfFields": [],
"SignerPdfGroups": [],
"PreloadFields": [],
"Dictionary": {},
"OwnerReminder": false,
"OwnerReminderDaysBefore": 0,
"IsFormSignerOrder": false,
"IsFilesOrder": false,
"Files": [],
"SocialSecurityIdUpload": false,
"PhotoIdUpload": false,
"ReplyToEmail": {
"Email": "no-reply@esignatur.dk",
"Name": "FirstName LastName"
},
"OrderCompletedBcc": [],
"AddAttachmentToOrderCompletedBcc": false
}
JSON Output
{
"OrderId": "a94cce99-8958-4a13-8d84-3bc0eae944fb",
"CustomData": "something you set when creating order",
"DocumentReference": "1212esdusdasd",
"SignerReferences": [
{
"StepNumber": 0,
"CustomData": "something else you set when creating order",
"Name": "Your name",
"Email": "Your email address",
"SignUrl": "https://sign.esignatur.dk/?id=r-xxxx",
"Reference": "xxxx"
}
],
"IsCPROrder": false,
"Documents": [
{
"AgreementId": "fkadf8914",
"DocumentId": 0,
"Link": "https://.../signflow/DirectPdf/Index/ODRlOTk1MjAtOTliNC00NjNjLWFmMTctZWJkOWZjYzg3MDVjfHNkYXNkYXNkMTIzMTIzfDI0MGJlZGZlLTg0OWQtNGU2MS04NzQzLWEwNWM1NGU5ZjdmNw0K"
}
],
"Attachments": []
}
Cancel order - DEPRECATED
Description
Cancel an active order.
Synopsis
GET api.esignatur.dk/Order/Cancel/{id}
Query pending orders - DEPRECATED
Description
Query pending orders for customer optionally filtered by sender email address.
PendingOrdersModel
| Name |
Type |
Description |
Optional |
| Email |
String |
E-mail address of sender. Set to null or blank disable e-mail filtering. |
yes |
Synopsis
POST api.esignatur.dk/Order/Pending
JSON Input
{
"Email": "test@local"
}
JSON Output
{
"PendingOrders": [
{
"DocumentStatus": "Completed",
"StatusTime": "2023-06-04T02:16:33.5404519+02:00",
"EndDate": "2023-06-11T02:16:33.5404519+02:00",
"Reference": "d2161f73SZNNHKT0",
"Email": "test@local",
"IsCPROrder": false,
"IsFilesOrder": false,
"DocumentsCount": 0,
"AttachmentsCount": 0,
"FilesCount": 0,
"Steps": [
{
"Signers": [
{
"LocalId": 0,
"Name": "Test user",
"Email": "test1@local",
"Identification": "1234567890",
"Status": "Completed",
"SignDate": "2023-06-04T02:16:33.5404519+02:00",
"CPRCheckPassed": false,
"IsTwoFactorSign": false,
"IsPaymentSigner": false,
"PaymentAmount": 0
}
],
"ReminderInterval": 0,
"Locked": false,
"RequiredToSign": 0
}
],
"IsArchived": false
}
]
}
Update
Description
Change various properties on an order once submitted. The following properties can be changed: CommonNote, CustomData, CustomerInvoiceNumber, CustomSignUrl, LanguageCode, MailSubject, NotificationUrl and SignText
OrderUpdateModel
| Name |
Type |
Description |
Optional |
| OrderId |
String |
Order Id |
|
| Properties |
Dictionary<String, String> |
Key/value pairs to change. |
|
Synopsis
POST api.esignatur.dk/Order/Update
JSON Input
{
"OrderId": "738c3632-b0e5-4725-8970-0d8e7028ebc5",
"Properties": {
"CustomerInvoiceNumber": "1231",
"CustomData": "her-er-jeg"
}
}
