Dokobit ユニバーサル API

Dokobit Universal API は、システム内で内部的にドキュメントに署名し、システム外のヨーロッパ全体でサード パーティから署名を収集できるようにする、汎用性の高いツールです。 ドキュメント署名は、アカウントレスの Dokobit 署名 (招待された参加者が Dokobit ポータルに登録せずにドキュメントに署名できる) で、組織のブランドとのインターフェイスで行われます。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
コピロット スタジオ	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Automate	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	Dokobit
URL	https://support.dokobit.com
Email	developers@dokobit.com

コネクタ メタデータ
Publisher	Dokobit
Web サイト	https://www.dokobit.com/solutions
プライバシー ポリシー	https://www.dokobit.com/compliance/privacy-policy
カテゴリ	生産性

Dokobit Universal API は、システム内で内部的にドキュメントに署名し、システム外のヨーロッパ全体でサード パーティから署名を収集できるようにする、汎用性の高いツールです。 ドキュメント署名は、アカウントレスの Dokobit 署名 (招待された参加者が Dokobit ポータルに登録せずにドキュメントに署名できる) で、組織のブランドとのインターフェイスで行われます。

[前提条件]

Dokobit Universal API を使用するには、 sales@dokobit.com にお問い合わせいただき、API アクセス トークンを取得してください。

資格情報を取得する方法

API アクセス トークンを取得するには、Sales にお問い合わせください

コネクタの概要

• ドキュメント署名は、'DokobitUniversalAPICreateExternalSigning' または 'DokobitUniversalAPICreateInternalSigning' アクションを使用して開始できます。 'DokobitUniversalAPICreateExternalSigning' を使用すると、署名の招待が参加者に送信されます。 'DokobitUniversalAPICreateInternalSigning' は、ユーザーをリダイレクトできる署名 URL を生成します。
• 署名は、対応するアクションを使用して管理できます。これにより、参加者の追加/削除、リマインダーの送信、ドキュメント署名の状態の確認を行うことができます。
• 参加者がドキュメントに署名した後、'DokobitUniversalAPIDownloadDocumentExternal' または 'DokobitUniversalAPIDownloadDocumentInternal' アクションを使用してダウンロードできます。

既知の問題と制限事項

現在の実装では、PDF ファイルでの署名収集がサポートされ、ASiCe、ADoc、BDoc、または EDoc コンテナーでサポートされています。

一般的なエラーと解決方法

• ファイルは、Base64 でエンコードされたファイル コンテンツとして提供する必要があります。
• ドキュメント署名 'Type' が 'pdf' に設定されている場合、ドキュメント署名の開始時に 1 つの PDF ドキュメントが受け入れられます。 複数のファイルの場合は、署名 'Type' を 'asice' または別のコンテナー形式に設定します。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前	タイプ	Description	必須
API キー	securestring	この API の API キー	正しい

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

