Dokobit Universal API

Dokobit Universal API is a versatile tool that enables signing documents internally, within your system, and collecting signatures from 3rd parties, outside your system, across Europe. Document signing occurs in an accountless Dokobit signing (where invited participants can sign documents without registering on the Dokobit portal) interface with your organisation’s branding.

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 Dokobit
URL https://support.dokobit.com
Email developers@dokobit.com
Connector Metadata
Publisher Dokobit
Website https://www.dokobit.com/solutions
Privacy policy https://www.dokobit.com/compliance/privacy-policy
Categories Productivity

Dokobit Universal API is a versatile tool that enables signing documents internally, within your system, and collecting signatures from 3rd parties, outside your system, across Europe. Document signing occurs in an accountless Dokobit signing (where invited participants can sign documents without registering on the Dokobit portal) interface with your organisation’s branding.

Prerequisites

In order to use Dokobit Universal API contact us at sales@dokobit.com to obtain the API access token.

How to get credentials

Contact our Sales to get the API access token

Get started with your connector

  • Document signing can be initiated using 'DokobitUniversalAPICreateExternalSigning' or 'DokobitUniversalAPICreateInternalSigning' actions. Using 'DokobitUniversalAPICreateExternalSigning' will send a signing invitation to the participants. 'DokobitUniversalAPICreateInternalSigning' will generate a signing URL where users can be redirected.
  • Signing can then be managed with corresponding actions allowing you to add/remove participants, send reminders or check the document signing status.
  • After participants sign the document, it can be downloaded with 'DokobitUniversalAPIDownloadDocumentExternal' or 'DokobitUniversalAPIDownloadDocumentInternal' actions.

Known issues and limitations

The current implementation supports signature gathering on PDF files and supported by ASiCe, ADoc, BDoc or EDoc containers.

Common errors and remedies

  • File must be provided as Base64 encoded file content.
  • If document signing 'Type' is set to 'pdf', a single PDF document will be accepted when document signing is initiated. For multiple files, set the signing 'Type' to 'asice' or another container format.

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
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add External Signer

Indicated participants will gain access to the document with the selected role.

Add Internal Signer

Indicated participants will gain access to the document with the selected role.

Check External Signing Status

Returns document's information with signing status.

Check Internal Signing Status

Returns document's information with signing status.

Create External Signing

External signing initiates asynchronous signing request from your system. In this case user receives an email for signing and you will get a callback once he signs the document.

Create Internal Signing

Internal signing initiates signing request from your system. In this case signing URL is generated where participant should be redirected.

Delete External Signer

Access to the document will be revoked for the indicated participant.

Delete External Signing

The document will be removed from the owner's account. It will remain accessible to other participants.

Delete Internal Signer

Access to the document will be revoked for the indicated participant.

Delete Internal Signing

The document will be removed from the owner's account. It will remain accessible to other participants.

Download Document External

Downloads the signed document.

Download Document Internal

Downloads the signed document.

e-Delivery

Document e-Delivery is used for securely sharing documents with Dokobit Universal API.

Seal signing

Document will be sealed with your organizations' electronic seal. Please contact our support at developers@dokobit.com to get a qualified certificate for e-sealing.

Send Reminder

Allows to send a reminder e-mail for participant, only if person has not signed document yet. Only works with external signing flow.

Update External Signing

Allows to update attributes of an existing document signing.

Update Internal Signing

Allows to update attributes of an existing document signing.

Validation

Dokobit is an eIDAS-certified service provider for qualified e-signature and e-seal validations. Use this action to upload a signed file for validation. Supported file types: 'asice', 'asics', 'sce', 'bdoc', 'edoc', 'pdf', 'p7s', 'xml'.

Validation - Detailed PDF Report

Download detailed validation report in PDF.

Validation - PDF Report

Download validation report in PDF.

Validation - XML Diagnostic Data

Download diagnostic data in XML.

Validation - XML Report

Download validation report in XML.

Add External Signer

