Skip to content

  • Documentation
    • Web App – OKdokument API
    • Signatus Mobile App
  • Contact Us

1. API concept

  • Overview
  • 1.1 Supported web browsers
  • 1.2 Supported languages
  • 1.3 How to prepare document for signature
  • 1.4 How to use acrofields
  • 1.5 How to use pre-defined signature fields
  • 1.6 Document states
  • 1.7 Storing and deleting documents
  • 1.8 OKDokument API call list
  • 1.9 QR code
  • 1.10 Email and SMS
  • 1.11 Dictionary

2. Core API services

  • 2.1 Authorization
  • 2.2 Create signature request
  • 2.3 Open document
  • 2.4 Information about signing completion
  • 2.5 Result URL
  • 2.6 Download document
  • 2.7 Delete document

3. Additional API services

  • 3.1 List of the documents
  • 3.2 Document Info
  • 3.3 Update Signature Request ID
  • 3.4 Delete Signature Request ID
  • 3.5 Signature request Counter
  • 3.6 Upload document

4. Use cases

  • Overview
  • 4.1 Example 1: Simple one-round signing
  • 4.2 Example 2: One-round signing with redirect url
  • 4.3 Example 3: One-round signing with send info
  • 4.4 Example 4: Multi-Round Signing

5. Configuration of the signing process

  • Overview
  • 5.1 One-round signing with simple PDF
  • 5.2 Multi-round signing with simple PDF
  • 5.3  One-round signing with PDF with tags
  • 5.4 Multi-round signing with PDF with tags
  • 5.5 One-round signing with PDF with signature acrofields
  • 5.6 Multi-round signing with PDF with signature acrofields
  • 5.7 Accessing document after inserting OTP
  • 5.8 Sign document with OTP
  • 5.9 Email
  • 5.10 QR code

6. Examples

  • Postman examples
View Categories
  • Home
  • Documentation
  • Web App - OKdokument API
  • 4. Use cases
  • 4.1 Example 1: Simple one-round signing

4.1 Example 1: Simple one-round signing

Description

This is the simplest implementation of the API services. On the side of the portal only the necessary services and signing configuration are used. We recommend to use it when getting familiar with the API services and testing the integration between Portal and OK API document.

How it works

For quick testing and familiarization with the API services, it is enough to implement only 3 services, without additional parameter setting:

  1. 2.2 Create signature Request
  2. 2.3 Open document
  3. 2.6 Download document

With the Create signature request, a PDF in base64 format is sent to the service, which does not have any signature fields specified (neither with a tag nor a signature acrofield). The default setting of the OKdokument API is the use of signing with signAnywhere, the default validity of the signature Request is for signature is 24 hours from its creation (it can be change by setting parameter expirationTime).

Once signature Request is created successfully, OKdokument API returns:

  • Unique document ID
  • The URL of the document

By opening the URL of the document (which is part of the Portal), the document is displayed in the signer’s web browser. By signing and confirming the document, its status changes to  

“signed”. After signing the document, the signer is redirected to the static OKdokument API page. The signed document can be downloaded and saved in the Portal using the Download document service.

The signed document is automatically deleted after 10 days from the date of signature.

Figure 14 Simple one-round signature
Figure 15 Postman example 1

Updated on 25/07/2024
Overview4.2 Example 2: One-round signing with redirect url
  • Documentation
    • Web App – OKdokument API
    • Signatus Mobile App
  • Contact Us
Proudly powered by WordPress