e-Delivery	ドキュメント e-Delivery は、Dokobit Universal API を使用してドキュメントを安全に共有するために使用されます。
Validation	Dokobit は、認定された電子署名と電子シールの検証のための eIDAS 認定サービス プロバイダーです。 検証のために署名されたファイルをアップロードするには、このアクションを使用します。 サポートされているファイルの種類: asice、 asics、 sce、 bdoc、 edoc、 pdf、 p7s、 xml。
ドキュメントの内部ダウンロード	署名されたドキュメントをダウンロードします。
ドキュメント外部のダウンロード	署名されたドキュメントをダウンロードします。
リマインダーの送信	ユーザーがまだドキュメントに署名していない場合にのみ、参加者にリマインダー電子メールを送信できます。 外部署名フローでのみ機能します。
内部署名の作成	内部署名は、システムからの署名要求を開始します。 この場合、署名 URL が生成され、参加者をリダイレクトする必要があります。
内部署名の削除	ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。
内部署名の更新	既存のドキュメント署名の属性を更新できます。
内部署名の状態を確認する	署名状態のドキュメントの情報を返します。
内部署名者の削除	ドキュメントへのアクセスは、指定された参加者に対して取り消されます。
内部署名者の追加	指定された参加者は、選択したロールを持つドキュメントにアクセスできます。
印鑑署名	文書は組織の電子シールで封印されます。 電子シールの認定証明書を取得するには、 developers@dokobit.com のサポートにお問い合わせください。
外部署名の作成	外部署名は、システムからの非同期署名要求を開始します。 この場合、ユーザーは署名用の電子メールを受け取り、ドキュメントに署名するとコールバックを受け取ります。
外部署名の削除	ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。
外部署名の更新	既存のドキュメント署名の属性を更新できます。
外部署名の状態を確認する	署名状態のドキュメントの情報を返します。
外部署名者の削除	ドキュメントへのアクセスは、指定された参加者に対して取り消されます。
外部署名者の追加	指定された参加者は、選択したロールを持つドキュメントにアクセスできます。
検証 - PDF レポート	PDF で検証レポートをダウンロードします。
検証 - XML レポート	XML で検証レポートをダウンロードします。
検証 - XML 診断データ	XML で診断データをダウンロードします。
検証 - 詳細 PDF レポート	詳細な検証レポートを PDF でダウンロードします。

e-Delivery

操作 ID:

DokobitUniversalAPIeDelivery

ドキュメント e-Delivery は、Dokobit Universal API を使用してドキュメントを安全に共有するために使用されます。

パラメーター

名前	キー	必須	型	説明
タイプ	type	True	string	ドキュメント形式。 使用可能な値: pdf。
名前	name	True	string	ユーザーのドキュメント名が表示されます。
ポストバック URL	postback_url		string	Webhook を処理するシステムの URL。
コメント	comment		string	受信者向けのメッセージ。
名前	name	True	string	ファイル名。
Content	content	True	string	Base64 でエンコードされたファイルの内容。
外部 ID	external_id	True	string	システムからの参加者の一意のランダム識別子。 一意のランダム識別子がない場合は、生成できます。
Code	code	True	string	受信者の個人コード (国民 ID 番号)。
国番号	country_code	True	string	受信者の国コード。 個人コードが指定されている場合は必須。 使用可能な値: lt、 lv、 ee、 is。
電子メール	email		string	ドキュメントを送信するための受信者の電子メール。 電話が設定されていない場合は必須。
電話	phone		string	ドキュメント SMS を送信するための受信者の電話番号。 電子メールが設定されていない場合は必須。 SMS は、電子メールが提供されていない場合にのみ送信されます。
通知言語	notifications_language		string	通知の言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、'fr'、'se'、'de'。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。
ドキュメント トークン	token	string	ドキュメント トークン。
受取人	recipients	array of object	受信者の情報。
外部 ID	recipients.external_id	string	システムからの参加者の一意のランダム識別子。
トークン	recipients.token	string	受信者のトークン。
Code	recipients.code	string	受信者の個人コード (国民 ID 番号)。
Country	recipients.country	string	受信者の国。
電子メール	recipients.email	string	受信者の電子メール。

Validation

操作 ID:

DokobitUniversalAPIValidation

Dokobit は、認定された電子署名と電子シールの検証のための eIDAS 認定サービス プロバイダーです。 検証のために署名されたファイルをアップロードするには、このアクションを使用します。 サポートされているファイルの種類: asice、 asics、 sce、 bdoc、 edoc、 pdf、 p7s、 xml。

パラメーター

名前	キー	必須	型	説明
名前	name	True	string	ファイル名。
Content	content	True	string	Base64 でエンコードされたファイルの内容。

戻り値

名前	パス	型	説明
アップロードの状態	status	string	アップロードの状態。
検証トークン	token	string	検証トークン。

ドキュメントの内部ダウンロード

操作 ID:

DokobitUniversalAPIDownloadDocumentInternal