Indicated participants will gain access to the document with the selected role.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

External ID
external_id True string

Unique random identifier of the participant from your system. You can generate unique random identifiers if you do not have one.

Name
name string

Participant's name.

Surname
surname string

Participant's surname.

E-mail
email string

Participant's e-mail.

Code
code string

Participant's code.

Country code
country_code string

Participant's country code.

Role
role string

Participant's role. Default: 'signer'.

Company
company string

Participant's company.

Position
position string

Participant's position.

Phone
phone string

Participant's phone.

Custom Reason
custom_reason string

Custom signature reason.

Comment
comment string

Message for participants.

Returns

Name Path Type Description
Status
status string

Status.

Signers
signers array of object

Participant's information.

External ID
signers.external_id string

Unique random identifier of the participant from your system.

Token
signers.token string

Participant's token.

Name
signers.name string

Participant's name.

Surname
signers.surname string

Participant's surname.

E-mail
signers.email string

Participant's e-mail.

Code
signers.code string

Participant's personal code (National ID number).

Country Code
signers.country_code string

Participant's country.

Role
signers.role string

Participant's role.

Company
signers.company string

Participant's company.

Position
signers.position string

Participant's position.

Notifications Language
signers.notifications_language string

Sets the language for notifications. Available values: 'en', 'lt', 'lv', 'ee', 'is', 'no', 'fr', 'se', 'de'.

Phone
signers.phone string

Participant's phone.

Add Internal Signer

Indicated participants will gain access to the document with the selected role.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

External ID
external_id True string

Unique random identifier of the participant from your system. You can generate unique random identifiers if you do not have one.

Role
role string

Participant's role. Default: 'signer'.

Custom Reason
custom_reason string

Custom signature reason.

Returns

Name Path Type Description
Status
status string

Status.

Signers
signers array of object

Participant's information.

External ID
signers.external_id string

Unique random identifier of the participant from your system.

Token
signers.token string

Participant's token.

Name
signers.name string

Participant's name.

Surname
signers.surname string

Participant's surname.

E-mail
signers.email string

Participant's e-mail.

Code
signers.code string

Participant's personal code (National ID number).

Country Code
signers.country_code string

Participant's country.

Role
signers.role string

Participant's role.

Company
signers.company string

Participant's company.

Position
signers.position string

Participant's position.

Phone
signers.phone string

Participant's phone.

Check External Signing Status

Returns document's information with signing status.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

Name Path Type Description
Signing Status
status string

Document signing status.

Name
name string

Signing name displayed for user.

Type
type string

Document type.

Date Created
date_created string

Date when document signing was initiated.

Deadline
deadline date-time

Signing deadline date with specified timezone fragment. Example: 2018-11-05T13:15:30Z.

File Name
filename string

Name of the file.

Files
files array of object
Name
files.name string

File Name.

Download URL
files.url string

File Download URL.

MIME Type
files.mime_type string

File MIME Type.

Signers
signers array of object

Participant information.

Token
signers.token string

Participant's token.

Name
signers.first_name string

Participant's name.

Surname
signers.last_name string

Participant's surname.

Code
signers.code string

Participant's code.

Country
signers.country string

Participant's country.

E-mail
signers.email string

Participant's e-mail.

Type
signers.type string

Type.

Status
signers.status string

Participant's status.

Check Internal Signing Status

Returns document's information with signing status.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

Name Path Type Description
Signing Status
status string

Document signing status.

Name
name string

Signing name displayed for user.

Type
type string

Document Type.

Date Created
date_created string

Date when document signing was initiated.

Deadline
deadline date-time

Signing deadline date with specified timezone fragment. Example: 2018-11-05T13:15:30Z.

File Name
filename string

Name of the file.

Files
files array of object
Name
files.name string

File Name.

Download URL
files.url string

File Download URL.

MIME Type
files.mime_type string

File MIME Type.

Signers
signers array of object

Participant information.

Token
signers.token string

Participant's token.

Name
signers.first_name string

