Status

The status of an order can be gotten in the entire lifetime of an order.

The following models are used in the response:

StatusResponseModel
Name Type Description Optional
DocumentStatus String Status of order.
StatusTime DateTime Date and time of latest status change
EndDate DateTime The end date of the order.
Reference String Friendly reference.
Email String Senders e-mail address.
CustomData String Custom data.
CustomInvoiceNumber String Custom invoice number.
CustomerInvoiceNumber String Custom invoice number.
CommonNote String Common note.
IsCPROrder Boolean Is this a CPR order?
IsFilesOrder Boolean Is this a Files order?
Documents List<OverviewDocumentResponseModel> Documents on order.
DocumentsCount Int Number of documents to be signed in the order.
Attachments List<OverviewDocumentResponseModel> Attachments on order.
AttachmentsCount Int Number of attachments in the order.
Files List<OverviewDocumentResponseModel> Files on order.
FilesCount Int Number of files in the order.
RejectSignerReference String If order is cancelled: signer reference of signer cancelling the order or empty if owner cancelled.
RejectReason String If order is cancelled: signer supplied reason why order was cancelled. Empty if owner cancelled.
Steps List<StepResponseModel> The steps of the order.
IsArchived Boolean Is this an archived order?


OverviewDocumentResponseModel
Name Type Description Optional
Title String Title of document.
AgreementId String Agreement Id of document as set by esignatur.
Filename String Filename.
CustomData String Any custom data attached to this document.
IsAttachment Boolean Is this document an attachment? Attachments are not signed.
DocumentId Int The document id.


StepResponseModel
Name Type Description Optional
Signers List<SignerResponseModel> The signers of this step.
EndDate DateTime The end date of this step.
StartDate DateTime The start date of this step.
ReminderDate DateTime The first/next reminder date of this step.
ReminderInterval Int Number of days to next and subsequent reminders for this step.
InvitationDate DateTime The first invitation date of this group.
Locked Boolean Is this step locked?
RequiredToSign Int Number of signers on this step required to sign. 0 - all.


SignerResponseModel
Name Type Description Optional
Reference String Signer Reference.
LocalId Int Local ID of signer
Title String Formal title of signer.
Name String Name of signer.
Email String E-mail of signer.
Identification String Identification of signer.
IdentificationType String Identification type of signer. May be null or unknown.
Status String Status of signer.
SignDate DateTime Date of signing.
CustomData String Custom data.
Roles List<String> Roles of this signer.
SignerRoles List<RoleModel> Roles of this signer.
OnBehalfOf String Who or what is this signer signing on behalf of?
InvitationDate DateTime Invitation date of this signer.
SocialSecurityNumber String Social Security Number of signer - only for CPR validation orders.
CPRCheckPassed Boolean Did the signer pass the CPR check? Only to be trusted if order status is Complete.
IsTwoFactorSign Boolean Is signer a twofactor signer.
TwoFactorPhoneNumber String Easysign phone number of signer.
TwoFactorSharedSecret String Shared password for Easysign of signer.
DocumentIds List<Int32> List of document ids the signer can see.
DocumentSigned DateTime When / if signer has signed.
EmailTemplateKey String Extra selector for emails sent to this signer. yes
PrivateNote String Private note.
MailSubject String Mail subject.



Get status

Description

Get the status of the order.

Synopsis

GET api.esignatur.dk/Status/Get/{id}

JSON Output

{
  "DocumentStatus": "Completed",
  "StatusTime": "2021-04-12T15:49:18.5322054+02:00",
  "EndDate": "2021-04-19T15:49:18.5322054+02:00",
  "Reference": "d2161f73SZNNHKT0",
  "Email": "test1@local",
  "CustomData": "Test sign order",
  "IsCPROrder": false,
  "IsFilesOrder": false,
  "DocumentsCount": 1,
  "AttachmentsCount": 0,
  "FilesCount": 0,
  "Steps": [
    {
      "Signers": [
        {
          "Reference": "NTY1ZDczZjgtYzdlNC00NDY3LThkYWYtOGE2ZDRmNzQwODYyfHx8MA==",
          "LocalId": 1,
          "Name": "Test user",
          "Email": "test@local",
          "Identification": "1-22-333-4444-55555",
          "Status": "Completed",
          "SignDate": "2021-04-12T15:49:18.5478244+02:00",
          "CustomData": "My test signer",
          "CPRCheckPassed": false,
          "IsTwoFactorSign": false,
          "IsPaymentSigner": false,
          "PaymentAmount": 0
        }
      ],
      "EndDate": "2021-05-12T15:49:18.5322054+02:00",
      "StartDate": "2021-04-14T15:49:18.5322054+02:00",
      "ReminderDate": "2021-04-21T15:49:18.5322054+02:00",
      "ReminderInterval": 5,
      "Locked": false,
      "RequiredToSign": 0
    }
  ],
  "IsArchived": false
}


Get order activity

Description

Get the full activity of the order.

Synopsis

GET api.esignatur.dk/Status/GetOrderActivity/{id}

JSON Output

{
  "SignerActivity": [
    {
      "Reference": "ODE3ZTdiZTgtMjlhYy00MDE2LTkxNjgtNGM0NjYzNjA2ZTY4fHx8MA==",
      "Invited": "2021-04-10T15:49:18.5322054+02:00",
      "DocumentActivity": [
        {
          "DocumentRead": [
            "2021-04-12T09:49:18.5322054+02:00",
            "2021-04-12T08:49:18.5322054+02:00",
            "2021-04-12T07:49:18.5322054+02:00"
          ],
          "AgreementId": "sdafdfasd9719082aa",
          "ReadMandatory": true
        }
      ],
      "Signed": "2021-04-12T10:49:18.5322054+02:00",
      "Reminders": [
        "2021-04-11T15:49:18.5322054+02:00"
      ]
    }
  ],
  "Created": "2021-04-10T15:49:18.5322054+02:00",
  "Completed": "2021-04-12T15:49:18.5322054+02:00"
}