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
  • 2. Core API services
  • 2.3 Open document

2.3 Open document

After successful creation of the signing request, next step is to open the document for signing. Document is opened by calling the Open document service. To open document use response from signature Request service

“url”: “https://apidev.okdokument.com/openDocument/1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8”

Service displays the PDF document in OKdokument graphic interface.

After the user signs (or cancels) the document there are several possibilities what can happened according to signature Request service parameters configuration:

  • User is redirected to OKdokument default “Thank you page”
  • Backend to backed communication is initialised (see chapter 2.4 Information about signing completion)
  • User is redirected to Portal result url (see chapter 2.5 Result URL)

Service specifications:

URLhttps://apidev.okdokument.com/openDocument/{signatureRequestId}
MethodGET
URL parameter signatureRequestIdunique identifier used in /JSON/signatureRequest method
ResponseHTTP status 302 when PDF document is uploaded and processed successfully, user is transferred to the document view HTTP status 400 when signatureRequestId is invalid

Example with signature Request id:

https://apidev.okdokument.com/openDocument/1d58a59e-e8f7-4d07-bb99-d3fa39cb58a8

Response header example with document id:

HTTP/1.1 302
Location: https://apidev.okdokument.com/viewDocument?id= y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F
Updated on 25/07/2024
2.2 Create signature request2.4 Information about signing completion
  • Documentation
    • OKdokument API
    • SIGNATUS User Manual
  • Contact Us
Proudly powered by WordPress