Participant's name.

Surname
signers.last_name string

Participant's surname.

Code
signers.code string

Participant's code.

Country
signers.country string

Participant's country.

E-mail
signers.email string

Participant's e-mail.

Type
signers.type string

Type.

Status
signers.status string

Participant's status.

Create External Signing

External signing initiates asynchronous signing request from your system. In this case user receives an email for signing and you will get a callback once he signs the document.

Parameters

Name Key Required Type Description
Type
type True string

Document format. Available values: 'pdf', 'asice', 'bdoc', 'edoc', 'adoc', 'adoc.cedoc'.

Name
name True string

Signing name displayed for user.

Postback URL
postback_url string

URL of your system to handle webhooks.

Deadline
deadline date-time

Signing deadline date with specified timezone fragment. Example: 2018-11-05T13:15:30Z.

Hard Deadline
hard_deadline boolean

If set to 'true' participants won't be able to sign this document after set 'deadline'. Default: 'false'.

Require Qualified Signatures
require_qualified_signatures boolean

Allow to sign only with qualified signatures. Default: 'false'.

Annotation Position
annotation_position string

You can choose the position of signature annotations on a PDF document. Available values: 'first_top', 'first_bottom', 'last_top', 'last_bottom', 'none'. Default: 'first_top'.

Annotation Personal Code
annotation_personal_code boolean

If set to 'true' personal code will be visible in annotation. Only applicable for PDF type signing. Default: 'false'.

Comment
comment string

Message for participants.

Allow Video Identification
allow_video_identification boolean

Allow to sign using video-based identification. Default: 'false'.

Allow Document Saving
allow_document_saving boolean

Allow user to save document to the Dokobit Portal and make further actions. Default: 'true'.

Flatten PDF
flatten_pdf boolean

If set to true the document will be flattened so that the form fields become part of the document content and cannot be edited after signing. Only applicable for PDF type signing. Default: 'false'.

Allowed Signing Methods
allowed_signing_methods array of string

Allow only specific signing methods. Available values: 'mobile', 'smartid', 'smartcard', 'eparaksts_mobile', 'bankid_no', 'bankid_se', 'audkenni_app', 'ftn', 'mitid', 'nemid', 'electronic_id', 'itsme', 'idin', 'swisscom'.

Name
name True string

File name.

Content
content True string

Base64 encoded file content.

External ID
external_id True string

Unique random identifier of the participant from your system. You can generate unique random identifiers if you do not have one.

Name
name string

Participant's name.

Surname
surname string

Participant's surname.

E-mail
email string

Participant's e-mail.

Code
code string

Participant's personal code (National ID number).

Country Code
country_code string

Participant's country code. Required if personal code is provided.

Role
role string

Participant's role. Default: 'signer'.

Company
company string

Participant's company name.

Position
position string

Participant's position.

Phone
phone string

Participant's phone number.

Sequence
sequence integer

Allows setting up the sequence order of document approving and signing actions.

Notifications Language
notifications_language string

Sets the language for notifications. Available values: 'en', 'lt', 'lv', 'ee', 'is', 'no', 'fr', 'se', 'de'.

Custom Reason
custom_reason string

Custom signature reason.

Returns

Name Path Type Description
Status
status string

Status.

Signing Token
token string

Signing token.

Signers
signers array of object

Participant's information.

External ID
signers.external_id string

Unique random identifier of the participant from your system.

Token
signers.token string

Participant's token.

Name
signers.first_name string

Participant's name.

Surname
signers.last_name string

Participant's surname.

Code
signers.code string

Participant's personal code (National ID number).

Country
signers.country string

Participant's country.

E-mail
signers.email string

Participant's e-mail.

Create Internal Signing

Internal signing initiates signing request from your system. In this case signing URL is generated where participant should be redirected.

Parameters

Name Key Required Type Description
Type
type True string

Document format. Available values: 'pdf', 'asice', 'bdoc', 'edoc', 'adoc', 'adoc.cedoc'.

