Shortcuts

Area	Description
ActivityLog	Get the activity log for a named signer or the entire order.
Attachments	Download the attachments given when the order was initially created.
Cancel Order	Cancel order.
Collected Data Documents	Download any collected data or CPR validation result documents.
Dates	Change dates and associated intervals of the order or individual steps on the order.
Deliverables	Download the deliverables of order.
EasySign	Change phonenumber or shared secret on a EasySign signer.
InputFields	Get values of SignerInputFields after order is completed.
Lock	Lock/unlock steps.
Order	Methods to create or cancel signing request orders
Order Attachments	List or get files uploaded to order by signer (Order Attachments).
Order Info	Methods to get a list of signing request orders
Pades	Download sealed document in PAdES format when order is complete.
Signer	Change email address and/or name of signer.
Status	Get the status of the order.
SourceDocument	Download original uploaded documents when the order was initially created.
Steps	Change dates, intervals and RequiredToSign of the individual steps on the order.
Users	Methods to add and modify users.

Flow

1. Before creating your first signing request you must be registered as customer. Your service provider will supply you with a key which must be passed to the API in the X-eSignatur-Id header.
2. Then create the signing request. Use the Order/Create method (Order)
3. After the order have placed query the Status to get the runtime status of the order.
4. If you need to change information about a signer (such as the e-mail address) use the Signer methods.
5. When the document is completed (signed by all) then you can download the signed PDF files in PAdES format (Pades).

X-eSignatur-Id and X-eSignatur-CreatorId

You should always send these two headers.

Encoding and Datatypes

Encoding

The API expects input data to use UTF. If you f.ex. use ISO8859-1 or Windows CP-850 your input will be accepted but it will be parsed incorrectly. Danish æ, ø and å (and other 8-bit characters) will either be shown with a ? or removed.

Incorrect encoding:

000001e0: 2020 2254 6974 6c65 223a 2022 4469 7265    "Title": "Dire
000001f0: 6b74 f872 222c 0d0a 2020 2020 2020 2020  kt.r",..

... correct encoding:

000001e0: 2020 2254 6974 6c65 223a 2022 4469 7265    "Title": "Dire
000001f0: 6b74 c3b8 7222 2c0d 0a20 2020 2020 2020  kt..r",..

Notice that the ø in the first sample is a single character from ISO8859-1. In the second example it has been correctly encoded to the UTF8 version.

Datatypes

DateTime

All DateTime objects sent from the API are encoded using the Microsoft /DATE(..) format. DateTime objects sent to the API can follow any of the standards used by JSON.

Error responses

If a successful operation completes a HTTP code 200 (OK) header is sent to the client.

If an error occurs then one of the following error codes are returned:

• 400 (Bad Request) - typically in response to a query which yields no results.
• 403 (Unauthorized) - the client does not have access to the the requested resource.
• 500 (Internal Server Error) - something in the API broke. This is typically a malformed json so check your input using f.ex JSON lint.

The full error text will be set in the X-esignatur-error response header.

Any textual description accompanying the error code is subject to change without notice.

Notifications

You can be set up to receive notifications when certain events occurs. We will then post a NotificationMessage to a URL of your choice.

For more information about notifications, see Notifications.

FAQ

I get the following error "No X-eSignatur-Id found in headers" - what does it mean?

You need to include the X-eSignatur-Id header in your request. The value must be set to the key you have previously gotten from your service provider or Rovsing Applications.

I get the following error "No such customer (..)" - what does it mean?

The supplied X-eSignatur-Id is not a registered customer. Please contact your service provider or Rovsing Applications.

I get the following error "You are not allowed to do that" - what does it mean?

You tried to access a method which is intended for service providers. You shouldn't do that.

Some methods are marked -DEPRECATED. What does that mean?

Deprecated are maintained but they will no longer receive new functionality. Eventually, the methods will go away.

I'm stuck - how do I get help?

Please contact esignatur by email: dev@esignatur.dk