署名されたドキュメントをダウンロードします。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

response

object

ドキュメント外部のダウンロード

操作 ID:

DokobitUniversalAPIDownloadDocumentExternal

署名されたドキュメントをダウンロードします。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

response

object

リマインダーの送信

操作 ID:

DokobitUniversalAPIReminder

ユーザーがまだドキュメントに署名していない場合にのみ、参加者にリマインダー電子メールを送信できます。 外部署名フローでのみ機能します。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
署名者トークン	signer	True	string	参加者のトークン。
メッセージ	message		string	署名者へのリマインダー メッセージ。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

内部署名の作成

操作 ID:

DokobitUniversalAPICreateInternalSigning

内部署名は、システムからの署名要求を開始します。 この場合、署名 URL が生成され、参加者をリダイレクトする必要があります。

パラメーター

名前	キー	必須	型	説明
タイプ	type	True	string	ドキュメント形式。 使用可能な値: pdf、 asice、 bdoc、 edoc、 adoc、 adoc.cedoc。
名前	name	True	string	ユーザーの署名名が表示されます。
リダイレクト URI	redirect_uri	True	string	署名が完了した後に署名者をリダイレクトするために使用されるリダイレクト URI。
ポストバック URL	postback_url		string	Webhook を処理するシステムの URL。
修飾された署名が必要	require_qualified_signatures		boolean	修飾された署名のみを使用して署名することを許可します。 既定値: false。
注釈の位置	annotation_position		string	PDF ドキュメント上の署名注釈の位置を選択できます。 使用可能な値: first_top、 first_bottom、 last_top、 last_bottom、 none。 既定値: first_top。
注釈の個人用コード	annotation_personal_code		boolean	個人コード true 設定すると、注釈に表示されます。 PDF の種類の署名にのみ適用されます。 既定値: false。
ビデオ識別を許可する	allow_video_identification		boolean	ビデオベースの識別を使用して署名することを許可します。 既定値: false。
PDF のフラット化	flatten_pdf		boolean	true に設定すると、フォーム フィールドがドキュメント コンテンツの一部になり、署名後に編集できないように、ドキュメントがフラット化されます。 PDF の種類の署名にのみ適用されます。 既定値: false。
許可される署名方法	allowed_signing_methods		array of string	特定の署名方法のみを許可します。 使用可能な値: mobile、 smartid、 smartcard、 eparaksts_mobile、 bankid_no、 bankid_se、 audkenni_app、 ftn、 mitid、 electronic_id、 itsme、 idin、 swisscom、 sms_otp。
名前	name	True	string	ファイル名。
Content	content	True	string	Base64 でエンコードされたファイルの内容。
外部 ID	external_id	True	string	システムからの参加者の一意のランダム識別子。 一意のランダム識別子がない場合は、生成できます。
Role	role		string	参加者の役割。 使用可能な値: signer、 viewer。 既定値: signer。
Code	code		string	参加者のコード。
国コード	country_code		string	参加者の国番号。 個人コードが指定されている場合は必須。 使用可能な値: LT、 LV、 EE、 IS、 NO、 PL、 FI、 BE、 SE。
電話	phone		string	参加者の電話。
通知言語	language		string	ユーザー インターフェイス言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、 fr、 se、 de、 fi、 dk、 nl。
ページ	page		string	表示可能な PDF 署名注釈のページ インデックス。 PDF の種類の署名にのみ適用されます。 既定値: 1。
上からの位置	top		string	表示されている PDF 署名注釈の上からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
左からの位置	left		string	表示されている PDF 署名注釈の左からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
Language	language		string	表示されている PDF 署名注釈の言語。 PDF の種類の署名にのみ適用されます。 使用可能な値: en、 lt、 lv、 et、 is
カスタム理由	custom_reason		string	カスタム署名の理由。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。
署名トークン	token	string	署名トークン。
署名	signers	array of object	参加者の情報。
外部 ID	signers.external_id	string	システムからの参加者の一意のランダム識別子。
トークン	signers.token	string	参加者のトークン。
リダイレクト URI	signers.redirect_uri	string	署名する URL。