Name
name True string

Signing name displayed for user.

Redirect URI
redirect_uri True string

Redirect uri that will be used for redirecting signer after signing is completed.

Require Qualified Signatures
require_qualified_signatures boolean

Allow to sign only with qualified signatures. Default: 'false'.

Annotation Position
annotation_position string

You can choose the position of signature annotations on a PDF document. Available values: 'first_top', 'first_bottom', 'last_top', 'last_bottom', 'none'. Default: 'first_top'.

Annotation Personal Code
annotation_personal_code boolean

If set to 'true' personal code will be visible in annotation. Only applicable for PDF type signing. Default: 'false'.

Allow Video Identification
allow_video_identification boolean

Allow to sign using video-based identification. Default: 'false'.

Flatten PDF
flatten_pdf boolean

If set to true the document will be flattened so that the form fields become part of the document content and cannot be edited after signing. Only applicable for PDF type signing. Default: 'false'.

Allowed Signing Methods
allowed_signing_methods array of string

Allow only specific signing methods. Available values: 'mobile', 'smartid', 'smartcard', 'eparaksts_mobile', 'bankid_no', 'bankid_se', 'audkenni_app', 'ftn', 'mitid', 'nemid', 'electronic_id', 'itsme', 'idin', 'swisscom'.

Name
name True string

File name.

Content
content True string

Base64 encoded file content.

External ID
external_id True string

Unique random identifier of the participant from your system. You can generate unique random identifiers if you do not have one.

Role
role string

Participant's role. Default: 'signer'.

Custom Reason
custom_reason string

Custom signature reason.

Returns

Name Path Type Description
Status
status string

Status.

Signing Token
token string

Signing token.

Signers
signers array of object

Participant's information.

External ID
signers.external_id string

Unique random identifier of the participant from your system.

Token
signers.token string

Participant's token.

Redirect URI
signers.redirect_uri string

URL to signing.

Delete External Signer

Access to the document will be revoked for the indicated participant.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Token
token True string

Participant's token.

Returns

Name Path Type Description
Status
status string

Status.

Delete External Signing

The document will be removed from the owner's account. It will remain accessible to other participants.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

Name Path Type Description
Status
status string

Status.

Delete Internal Signer

Access to the document will be revoked for the indicated participant.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Token
token True string

Participant's token.

Returns

Name Path Type Description
Status
status string

Status.

Delete Internal Signing

The document will be removed from the owner's account. It will remain accessible to other participants.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

Name Path Type Description
Status
status string

Status.

Download Document External

Downloads the signed document.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

response
object

Download Document Internal

Downloads the signed document.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

response
object

e-Delivery

Document e-Delivery is used for securely sharing documents with Dokobit Universal API.

Parameters

Name Key Required Type Description
Type
type True string

Document format. Available values: 'pdf', 'asice', 'bdoc', 'edoc', 'adoc', 'adoc.cedoc'.

Name
name True string

Document name displayed for user.

Postback URL
postback_url string

URL of your system to handle webhooks.

Comment
comment string

Message for recipients.

Name
name True string

File name.

Content
content True string

Base64 encoded file content.

External ID
external_id True string

Unique random identifier of the participant from your system. You can generate unique random identifiers if you do not have one.

Code
code True string

Recipient's personal code (National ID number).

Country Code
country_code True string

Recipient's country code. Required if personal code is provided. Available values: 'lt', 'lv', 'ee', 'is'.

E-mail
email string

Recipient's email for sending document. Required if phone is not set.

Phone
phone string

Recipient's phone number for sending document SMS. Required if email is not set. SMS will be sent only when email is not provided.

Notifications Language
notifications_language string

Sets the language for notifications. Available values: 'en', 'lt', 'lv', 'ee', 'is', 'no', 'fr', 'se', 'de'.

Returns

Name Path Type Description
Status
status string

Status.

Document token
token string

Document token.

Recipients
recipients array of object

Recipient's information.

External ID
recipients.external_id string

