Udostępnij za pośrednictwem

Dokobit Portal

  • Reference

Use Dokobit portal with all the features that it has but make it automated so that you don't have to waste your time on the administrative job. Put together an automated document signing process puzzle from only the parts you need: signing, sharing, downloading or deleting documents, removing and replacing signers, getting details about signers and signature information.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Premium All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
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

Use Dokobit portal with all the features that it has but make it automated so that you don't have to waste your time on the administrative job. Put together an automated document signing process puzzle from only the parts you need: signing, sharing, downloading or deleting documents, removing or replacing signers, getting details about signers, and signature information.

Prerequisites

Dokobit Portal Flow connector requires a valid Portal API access token.

How to get credentials?

  • Contact our Sales to get the API access token.

Known issues and limitations

The current implementation supports signature gathering on PDF files or any type of file in ASiCe containers only. Already formed ADoc containers are also supported.

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

Portal - Check Signing Status

Returns document's information with signing status.
Portal - Create Signing

Create a PDF, ASIC or ADOC file for signing.
Portal - Delete participant from signing

Access to the document will be revoked for the indicated participant.
Portal - Delete Signing

The document will be removed from the owner's account. It will remain accessible to other participants.
Portal - Delete Signing For All

The document will be removed from the owner's account and from other participants' who haven't signed the document yet.
Portal - Download Document

Downloads the signed document.
Portal - Get Signing List

Returns a list of all documents available to the account owner.
Portal - 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.
Portal - Send Reminder

Allows to send a reminder e-mail for participant, only if person has not signed document yet.
Portal - Share signing

Indicated participants will gain access to the document with the selected role.
Portal - Update Signing

Allows to update attributes of an existing document signing.
Portal - 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 - application/vnd.etsi.asic-e+zip|.asics - application/vnd.etsi.asic-s+zip|.sce - application/vnd.etsi.asic-e+zip|.bdoc - application/vnd.etsi.asic-e+zip|.edoc - application/vnd.etsi.asic-e+zip|.pdf - application/pdf|.p7s - application/pkcs7-signature|.xml - application/xml
Portal - Validation - Detailed PDF Report

Download detailed validation report in PDF.
Portal - Validation - PDF Report

Download validation report in PDF.
Portal - Validation - XML Diagnostic Data

Download diagnostic data in XML.
Portal - Validation - XML Report

Download validation report in XML.

Portal - Check Signing Status

Operation ID:
Portal-CheckSigningStatus

Returns document's information with signing status.

Parameters

Name Key Required Type Description
token
 token True string

Signing token

Returns

Name Path Type Description
status
 status string

Signing status
name
 name string

Signing name
deadline
 deadline date-time

Example: 2019-11-25T13:15:30Z
filename
 filename string

Name of the file
url
 signed_file.url string

Signed file url
signers
 signers array of object

Participant information
token
 signers.token string

Participant's token
first_name
 signers.first_name string

Participant's first name
last_name
 signers.last_name string

Participant's surname
code
 signers.code string

Participant's code
country
 signers.country string

Participant's country
email
 signers.email string

Participant's e-mail
type
 signers.type string

Type
status
 signers.status string

Participant's status
Template Name
 template.name string

Template name
Tempalte Token
 template.token string

Tempalte token

Portal - Create Signing

Operation ID:
Portal-CreateSigning

Create a PDF, ASIC or ADOC file for signing.

Parameters

Name Key Required Type Description
name
 name True string

Signing name
type
 type True string

Document format
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 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
annotation_position
 annotation_position string

You can choose the position of signature annotations on a PDF document. 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
require_account
 require_account boolean

Require user to have a Dokobit account before signing. Default: true
name
 name True string

File name
content
 content True string

Base64 encoded file content
name
 name string

Participant's name
surname
 surname string

Participant's surname
email
 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
custom_reason
 custom_reason string

Custom signature reason
category
 category string

Document category

Returns

Name Path Type Description
status
 status string

Signing status
token
 token string

Signing token
signers
 signers array of object

Participant's information
signer.token
 signers.token string

Participant's token
first_name
 signers.first_name string

Participant's first name
last_name
 signers.last_name string

Participant's last name
code
 signers.code string

Participant's personal code (National ID number)
country
 signers.country string

Participant's country
email
 signers.email string

Participant's e-mail

Portal - Delete participant from signing