内部署名の削除

操作 ID:

DokobitUniversalAPIDeleteInternalSigning

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

内部署名の更新

操作 ID:

DokobitUniversalAPIUpdateInternalSigning

既存のドキュメント署名の属性を更新できます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
修飾された署名が必要	require_qualified_signatures		boolean	修飾された署名のみを使用して署名することを許可します。 既定値: false。
ビデオ識別を許可する	allow_video_identification		boolean	ビデオベースの識別を使用して署名することを許可します。 既定値: false。
許可される署名方法	allowed_signing_methods		array of string	特定の署名方法のみを許可します。 使用可能な値: mobile、 smartid、 smartcard、 eparaksts_mobile、 bankid_no、 bankid_se、 audkenni_app、 ftn、 mitid、 electronic_id、 itsme、 idin、 swisscom、 sms_otp。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

内部署名の状態を確認する

操作 ID:

DokobitUniversalAPICheckInternalSigningStatus

署名状態のドキュメントの情報を返します。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

名前	パス	型	説明
署名の状態	status	string	ドキュメント署名の状態。
名前	name	string	ユーザーの署名名が表示されます。
タイプ	type	string	ドキュメントの種類。
作成日	date_created	string	ドキュメント署名が開始された日付。
期限	deadline	date-time	指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z。
ファイル名	filename	string	ファイルの名前。
Files	files	array of object
名前	files.name	string	ファイル名。
URL のダウンロード	files.url	string	ファイルのダウンロード URL。
MIME の種類	files.mime_type	string	ファイル MIME の種類。
署名	signers	array of object	参加者情報。
トークン	signers.token	string	参加者のトークン。
名前	signers.first_name	string	参加者の名前。
Surname	signers.last_name	string	参加者の姓。
Code	signers.code	string	参加者のコード。
Country	signers.country	string	参加者の国。
電子メール	signers.email	string	参加者の電子メール。
タイプ	signers.type	string	Type。
ステータス	signers.status	string	参加者の状態。

内部署名者の削除

操作 ID:

DokobitUniversalAPIDeleteInternalSigner

ドキュメントへのアクセスは、指定された参加者に対して取り消されます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
トークン	token	True	string	参加者のトークン。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

内部署名者の追加

操作 ID:

DokobitUniversalAPIAddInternalSigner

指定された参加者は、選択したロールを持つドキュメントにアクセスできます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
外部 ID	external_id	True	string	システムからの参加者の一意のランダム識別子。 一意のランダム識別子がない場合は、生成できます。
Role	role		string	参加者の役割。 使用可能な値: signer、 viewer。 既定値: signer。
Code	code		string	参加者のコード。
国コード	country_code		string	参加者の国番号。 個人コードが指定されている場合は必須。 使用可能な値: LT、 LV、 EE、 IS、 NO、 PL、 FI、 BE、 SE。
電話	phone		string	参加者の電話。
通知言語	language		string	ユーザー インターフェイス言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、 fr、 se、 de、 fi、 dk、 nl。
ページ	page		string	表示可能な PDF 署名注釈のページ インデックス。 PDF の種類の署名にのみ適用されます。 既定値: 1。
上からの位置	top		string	表示されている PDF 署名注釈の上からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
左からの位置	left		string	表示されている PDF 署名注釈の左からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
Language	language		string	表示されている PDF 署名注釈の言語。 PDF の種類の署名にのみ適用されます。 使用可能な値: en、 lt、 lv、 et、 is
カスタム理由	custom_reason		string	カスタム署名の理由。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。
署名	signers	array of object	参加者の情報。
外部 ID	signers.external_id	string	システムからの参加者の一意のランダム識別子。
トークン	signers.token	string	参加者のトークン。
名前	signers.name	string	参加者の名前。
Surname	signers.surname	string	参加者の姓。
電子メール	signers.email	string	参加者の電子メール。
Code	signers.code	string	参加者の個人コード (国民 ID 番号)。
国番号	signers.country_code	string	参加者の国。
Role	signers.role	string	参加者の役割。
[会社]	signers.company	string	参加者の会社。
位置	signers.position	string	参加者の位置。
電話	signers.phone	string	参加者の電話。