Unique random identifier of the participant from your system.

Token
recipients.token string

Recipient's token.

Code
recipients.code string

Recipient's personal code (National ID number).

Country
recipients.country string

Recipient's country.

E-mail
recipients.email string

Recipient's e-mail.

Seal signing

Document will be sealed with your organizations' electronic seal. Please contact our support at developers@dokobit.com to get a qualified certificate for e-sealing.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Returns

Name Path Type Description
Status
status string

Status.

Send Reminder

Allows to send a reminder e-mail for participant, only if person has not signed document yet. Only works with external signing flow.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Signer Token
signer True string

Participant's token.

Message
message string

Reminder message to signer.

Returns

Name Path Type Description
Status
status string

Status.

Update External Signing

Allows to update attributes of an existing document signing.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Deadline
deadline date-time

Signing deadline date with specified timezone fragment. Example: 2018-11-05T13:15:30Z.

Hard Deadline
hard_deadline boolean

If set to 'true' participants won't be able to sign or approve this document after set 'deadline'. Default: 'false'.

Require Qualified Signatures
require_qualified_signatures boolean

Allow to sign only with qualified signatures. Default: 'false'.

Allow Video Identification
allow_video_identification boolean

Allow to sign using video-based identification. Default: 'false'.

Allow Document Saving
allow_document_saving boolean

Allow user to save document to the Dokobit Portal and make further actions. Default: 'true'.

Allowed Signing Methods
allowed_signing_methods array of string

Allow only specific signing methods. Available values: 'mobile', 'smartid', 'smartcard', 'eparaksts_mobile', 'bankid_no', 'bankid_se', 'audkenni_app', 'ftn', 'mitid', 'nemid', 'electronic_id', 'itsme', 'idin', 'swisscom'.

Returns

Name Path Type Description
Status
status string

Status.

Update Internal Signing

Allows to update attributes of an existing document signing.

Parameters

Name Key Required Type Description
Signing Token
token True string

Signing token.

Require Qualified Signatures
require_qualified_signatures boolean

Allow to sign only with qualified signatures. Default: 'false'.

Allow Video Identification
allow_video_identification boolean

Allow to sign using video-based identification. Default: 'false'.

Allowed Signing Methods
allowed_signing_methods array of string

Allow only specific signing methods. Available values: 'mobile', 'smartid', 'smartcard', 'eparaksts_mobile', 'bankid_no', 'bankid_se', 'audkenni_app', 'ftn', 'mitid', 'nemid', 'electronic_id', 'itsme', 'idin', 'swisscom'.

Returns

Name Path Type Description
Status
status string

Status.

Validation

Dokobit is an eIDAS-certified service provider for qualified e-signature and e-seal validations. Use this action to upload a signed file for validation. Supported file types: 'asice', 'asics', 'sce', 'bdoc', 'edoc', 'pdf', 'p7s', 'xml'.

Parameters

Name Key Required Type Description
Name
name True string

File name.

Content
content True string

Base64 encoded file content.

Returns

Name Path Type Description
Upload Status
status string

Upload status.

Validation Token
token string

Validation token.

Validation - Detailed PDF Report

Download detailed validation report in PDF.

Parameters

Name Key Required Type Description
Validation Token
token True string

Validation token received from DokobitUniversalAPIValidation action.

Returns

response
object

Validation - PDF Report

Download validation report in PDF.

Parameters

Name Key Required Type Description
Validation Token
token True string

Validation token received from DokobitUniversalAPIValidation action.

Returns

response
object

Validation - XML Diagnostic Data

Download diagnostic data in XML.

Parameters

Name Key Required Type Description
Validation Token
token True string

Validation token received from DokobitUniversalAPIValidation action.

Returns

response
object

Validation - XML Report

Download validation report in XML.

Parameters

Name Key Required Type Description
Validation Token
token True string

Validation token received from DokobitUniversalAPIValidation action.

Returns

response
object

Definitions

object

This is the type 'object'.