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
  • 3. Additional API services
  • 3.2 Document Info

3.2 Document Info

Returns a document metadata with given ID in JSON format.

Service specification:

URLhttps://apidev.okdokument.com/JSON/document/metadata/{{documentId}}
MethodGET
Authenticationset header x-api-key
ResponseHTTP 200 when successful HTTP 404 if document not found

The response body is a JSON format.

Properties of the array elements:

filenameName of the item. (*.pdf)
idUnique identification of the document (used to send acknowledgments)
urlLink to download (for document) or to list the contents
stateState of the document: “tosign”, “signed”

Example of success response

{
    "filename": "cec00479-5669-491d-ae52-47d3b690efd7.pdf",
    "state": "tosign",
    "modification": "2022-06-21 14:30:44",
    "id": "y7Ki_u1mrUwijfb-o_S1JiphSsoXya8iypH380F",
    "date": 1655814644472,
    "number": "1655814644463"
}

Updated on 25/07/2024
3.1 List of the documents3.3 Update Signature Request ID
  • Documentation
    • OKdokument API
    • SIGNATUS User Manual
  • Contact Us
Proudly powered by WordPress