印鑑署名

操作 ID:

DokobitUniversalAPISealSigning

文書は組織の電子シールで封印されます。 電子シールの認定証明書を取得するには、 developers@dokobit.com のサポートにお問い合わせください。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
カスタム理由	custom_reason		string	カスタム署名の理由。
ページ	page		string	表示可能な PDF 署名注釈のページ インデックス。 PDF の種類の署名にのみ適用されます。 既定値: 1。
上からの位置	top		string	表示されている PDF 署名注釈の上からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
左からの位置	left		string	表示されている PDF 署名注釈の左からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

外部署名の作成

操作 ID:

DokobitUniversalAPICreateExternalSigning

外部署名は、システムからの非同期署名要求を開始します。 この場合、ユーザーは署名用の電子メールを受け取り、ドキュメントに署名するとコールバックを受け取ります。

パラメーター

名前	キー	必須	型	説明
タイプ	type	True	string	ドキュメント形式。 使用可能な値: pdf、 asice、 bdoc、 edoc、 adoc、 adoc.cedoc。
名前	name	True	string	ユーザーの署名名が表示されます。
ポストバック URL	postback_url		string	Webhook を処理するシステムの URL。
期限	deadline		date-time	指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z。
ハード期限	hard_deadline		boolean	trueに設定すると、参加者はdeadline設定した後にこのドキュメントに署名できなくなります。 既定値: false。
修飾された署名が必要	require_qualified_signatures		boolean	修飾された署名のみを使用して署名することを許可します。 既定値: false。
注釈の位置	annotation_position		string	PDF ドキュメント上の署名注釈の位置を選択できます。 使用可能な値: first_top、 first_bottom、 last_top、 last_bottom、 none。 既定値: first_top。
注釈の個人用コード	annotation_personal_code		boolean	個人コード true 設定すると、注釈に表示されます。 PDF の種類の署名にのみ適用されます。 既定値: false。
コメント	comment		string	参加者向けのメッセージ。
ビデオ識別を許可する	allow_video_identification		boolean	ビデオベースの識別を使用して署名することを許可します。 既定値: false。
ドキュメントの保存を許可する	allow_document_saving		boolean	ユーザーがドキュメントを Dokobit ポータルに保存し、さらにアクションを実行できるようにします。 既定値: true。
PDF のフラット化	flatten_pdf		boolean	true に設定すると、フォーム フィールドがドキュメント コンテンツの一部になり、署名後に編集できないように、ドキュメントがフラット化されます。 PDF の種類の署名にのみ適用されます。 既定値: false。
許可される署名方法	allowed_signing_methods		array of string	特定の署名方法のみを許可します。 使用可能な値: mobile、 smartid、 smartcard、 eparaksts_mobile、 bankid_no、 bankid_se、 audkenni_app、 ftn、 mitid、 electronic_id、 itsme、 idin、 swisscom、 sms_otp。
名前	name	True	string	ファイル名。
Content	content	True	string	Base64 でエンコードされたファイルの内容。
外部 ID	external_id	True	string	システムからの参加者の一意のランダム識別子。 一意のランダム識別子がない場合は、生成できます。
名前	name		string	参加者の名前。
Surname	surname		string	参加者の姓。
電子メール	email		string	参加者の電子メール。
Code	code		string	参加者の個人コード (国民 ID 番号)。
国番号	country_code		string	参加者の国番号。 個人コードが指定されている場合は必須。 使用可能な値: LT、 LV、 EE、 IS、 NO、 FI、 BE、 SE。
Role	role		string	参加者の役割。 使用可能な値: signer、 viewer。 既定値: signer。
[会社]	company		string	参加者の会社名。
位置	position		string	参加者の位置。
電話	phone		string	参加者の電話番号。
Sequence	sequence		integer	ドキュメント承認アクションと署名アクションの順序を設定できます。
通知言語	notifications_language		string	通知の言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、 fr、 se、 de、 fi、 dk、 nl。
カスタム理由	custom_reason		string	カスタム署名の理由。
ページ	page		string	表示可能な PDF 署名注釈のページ インデックス。 PDF の種類の署名にのみ適用されます。 既定値: 1。
上からの位置	top		string	表示されている PDF 署名注釈の上からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
左からの位置	left		string	表示されている PDF 署名注釈の左からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
Language	language		string	表示されている PDF 署名注釈の言語。 PDF の種類の署名にのみ適用されます。 使用可能な値: en、 lt、 lv、 et、 is

