Skip to content

  • Documentation
    • OKdokument API
    • SIGNATUS User Manual
  • 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
View Categories
  • Home
  • Documentation
  • OKdokument API
  • 1. API concept
  • 1.3 How to prepare document for signature

1.3 How to prepare document for signature

The prerequisite for successful signing is to have the document available in PDF format, the recommended version is 1.7 and higher.

There are several ways to specify where inside the document should the user sign:

  1. Signature acrofields
  2. Tags

Specifying where the user should sign allows for better management of the entire signing process. Especially when multiple people are signing remotely (i.e. not signing on single device in a face-to-face scenario).

Signature acrofields

Acrofield is a type of active field supported in PDF. A signature acrofield is a special type of active field that allows a signature to be inserted into a document at a fixed location.

Acrofields can be inserted into PDFs with specialized PDF tools such as Adobe PRO, or with template tools such as JasperReport.

Tags

A tag represents a unique text value that the API server scans. If it finds it, it inserts the signature acrofield in its place. The tag lookup is provided by the “tags” document state, which must be set when the JSON/document service is called.

OKdokument API supports the following tags for optional signature:

  1. _SO1_
  2. _SO2_
  3. _SO3_
  4. _SO4_
  5. _SO5_

OKdokument API supports the following tags for mandatory signature:

  1. _SC1_
  2. _SC2_
  3. _SC3_
  4. _SC4_
  5. _SC5_
  1. _S1_
  2. _S2_
  3. _S3_
  4. _S4_
  5. _S5_

If mandatory tags are used, all visible mandatory signature acrofields must signed before submitting the document.

In case it is not possible to prepare documents with signature acrofields or tags when registering signatureRequest, it is possible to enable “sign anywhere” functionality, which will allow the user to sign the document at any location, simple where the user clicks/taps.

Convert document to PDF

OKdokument API supports conversion of .doc, .docx, .xls, .xlsx into PDF file format. The source file can contain also tags, OKdokument API will first do the file conversion and then automatically inserts signature acrofields.  

Note: we recommend to check the converted PDF structure before signing.

Updated on 25/07/2024
1.2 Supported languages1.4 How to use acrofields
  • Documentation
    • OKdokument API
    • SIGNATUS User Manual
  • Contact Us
Proudly powered by WordPress