Connectors 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.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Portal-CreateSigning (Portal-CreateSigningParameterBody body) |
Portal - Create Signing |
|
Portal - Get Signing List |
|
|
Portal - Check Signing Status |
|
|
Portal - Download Document |
|
|
Portal-SigningShare (string token, Portal-SigningShareParameterBody body) |
Portal - Share signing |
|
Portal - Seal signing |
|
|
Portal-SignerDelete (string token, Portal-SignerDeleteParameterBody body) |
Portal - Delete participant from signing |
|
Portal - Delete Signing |
|
|
Portal - Delete Signing For All |
|
|
Portal - Get Categories |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Portal - Create Signing
Description: Create a PDF file for signing.
Syntax:
DokobitPortal.Portal-CreateSigning (Portal-CreateSigningParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
Portal-CreateSigningParameterBody
|
|
True |
Returns:
Type:Portal-CreateSigningResponse
Summary: Portal - Get Signing List
Description: Returns a list of all documents available to the account owner.
Syntax:
DokobitPortal.Portal-GetSigninglist ([Optional]string filter)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
filter |
string (filter) |
Filter document status. E.g completed, pending |
False |
Returns:
Type:Portal-GetSigninglistResponse
Summary: Portal - Check Signing Status
Description: Returns document's information with signing status.
Syntax:
DokobitPortal.Portal-CheckSigningStatus (string token)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
Returns:
Type:Portal-CheckSigningStatusResponse
Summary: Portal - Download Document
Description: Downloads the signed document.
Syntax:
DokobitPortal.Portal-DownloadDocument (string token)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
Returns:
Type:Portal-DownloadDocumentResponse
Summary: Portal - Share signing
Description: Indicated participants will gain access to the document with the selected role.
Syntax:
DokobitPortal.Portal-SigningShare (string token, Portal-SigningShareParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
|
|
body |
Portal-SigningShareParameterBody
|
|
True |
Returns:
Type:Portal-SigningShareResponse
Summary: Portal - Seal signing
Description: 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.
Syntax:
DokobitPortal.Portal-SealSigning (string token)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
Returns:
Type:Portal-SealSigningResponse
Summary: Portal - Delete participant from signing
Description: Access to the document will be revoked for the indicated participant. .
Syntax:
DokobitPortal.Portal-SignerDelete (string token, Portal-SignerDeleteParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
|
|
body |
Portal-SignerDeleteParameterBody
|
|
True |
Returns:
Type:Portal-SignerDeleteResponse
Summary: Portal - Delete Signing
Description: The document will be removed from the owner's account. It will remain accessible to other participants.
Syntax:
DokobitPortal.Portal-DeleteSigning (string token)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
Returns:
Type:Portal-DeleteSigningResponse
Summary: Portal - Delete Signing For All
Description: The document will be removed from the owner's account and from other participants' who haven't signed the document yet.
Syntax:
DokobitPortal.Portal-DeleteSigningForAll (string token)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
token |
string (token) |
Token |
True |
Returns:
Type:Portal-DeleteSigningForAllResponse
Summary: Portal - Get Categories
Description: Returns a list of categories available for the integration.
Syntax:
DokobitPortal.Portal-GetCategories ()
Returns:
Type:array of (Portal-GetCategoriesResponseItem)
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
name |
string
|
name |
|
deadline |
string(date-time)
|
Example: 2019-11-25T13:15:30Z |
|
filename |
string
|
name of the file |
|
signed_file |
|
signed_file |
|
signers |
array of (SignersItem)
|
signers |
Summary:
Description: signed_file
Properties:
|
Name |
Type |
Summary |
|
url |
string
|
url |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
signer.token |
|
first_name |
string
|
first_name |
|
last_name |
string
|
last_name |
|
code |
string
|
code |
|
country |
string
|
country |
|
|
string
|
|
|
type |
string
|
type |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
type |
string
|
type Values: [pdf, asic] |
|
postback_url |
string
|
postback_url |
|
deadline |
string(date-time)
|
Example: 2019-11-25T13:15:30Z |
|
require_qualified_signatures |
boolean
|
Require qualified signatures Values: [, ] |
|
require_account |
boolean
|
Require user to have Dokobit acccount before signing. Values: [, ] |
|
files |
array of (FilesItem)
|
files |
|
signers |
array of (SignersItem)
|
signers |
|
categories |
array of (CategoriesItem)
|
categories |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
content |
string
|
content |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
surname |
string
|
surname |
|
|
string
|
|
|
code |
string
|
code |
|
country_code |
string
|
country_code |
|
role |
string
|
role Values: [approver, signer, viewer] |
|
company |
string
|
company |
|
position |
string
|
position |
|
phone |
string
|
phone |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
category |
string
|
category |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
token |
string
|
token |
|
signers |
array of (SignersItem)
|
signers |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
token |
|
first_name |
string
|
first_name |
|
last_name |
string
|
last_name |
|
code |
string
|
code |
|
country |
string
|
country |
|
|
string
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
token |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
signings |
array of (SigningsItem)
|
signings |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
token |
|
status |
string
|
Signing Status |
|
document_number |
string
|
document_number |
|
last_signature_date |
string
|
last_signature_date |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
signers |
array of (SignersItem)
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
token |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
signers |
array of (SignersItem)
|
signers |
|
comment |
string
|
comment |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
string
|
name |
|
surname |
string
|
surname |
|
|
string
|
|
|
code |
string
|
code |
|
country_code |
string
|
country_code |
|
role |
string
|
role Values: [approver, signer, viewer] |
|
company |
string
|
company |
|
position |
string
|
position |
|
phone |
string
|
phone |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
status |
string
|
status |
|
signers |
array of (SignersItem)
|
signers |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
token |
string
|
token |
|
name |
string
|
name |
|
surname |
string
|
surname |
|
|
string
|
|
|
code |
string
|
code |
|
country_code |
string
|
country_code |
|
role |
string
|
role Values: [approver, signer, viewer] |
|
company |
string
|
company |
|
position |
string
|
position |
|
phone |
string
|
phone |