戻り値

名前	パス	型	説明
ステータス	status	string	状態。
署名トークン	token	string	署名トークン。
署名	signers	array of object	参加者の情報。
外部 ID	signers.external_id	string	システムからの参加者の一意のランダム識別子。
トークン	signers.token	string	参加者のトークン。
名前	signers.first_name	string	参加者の名前。
Surname	signers.last_name	string	参加者の姓。
Code	signers.code	string	参加者の個人コード (国民 ID 番号)。
Country	signers.country	string	参加者の国。
電子メール	signers.email	string	参加者の電子メール。

外部署名の削除

操作 ID:

DokobitUniversalAPIDeleteExternalSigning

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

外部署名の更新

操作 ID:

DokobitUniversalAPIUpdateExternalSigning

既存のドキュメント署名の属性を更新できます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
期限	deadline		date-time	指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z。
ハード期限	hard_deadline		boolean	trueに設定されている場合、参加者はdeadline設定した後にこのドキュメントに署名または承認できなくなります。 既定値: false。
修飾された署名が必要	require_qualified_signatures		boolean	修飾された署名のみを使用して署名することを許可します。 既定値: false。
ビデオ識別を許可する	allow_video_identification		boolean	ビデオベースの識別を使用して署名することを許可します。 既定値: false。
ドキュメントの保存を許可する	allow_document_saving		boolean	ユーザーがドキュメントを Dokobit ポータルに保存し、さらにアクションを実行できるようにします。 既定値: true。
許可される署名方法	allowed_signing_methods		array of string	特定の署名方法のみを許可します。 使用可能な値: mobile、 smartid、 smartcard、 eparaksts_mobile、 bankid_no、 bankid_se、 audkenni_app、 ftn、 mitid、 electronic_id、 itsme、 idin、 swisscom、 sms_otp。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

外部署名の状態を確認する

操作 ID:

DokobitUniversalAPICheckExternalSigningStatus

署名状態のドキュメントの情報を返します。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。

戻り値

名前	パス	型	説明
署名の状態	status	string	ドキュメント署名の状態。
名前	name	string	ユーザーの署名名が表示されます。
タイプ	type	string	ドキュメントの種類。
作成日	date_created	string	ドキュメント署名が開始された日付。
期限	deadline	date-time	指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z。
ファイル名	filename	string	ファイルの名前。
Files	files	array of object
名前	files.name	string	ファイル名。
URL のダウンロード	files.url	string	ファイルのダウンロード URL。
MIME の種類	files.mime_type	string	ファイル MIME の種類。
署名	signers	array of object	参加者情報。
トークン	signers.token	string	参加者のトークン。
名前	signers.first_name	string	参加者の名前。
Surname	signers.last_name	string	参加者の姓。
Code	signers.code	string	参加者のコード。
Country	signers.country	string	参加者の国。
電子メール	signers.email	string	参加者の電子メール。
タイプ	signers.type	string	Type。
ステータス	signers.status	string	参加者の状態。

