View Categories

Overview

The contents of this document serve primarily to software developers and architects. This document describes the basic functionality of OKdokument API and integration options.

In chapters 6 and 7, the different integration options are explained with practical examples that can be tested using postman collections.

OKdokument API works on a JSON REST interface in which the user is authenticated based on the API key. The API key allows the system to be integrated and to access OKdokument API.

In order to access OKdokument API, the API needs to be active.

In addition to the API key, it is also necessary to purchase “signature requests”. One signature Request represents the registration of a unique signatureRequestID through the API. Multiple signatures can be made within a signature Request.

The signing of the document itself happens directly via a web browser, independent of the platform. Signing documents can be done by any means available:

  • Mouse on PC
  • Finger on a touch device
  • Passive stylus
  • Active stylus

Before actually using OKdokument API, we recommend thinking about the following areas:

  1. In which processes will documents be signed digitally?
  2. Where and how is a new document created?
  3. Can the system that prepares the document for signature determine the exact signature placement? (1.3 How to prepare document for signature)
  4. In case of multiple signatures inside a document, will the signatories sign at the same time or at different times and places?
  5. How will the signatory access the url to sign the document? (portal, client zone, email, etc.)
  6. Where will the finalized document be archived? (DMS, CRM, filesystem other)
  7. How will the finalized document be delivered to the signers? (e-mail, client zone etc.)

OKdokument API uses the following services:

Basic API services

  • Create a signature Request
  • Open document
  • Download a document
  • Delete a document
  • Information on signing completion
  • Result URL

Additional API services