OK dokument (Independent Publisher) (Preview)
OK dokument delivers an easy to use and customizable electronic signature and digital document distribution platform that integrates seamlessly into your existing systems
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Seyfor Slovensko a.s. |
| URL | https://www.seyfor.com |
| tomas.szarka@seyfor.com |
| Connector Metadata | |
|---|---|
| Publisher | Seyfor Slovensko, a.s. |
| Website | https://okdokument.com/ |
| Privacy policy | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Categories | Productivity |
OK dokument - electronic signature
OK dokument delivers an easy to use and customizable electronic signature and digital content distribution platform that integrates seamlessly with your existing systems.
Publisher
Seyfor Slovensko, a.s.
Prerequisites
You need to have an account at https://app.okdokument.com and a valid API key generated by the OK dokument service.
Supported Operations
1. Document Upload
Action used for uploading a PDF file to the document signature service. This action takes a base64 string and uploads it to the OK dokument API platform.
Document passes several states during its lifetime. OK dokument API uses the following document states:
- tags – state that searches text tags and inserts signature acrofields. After successful insertion of acrofields it automatically changes state to tosign
- tostamp – state that insert digital stamp into the document
- tosign – document ready to be signed
- signed – signed document (within given signatureRequestID)
- errorsendinfo – error while calling info service
- canceled – canceled document – signer pressed the “Cancel” button in the document
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:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OKdokument API supports the following tags for mandatory signature:
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
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.
To convert file into PDF you must fill name of the document. This parameter is mandatory if you want to do the file conversion to PDF format. For conversion the file postfix must be:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Storing and deleting documents
OK dokument API does not serve the role of a permanent archive of signed document. Following rules are applied:
- Signed document is automatically deleted 10 days after signing
- Unsigned document is automatically deleted after 30 days after uploading
2. Signature Request
This action is used for generating signature request ID. Within this action you have to use Document ID. The Document ID is a result from Document upload action.
In this action you can transform your signature process into a multistage signature process. Adding additional parameter "Signature fields" allows you to manage what should be available in each signature request. You can use acrofields with internal names
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
This action can be used multiple times in your process. Signature request action is generated in OK dokument service as "Signature request" and this ID is unique for every "Sign" action.
To send request for document signature you use response attribute URL and use it in email, push notification or MS Teams to ask someone to sign specific document.
Once document is signed you can use “Signature request” to change the document state to “tosign” and create new signatureRequestId and prepare the document for next signature. Than the process repeats steps 3 – 5.
Example of Signature request with one mandatory acrofield
_SC1_
Example of Signature request with one mandatory acrofield and on optional acrofield in one signature request
_SC1_;_SO2_
Additional rules in Signature request
Additional rules can be used to:
- Disable or enable Sign Anywhere feature
- Predefine value for signer name
- enabling the input for signer name
- enabling sending signature request from OK Dokument
- enable email reminder
- OTP (one time password) configuration via email or SMS
- sign document with OTP
- disable signing with the mouse
| Rule Name | Parameter | Description |
|---|---|---|
| signAnywhereEnabled | true/false | parameter for disabling sign anywhere function |
| guiRequestSignerName | true/false | parameter for enabling the input for signer name |
| guiSignerName | Signer name | predefined value for signer name, max 40 characters. If guiRequestSignerName is enabled, signer name can be changed by signer. |
| signAnywhereEnabled | true/false | parameter for disabling sign anywhere function |
| emailTo | Signer email | Signers email to which signature request url will |
| be delivered. | ||
| emailFrom | Sender email | Senders email. Mandatory if emailTo rule is used |
| nameFrom | Sender name | Senders’ name, that will be used in the email templates |
| emailNotification | Rule that enables email reminder. Email reminder sends email every morning at 7:00 for signature requests that are not signed. The email is sent to emailTo and emailFrom – according to - signatureRequest configuration. | |
| emailFinal | Signer email | Email to deliver the signed document. If emailFinal is without parameter, the signed document will be sent to emailTo. |
| openOtpPhone | Signer phone | Signers phone number to which the one-time password for accessing the document will be delivered. To use SMS OTP, you must buy signature request package with SMS. |
| openOtpEmail | Signer email | Signers email to which the one-time password for accessing the document will be delivered. |
| signOtpPhone | Signer phone | Signers phone number to which the one-time password for signing the document will be delivered. OTP signature requires signature acrofield. |
| signOtpEmail | Signer email | Signers email to which the one-time password for signing the document will be delivered. OTP signature requires signature acrofield. |
| lang | sk, cs, en, ro, uk, pl, pt, hu | Language of email and SMS template, If the rule is not set, Slovak as a default language is used. |
| mouseSignature | false | Rule for disabling signing with the mouse. |
Syntaxt for writing signature request rules
RuleName-Value
Syntaxt for writing multiple signature request rules
RuleName1-Value_RuleName2-Value_RuleName3-Value
Example of Signature request with enabled Sign Anywhere
signAnywhereEnabled-true
Example of Signature request with disabled Sign Anywhere and enabled Signer name with prefilled value
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
Example of Signature request with disabled Sign Anywhere, enabled Signer name with prefilled value, defined OTP email to open signature request, email where signature request is sent, email template language, signature request sender email
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false
Expiration time
Default value for signature request expiration is 24 hours. You can extend this time range up to 10 days using this parameter expirationTime. Signature request ID expiration time. Time in Milliseconds since Jan 1, 1970 00:00:00 UTC
OKdokument API allows you to share signatureRequest url via e-mail. To send email you have to use rules:
- emailTo – email of the signer
- emailFrom – email of the sender
- nameFrom – name of the sender
Email will be delivered from okdokument@okdokument.sk, but when the signer hits reply/reply all button, the response will be sent directly to the sender (emailFrom). We recommend also using the following rules for additional setup in the signing process:
- emailFinal – email for sending the signed document. By default, emailTo is used, but it can be changed. In case of multi-round signing, use this rule in the last signing round and fill all singers’ email addresses. Example: emailFinalemail@address.com|email2@address.com
- emailNotification - email for sending reminder that document is awaiting signature.
- language – language of the email template
- filename – document name, that will be used in the email template. If filename is not filled, technical document ID will be used as a document name
3. Wait for Signature
Trigger action „Wait for Signature“ can be used in your process. „Wait for Signature“ action is waiting till document signature is confirmed in OK dokument service by clicking the Submit button. Once signature is submitted this trigger action is completed. You can use this action if you need to wait for document signature confirmation in your process.
4. Download signed document
This action allows you to download signed document and process the document in additional steps in your system or save it to SharePoint or other document storage system.
5. Delete document
Once your document is signed, you can delete the document from OK dokument service using action delete manually. All uploaded documents are deleted automatically after 60 days and signed documents are deleted after 10 days.
Obtaining Credentials
You can get the API key required to use OK dokument service by subscribing at https://okdokument.com/en/about/api/.
Known Issues and Limitations
Currently there are limitations to using acrofields and tags. The only possible use of tags or acrofields is predefined string format in your process: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ or _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Custom acrofield internal names are currently in use:
| Checkbox | Acrofield |
|---|---|
| Optional Checkbox | CO |
| Compulsory Checkbox | CR |
| Text Field | Acrofield |
|---|---|
| Optional TextField | TO |
| Compulsory Text Field | TC |
| Radio Button Group | Acrofield |
|---|---|
| Optional Radio button Group | RO |
| Compulsory Radio button Group | RC |
| Combo Box | Acrofield |
|---|---|
| Optional combobox | CBO |
| Compulsory combobox | CBC |
Deployment Instructions
Please use the instructions located here to deploy this connector as custom connector in Microsoft Power Automate, Power Apps or Azure LogicApps.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| OK dokument API Key | securestring | The app/subscription API key issued by Anasoft | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Document Delete |
Document Delete |
| Document Upload |
Document Upload |
| Download Signed Document |
Download Signed Document |
| Signature Request |
Signature Request |
Document Delete
Document Delete
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Document ID
|
Document ID | True | string |
Document ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
message
|
message | string |
message |
|
statusCode
|
statusCode | integer |
statusCode |
Document Upload
Document Upload
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Document operation
|
state | string |
Document operation |
|
|
File
|
file | True | binary |
File content |
|
Filename
|
filename | string |
Filename with extension |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Document ID
|
result | string |
Document ID |
Download Signed Document
Download Signed Document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Document ID
|
Document ID | True | string |
Document ID from Document Upload action |
Returns
Document Content
- Document Content
- binary
Signature Request
Signature Request
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Document ID
|
id | True | string |
Document ID from Document Upload action |
|
Signature fields
|
SIGNATURE | string |
Signature fields in your document |
|
|
Expiration time
|
expirationTime | string |
Expiration time in Milliseconds |
|
|
Name
|
name | string |
Name of the acrofield |
|
|
Value
|
value | string |
Acrofield value |
|
|
Read Only
|
readOnly | boolean |
Acrofield is read only |
|
|
Additional Rules
|
rules | string |
Rules to define signature request process |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Signature Request ID
|
result | string |
Signature Request ID |
|
Signature Request URL
|
url | string |
url |
Triggers
| Wait for document signature |
Wait for document signature |
Wait for document signature
Wait for document signature
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Signature Request ID
|
signatureRequestId | True | string |
Signature Request ID from Signature request action |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
code |
|
statusCode
|
statusCode | integer |
statusCode |
Definitions
binary
This is the basic data type 'binary'.