外部署名者の削除

操作 ID:

DokobitUniversalAPIDeleteExternalSigner

ドキュメントへのアクセスは、指定された参加者に対して取り消されます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
トークン	token	True	string	参加者のトークン。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。

外部署名者の追加

操作 ID:

DokobitUniversalAPIAddExternalSigner

指定された参加者は、選択したロールを持つドキュメントにアクセスできます。

パラメーター

名前	キー	必須	型	説明
署名トークン	token	True	string	署名トークン。
外部 ID	external_id	True	string	システムからの参加者の一意のランダム識別子。 一意のランダム識別子がない場合は、生成できます。
名前	name		string	参加者の名前。
Surname	surname		string	参加者の姓。
電子メール	email		string	参加者の電子メール。
Code	code		string	参加者のコード。
国コード	country_code		string	参加者の国番号。 個人コードが指定されている場合は必須。 使用可能な値: LT、 LV、 EE、 IS、 NO、 FI、 BE、 SE。
Role	role		string	参加者の役割。 使用可能な値: signer、 viewer。 既定値: signer。
[会社]	company		string	参加者の会社。
位置	position		string	参加者の位置。
電話	phone		string	参加者の電話。
カスタム理由	custom_reason		string	カスタム署名の理由。
通知言語	notifications_language		string	通知の言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、 fr、 se、 de、 fi、 dk、 nl。
ページ	page		string	表示可能な PDF 署名注釈のページ インデックス。 PDF の種類の署名にのみ適用されます。 既定値: 1。
上からの位置	top		string	表示されている PDF 署名注釈の上からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
左からの位置	left		string	表示されている PDF 署名注釈の左からの位置 (ポイント単位)。 PDF の種類の署名にのみ適用されます。 既定値: 1。
Language	language		string	表示されている PDF 署名注釈の言語。 PDF の種類の署名にのみ適用されます。 使用可能な値: en、 lt、 lv、 et、 is
コメント	comment		string	参加者向けのメッセージ。

戻り値

名前	パス	型	説明
ステータス	status	string	状態。
署名	signers	array of object	参加者の情報。
外部 ID	signers.external_id	string	システムからの参加者の一意のランダム識別子。
トークン	signers.token	string	参加者のトークン。
名前	signers.name	string	参加者の名前。
Surname	signers.surname	string	参加者の姓。
電子メール	signers.email	string	参加者の電子メール。
Code	signers.code	string	参加者の個人コード (国民 ID 番号)。
国番号	signers.country_code	string	参加者の国。
Role	signers.role	string	参加者の役割。
[会社]	signers.company	string	参加者の会社。
位置	signers.position	string	参加者の位置。
通知言語	signers.notifications_language	string	通知の言語を設定します。 使用可能な値: en、 lt、 lv、 et、 is、 no、'fr'、'se'、'de'。
電話	signers.phone	string	参加者の電話。

検証 - PDF レポート

操作 ID:

DokobitUniversalAPIValidationPDFReport

PDF で検証レポートをダウンロードします。

パラメーター

名前	キー	必須	型	説明
検証トークン	token	True	string	DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

response

object

検証 - XML レポート

操作 ID:

DokobitUniversalAPIValidationXMLReport

XML で検証レポートをダウンロードします。

パラメーター

名前	キー	必須	型	説明
検証トークン	token	True	string	DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

response

object

検証 - XML 診断データ

操作 ID:

DokobitUniversalAPIValidationXMLDiagnosticData

XML で診断データをダウンロードします。

パラメーター

名前	キー	必須	型	説明
検証トークン	token	True	string	DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

response

object

検証 - 詳細 PDF レポート

操作 ID:

DokobitUniversalAPIValidationDetailedPDFReport

詳細な検証レポートを PDF でダウンロードします。

パラメーター

名前	キー	必須	型	説明
検証トークン	token	True	string	DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

response

object

定義

オブジェクト

これは型 'object' です。