Operation ID:
Portal-SignerDelete

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

Parameters

Name Key Required Type Description
token
 token True string

Signing token
token
 token string

Participant's token

Returns

Name Path Type Description
status
 status string

Status

Portal - Delete Signing

Operation ID:
Portal-DeleteSigning

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

Parameters

Name Key Required Type Description
token
 token True string

Signing token

Returns

Name Path Type Description
status
 status string

Status

Portal - Delete Signing For All

Operation ID:
Portal-DeleteSigningForAll

The document will be removed from the owner's account and from other participants' who haven't signed the document yet.

Parameters

Name Key Required Type Description
Token
 token True string

Signing token

Returns

Name Path Type Description
status
 status string

Status

Portal - Download Document

Operation ID:
Portal-DownloadDocument

Downloads the signed document.

Parameters

Name Key Required Type Description
token
 token True string

Signing token

Returns

response
object

Portal - Get Signing List

Operation ID:
Portal-GetSigninglist

Returns a list of all documents available to the account owner.

Parameters

Name Key Required Type Description
Filter
 filter string

Filter documents by status. Possible values: completed, pending or declined
Date From
 date_from string

Filter signings which were created on or after this date (Example: 2022-01-01)
Date To
 date_to string

Filter signings which were created on or before this date (Example: 2022-01-31)

Returns

Name Path Type Description
status
 status string

Status
signings
 signings array of object

List of signings
token
 signings.token string

Signing token
status
 signings.status string

Signing status
document_number
 signings.document_number string

Document Number
client_code
 signings.client_code string

Client Code
is_in_trash_bin
 signings.is_in_trash_bin boolean

is_in_trash_bin
last_signature_date
 signings.last_signature_date string

Last signature date

Portal - Seal signing

Operation ID:
Portal-SealSigning

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
token
 token True string

Signing token

Returns

Name Path Type Description
status
 status string

Status

Portal - Send Reminder

Operation ID:
Portal-Remind

Allows to send a reminder e-mail for participant, only if person has not signed document yet.

Parameters

Name Key Required Type Description
token
 token True string

Signing token
signer
 signer True string

Participant's token
message
 message string

Reminder message to signer

Returns

Name Path Type Description
status
 status string

Status

Portal - Share signing

Operation ID:
Portal-SigningShare

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

Parameters

Name Key Required Type Description
token
 token True string

Signing token
name
 name string

Participant's name
surname
 surname string

Participant's surname
email
 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
signer.token
 signers.token string

Participant's token
name
 signers.name string

Participant's first name
surname
 signers.surname string

Participant's last name
email
 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

Portal - Update Signing

Operation ID:
Portal-Update

Allows to update attributes of an existing document signing.

Parameters

Name Key Required Type Description
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
require_account
 require_account boolean

Require user to have a Dokobit account before signing. Default: true

Returns

Name Path Type Description
status
 status string

Status

Portal - Validation

Operation ID:
Portal-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 - application/vnd.etsi.asic-e+zip|.asics - application/vnd.etsi.asic-s+zip|.sce - application/vnd.etsi.asic-e+zip|.bdoc - application/vnd.etsi.asic-e+zip|.edoc - application/vnd.etsi.asic-e+zip|.pdf - application/pdf|.p7s - application/pkcs7-signature|.xml - application/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
status
 status string

Upload status
token
 token string

Validation token

Portal - Validation - Detailed PDF Report

Operation ID:
Portal-Validation-DetailedPDFReport

Download detailed validation report in PDF.

Parameters

Name Key Required Type Description
token
 token True string

Validation file token received from Portal-Validation action

Returns

response
object

Portal - Validation - PDF Report

Operation ID:
Portal-Validation-PDFReport

Download validation report in PDF.

Parameters

Name Key Required Type Description
token
 token True string

Validation file token received from Portal-Validation action

Returns

response
object

Portal - Validation - XML Diagnostic Data

Operation ID:
Portal-Validation-XMLDiagnosticData

Download diagnostic data in XML.

Parameters

Name Key Required Type Description
token
 token True string

Validation file token received from Portal-Validation action

Returns

response
object

Portal - Validation - XML Report

Operation ID:
Portal-Validation-XMLReport

Download validation report in XML.

Parameters

Name Key Required Type Description
token
 token True string

Validation file token received from Portal-Validation action

Returns

response
object

Definitions

object

This is the type 'object'.