PKIsigning (プレビュー)
PKIsigning プラットフォーム コネクタを使用して、ドキュメント署名のニーズを自動化します。 PKIsigning プラットフォームにドキュメントを送信する。招待を送信し、署名されたドキュメントを取得します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | PKIsigning のサポート |
| URL | https://pkisigning.nl/support |
| support@pkisigning.nl |
| コネクタ メタデータ | |
|---|---|
| Publisher | SBRS B.V. |
| Website | https://pkisigning.nl |
| プライバシー ポリシー | https://pkisigning.nl/privacy |
| カテゴリ | コラボレーション;生産性 |
PKIsigning を使用すると、組織は、顧客やサード パーティにドキュメントを承認、署名、および送信するプロセスを自動化、簡素化、セキュリティで保護できます。 このプラットフォームは、オランダの認定信頼されたサービス プロバイダーからのすべての eIDAS 個人署名証明書をサポートしており、ISO27001認定されています。 これにより、PKIsigningは、法務、金融、医療機関、政府にとって理想的なパートナーになります。 PKisigning と接続して、ドキュメント署名プロセスを自動化、簡素化、セキュリティ保護します。
[前提条件]
PKIsigning コネクタを使用するには、"プロフェッショナル" サブスクリプション内で PKIsigning プラットフォームのアカウントが必要です。 有料サブスクリプションの登録については 、PKIsigning にお問い合わせください 。
資格情報を取得する方法
サブスクリプションに登録すると、ユーザーは自分のアカウントをセットアップするための招待を含む電子メールを受け取ります。 登録後、そのアカウントをこのコネクタで直接使用できます。
コネクタの概要
ドキュメントの署名を開始する既定のフローは次のとおりです。
- Dossier を作成する
- ドキュメントを追加する
- アクターの追加
- ワークフローの開始
- トリガーを使用して状態の変更の通知を受け取る
- Dossier をダウンロードする
Dossiers
PKIsigning では、常に最初にドシエを作成する必要があります。 ドシエは、ドキュメントとアクターのコンテナーとして機能します。 Dossiers_Createアクションを使用してドシエを作成できます。 ドシエが作成されたら、返された PkisId を将来のアクションの参照として使用してください。
ドキュメント
ドシエが作成されたら、正しい dossierId を使用して、Documents_Add アクションを含むドキュメントを追加できます。 このアクションでは、ドキュメント ファイル自体から注意が散らされるため、他のパラメーターは必要ありません。 ドシエ内のドキュメントの数に制限はありません。 すべてのドキュメントは、追加されたすべてのアクターに対して表示およびダウンロードできます。
重要: ドキュメントには、署名の数に応じて、署名を配置する必要がある場所とアクターを示すために、1 つ以上の一意のテキスト プレースホルダーが必要です。 文書内の任意の場所に任意のテキストを指定できます。 アクターを追加するときは、プレースホルダー パラメーターを使用してプレースホルダーを定義できます。 例: signature1、signature2 など。
Actors
3 番目の手順は、ドキュメントにアクターを追加することで構成されます。 これは、正しい dossierId と documentId を使用して、Actor_Create アクションで行われます。
ワークフローの開始
ワークフローを開始し、指定された順序でドキュメントに署名またはダウンロードするための招待をすべてのアクターに効果的に送信するには、正しい dossierId でDossiers_StartWorkflowアクションを使用します。
トリガーを使用して状態の変更の通知を受け取る
署名後にドキュメントを取得するには、トリガーを使用して通知をサブスクライブします。 状態通知を受信するには、[イベント] フィールドに "status" を指定します。
Dossier をダウンロードする
トリガーに状態の更新が通知されたら、ドキュメントの状態が "完了" かどうかを確認します。 その時点で、ドシエ内のすべてのドキュメントを 1 つの zipfile でダウンロードできます。 PKIsigning プラットフォーム内の設定で audittrail を生成する必要がある場合は、これも含まれます。
既知の問題と制限事項
発行時点で問題は不明です。
一般的なエラーと解決方法
トリガーによる状態の更新なし
トリガーが状態の更新に応答しない場合は、[イベント] フィールドに値 'status' が指定されているかどうかを確認してください。
HTTP エラー 402 支払いが必要
PKIsigning プラットフォームでは、アクションを実行するためにクレジットが必要です。 アクターが追加されると、アクションが実行され、利用できるクレジットの数が不足している問題に招待されたユーザーが直面しないように、クレジットが予約されます。 多数の招待がアクターに送信されると、クレジット バンドルに予約するクレジットが残っていない可能性があります。 その時点で、HTTP 402 エラーが返されます。
この問題を解決するには、 PKIsigning のサポート でクレジット残高をトップアップするか、プラットフォーム上のごみ箱のアクターで未承認のドシアーをクリーンアップします。 未使用のクレジットが再び使用可能になります。
FAQ
当社の ナレッジベース を参照するか、またはお問い合わせください support@pkisigning.nl
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| アクター データを取得する |
特定のアクターのすべてのデータを返します。 |
| アクターの削除 |
特定のアクターを完全に削除します。 |
| アクターの更新 |
特定のアクターのデータを変更します。 |
| アクターを作成する |
新しいアクターを作成し、ドキュメントに追加します。 |
| ダウンロード要求 |
要求とその内容を .zip ファイルとしてダウンロードします。 |
| ドキュメント データを取得する |
特定のドキュメントのすべての (メタ) データを返します。 |
| ドキュメントでアクター データを取得する |
特定のドキュメントのすべてのアクターのすべてのデータを返します。 |
| ドキュメントを作成する |
新しいドキュメントを作成し、特定の要求に追加します。 |
| ドキュメントを削除する |
特定のドキュメントを完全に削除します。 |
| ドキュメントを更新する |
特定のドキュメントのデータを変更します。 |
| ユーザーのワークグループを取得する |
特定の組織の特定のユーザーのすべてのワークグループの一覧を返します。 |
| 招待を再送信する |
特定の要求に対して、現在のアクターの招待を行で再送信します。 |
| 招待を取り消す |
特定の要求に対して、現在のアクターの招待を行って取り消します。 |
| 組織のワークグループを取得する |
特定の組織のすべてのワークグループの一覧を返します。 |
| 要求によってアクター データを取得する |
特定の要求のすべてのアクターのすべてのデータを返します。 |
| 要求を作成 |
新しい要求を作成します。 |
| 要求を削除する |
特定の要求を完全に削除します。 |
| 要求を更新する |
特定の要求のデータを変更します。 |
| 要求を送信する |
ワークフローを開始し、特定の要求に対して 1 行目のアクターに招待を送信します。 |
| 要求データを取得する |
特定の要求のすべての (メタ) データを返します。 |
アクター データを取得する
特定のアクターのすべてのデータを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
アクター ID
|
actorId | True | guid |
アクターの一意の ID。 |
戻り値
- Body
- ExtendedSignerModel
アクターの削除
特定のアクターを完全に削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
アクター ID
|
actorId | True | guid |
アクターの一意の ID。 |
アクターの更新
特定のアクターのデータを変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
アクター ID
|
actorId | True | guid |
アクターの一意の ID。 |
|
アクション
|
action | True | string |
アクターが実行する必要があるアクション。 |
|
名(ファーストネーム)
|
firstname | True | string |
アクターの名。 |
|
接頭辞
|
prefix | string |
アクターのプレフィックス。 |
|
|
姓
|
lastname | True | string |
アクターの姓。 |
|
メール アドレス
|
True | string |
アクターの電子メール アドレス。 |
|
|
携帯電話番号
|
mobile | True | string |
アクターの携帯電話番号。 |
|
期限
|
deadline | True | date-time |
アクションがアクターによって実行されている必要がある日時。 |
|
Language
|
language | True | string |
招待の言語。 |
|
強力な検証を使用する
|
validateRealIdentity | True | boolean |
このアクターには、より強力な識別方法を使用します。 |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
メッセージ
|
message | string |
戻り値
- Body
- ExtendedSignerModel
アクターを作成する
新しいアクターを作成し、ドキュメントに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
アクション
|
action | True | string |
アクターが実行する必要があるアクション。 |
|
名(ファーストネーム)
|
firstname | True | string |
アクターの名。 |
|
接頭辞
|
prefix | string |
アクターのプレフィックス。 |
|
|
姓
|
lastname | True | string |
アクターの姓。 |
|
メール アドレス
|
True | string |
アクターの電子メール アドレス。 |
|
|
携帯電話番号
|
mobile | True | string |
アクターの携帯電話番号。 |
|
期限
|
deadline | True | date-time |
アクションがアクターによって実行されている必要がある日時。 |
|
Language
|
language | True | string |
招待の言語。 |
|
強力な検証を使用する
|
validateRealIdentity | True | boolean |
このアクターには、より強力な識別方法を使用します。 |
|
dossierPersonId
|
dossierPersonId | integer | ||
|
メッセージ
|
message | string | ||
|
署名フィールド
|
fieldName | string |
このアクターが署名するドキュメント内の既存の署名フィールドの名前。 |
|
|
Placeholder
|
placeholder | string |
アクターが署名を配置する必要があるドキュメント内の特定のプレースホルダーのテキスト。 |
戻り値
- Body
- ExtendedSignerModel
ダウンロード要求
要求とその内容を .zip ファイルとしてダウンロードします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
戻り値
- response
- file
ドキュメント データを取得する
特定のドキュメントのすべての (メタ) データを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
戻り値
ドキュメントの一般的なメタデータ
ドキュメントでアクター データを取得する
特定のドキュメントのすべてのアクターのすべてのデータを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
完了したアクション
|
hasActed | boolean |
アクションを持っているか完了していないアクターのみを返し、すべてのアクターを返すには空白のままにします。 |
戻り値
- response
- array of ExtendedSignerModel
ドキュメントを作成する
新しいドキュメントを作成し、特定の要求に追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
このドキュメントが属する要求の一意の ID。 |
|
File
|
file | True | file |
処理するファイル (特定のファイルの種類のみ)。 |
戻り値
ドキュメントの一般的なメタデータ
ドキュメントを削除する
特定のドキュメントを完全に削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
ドキュメントを更新する
特定のドキュメントのデータを変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
ドキュメント ID
|
documentId | True | guid |
ドキュメントの一意の ID。 |
|
ドキュメント名
|
name | string |
特定のドキュメントの名前 |
|
|
ドキュメント ファイル名
|
filename | string |
特定のドキュメントのファイル名 |
|
|
ドキュメントの種類
|
documentType | True | string |
特定のドキュメントの型。 (例: 通常の PDF、会計計算書、監査人レポートなど)。 |
戻り値
ドキュメントの一般的なメタデータ
ユーザーのワークグループを取得する
特定の組織の特定のユーザーのすべてのワークグループの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organisationId | True | guid |
組織の一意の ID。 |
|
ユーザー名
|
username | True |
ユーザーの Emailaddress |
戻り値
- response
- array of OrganisationWorkgroup
招待を再送信する
特定の要求に対して、現在のアクターの招待を行で再送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
招待を取り消す
特定の要求に対して、現在のアクターの招待を行って取り消します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
組織のワークグループを取得する
特定の組織のすべてのワークグループの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
組織 ID
|
organisationId | True | guid |
組織の一意の ID。 |
戻り値
- response
- array of OrganisationWorkgroup
要求によってアクター データを取得する
特定の要求のすべてのアクターのすべてのデータを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
要求に対してアクターが処理した
|
hasActed | boolean |
読み取り専用の値を使用して、アクターがドキュメントに対して既に動作しているかどうかを確認します。 |
戻り値
- response
- array of ExtendedSignerModel
要求を作成
新しい要求を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
要求名
|
name | True | string |
特定の要求の名前。 |
|
ワークグループ ID
|
workgroupId | guid |
ワークグループの一意の ID。 |
|
|
セキュリティクリアランスレベル
|
clearancelevel | True | integer |
特定の要求のセキュリティクリアランスのレベル。 |
|
要求の所有者
|
owner |
特定の要求の所有者であるユーザー。 |
戻り値
- Body
- RequestModel
要求を削除する
特定の要求を完全に削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
要求を更新する
特定の要求のデータを変更します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
要求名
|
name | True | string |
特定の要求の名前。 |
|
ワークグループ ID
|
workgroupId | guid |
ワークグループの一意の ID。 |
|
|
セキュリティクリアランスレベル
|
clearancelevel | True | integer |
特定の要求のセキュリティクリアランスのレベル。 |
|
要求の所有者
|
owner |
特定の要求の所有者であるユーザー。 |
戻り値
- Body
- RequestModel
要求を送信する
ワークフローを開始し、特定の要求に対して 1 行目のアクターに招待を送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
要求データを取得する
特定の要求のすべての (メタ) データを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
リクエストID
|
requestId | True | guid |
要求の一意の ID。 |
|
認証キー
|
callbackAuthenticationKey | string |
トリガーによって提供される認証キー。 |
戻り値
- Body
- RequestModel
トリガー
| 要求でイベントが発生した場合 |
statuschange にコールバックの URL を登録します。 PKIsigning プラットフォームは、この組織内の dossiers の statusupdates をこの URL に報告します。 |
要求でイベントが発生した場合
statuschange にコールバックの URL を登録します。 PKIsigning プラットフォームは、この組織内の dossiers の statusupdates をこの URL に報告します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベントの種類
|
Events | True | array of string |
このトリガーが通知される要求で発生するイベントの種類の一覧 |
|
組織 ID
|
organisationId | True | guid |
組織の一意の ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リクエストID
|
PkisId | guid |
要求の一意の ID。 |
|
要求の状態
|
DossierStatus | string |
ドシエの状態。 |
|
理由
|
Reason | string |
変更の理由。 |
|
認証キー
|
AuthenticationKey | string |
要求のメタデータを取得するヘッダー。 |
定義
ExtendedSignerModel
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名フィールド
|
fieldName | string |
このアクターが署名するドキュメント内の既存の署名フィールドの名前。 |
|
Placeholder
|
placeholder | string |
アクターが署名を配置する必要があるドキュメント内の特定のプレースホルダーのテキスト。 |
|
アクション
|
action | string |
アクターが実行する必要があるアクション。 |
|
名(ファーストネーム)
|
firstname | string |
アクターの名。 |
|
接頭辞
|
prefix | string |
アクターのプレフィックス。 |
|
姓
|
lastname | string |
アクターの姓。 |
|
メール アドレス
|
string |
アクターの電子メール アドレス。 |
|
|
携帯電話番号
|
mobile | string |
アクターの携帯電話番号。 |
|
期限
|
deadline | date-time |
アクションがアクターによって実行されている必要がある日時。 |
|
Language
|
language | string |
招待の言語。 |
|
強力な検証を使用する
|
validateRealIdentity | boolean |
このアクターには、より強力な識別方法を使用します。 |
|
dossierPersonId
|
dossierPersonId | integer | |
|
メッセージ
|
message | string | |
|
アクター ID
|
id | guid |
特定のアクターの一意の ID。 |
|
完了日
|
signingDate | date-time |
アクターがアクションを実行した日時。 |
|
完了したアクション
|
hasSigned | boolean | |
|
姓名
|
fullName | string |
アクターの名、プレフィックス、姓の組み合わせ。 |
|
状態情報
|
emailActivity | array of EmailActivity |
アクターによるアクションの実行プロセスに関する状態情報。 |
|
documentId
|
documentId | guid |
EmailActivity
アクターに送信される電子メール メッセージのメタデータ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール アクティビティ
|
event | string |
特定の要求とアクターの電子メール アクティビティ。 |
|
SMTP 情報
|
reason | string |
要求の一部として特定のアクターに送信される電子メールの SMTP 情報。 |
|
電子メールの日付
|
timestamp | date-time |
要求の一部として特定のアクターに送信された電子メールの日付。 |
|
電子メールの種類
|
pkisMessageType | string |
要求の一部として特定のアクターに送信されたメールを入力します (例: Invite、Reminder など)。 |
|
電子メール要求 ID
|
pkisInviteId | string |
要求の一部として特定のアクターに送信される電子メールの一意の ID。 |
|
メール アドレス
|
string |
要求の一部として特定のアクターに送信されたメールの電子メール アドレス。 |
SignerModel
特殊な種類のアクター
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アクション
|
action | string |
アクターが実行する必要があるアクション。 |
|
名(ファーストネーム)
|
firstname | string |
アクターの名。 |
|
接頭辞
|
prefix | string |
アクターのプレフィックス。 |
|
姓
|
lastname | string |
アクターの姓。 |
|
メール アドレス
|
string |
アクターの電子メール アドレス。 |
|
|
携帯電話番号
|
mobile | string |
アクターの携帯電話番号。 |
|
期限
|
deadline | date-time |
アクションがアクターによって実行されている必要がある日時。 |
|
Language
|
language | string |
招待の言語。 |
|
強力な検証を使用する
|
validateRealIdentity | boolean |
このアクターには、より強力な識別方法を使用します。 |
|
dossierPersonId
|
dossierPersonId | integer | |
|
メッセージ
|
message | string | |
|
署名フィールド
|
fieldName | string |
このアクターが署名するドキュメント内の既存の署名フィールドの名前。 |
|
Placeholder
|
placeholder | string |
アクターが署名を配置する必要があるドキュメント内の特定のプレースホルダーのテキスト。 |
DocumentMetaDataModel
ドキュメントの一般的なメタデータ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント名
|
name | string |
特定のドキュメントの名前。 |
|
前回のドキュメントの更新
|
lastUpdate | date-time |
特定のドキュメントの最終更新日。 |
|
ドキュメント ページの数
|
pages | integer |
特定のドキュメントのページ数。 |
|
ドキュメントの作成日
|
created | date-time |
特定のドキュメントの作成日。 |
|
ドキュメント ID
|
id | guid |
ドキュメントの一意の ID。 |
|
ドキュメントの状態
|
status | string |
特定のドキュメントの状態。 (新規、完了など)。 |
|
ドキュメントに署名が含まれている
|
signed | boolean |
特定のドキュメントに 1 つ以上の署名が既に含まれているかどうかを示します。 |
|
ドキュメント署名
|
signatures | array of SignatureData |
特定のドキュメントのすべての署名の一覧。 |
|
ドキュメントの空白の署名フィールド
|
emptySignatureFields | array of SignatureField |
特定のドキュメントのすべての空の署名フィールドの一覧。 |
|
空白の署名フィールド
|
containsBlankSignatureFields | boolean |
特定のドキュメントに空白の署名フィールドが含まれているかどうかを示します。 |
|
ドキュメント アクター
|
actors | array of ExtendedSignerModel |
特定のドキュメントのすべてのアクターの一覧。 |
|
リクエストID
|
requestId | guid |
要求の一意の ID。 |
|
要求インデックス
|
dossierIndex | integer |
特定の要求に属するすべてのドキュメントのインデックス。 |
|
documentSize
|
documentSize | integer |
特定の要求に属するドキュメントのサイズ。 |
|
documentType
|
documentType | string |
特定の要求に属するドキュメントの種類。 |
SignatureData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
証明書のサブジェクト フィールド
|
subject | array of KeyValuePairOfStringAndString |
特定の署名に使用される証明書の件名行のフィールド。 |
|
証明書発行者フィールド
|
issuer | array of KeyValuePairOfStringAndString |
特定の署名に使用される証明書の発行者行のフィールド。 |
|
署名日
|
date | date-time |
特定の署名が配置された日時。 |
|
署名の場所
|
location | string |
署名時の特定のアクターの地理的な場所。 |
|
署名の理由
|
reason | string |
署名時に特定のアクターによって提供される署名の理由。 |
|
修飾された電子署名
|
euQualified | boolean |
特定の署名が修飾 (QeS) が eIDAS 規制に準拠しているかどうかを示します。 |
|
高度な電子署名
|
advanced | boolean |
特定の署名が高度な (AeS) eIDAS 規制に準拠しているかどうかを示します。 |
|
修飾された eSeal
|
eSeal | boolean |
署名またはシールに使用される特定の証明書が、認定された eSeal 準拠 eIDAS 規制であるかどうかを示します。 |
|
アクターの IP アドレス
|
ipAddress | string |
特定のアクターの IP アドレス |
|
[署名] フィールド
|
signatureField | string |
署名されたフィールド |
|
署名イメージ
|
signatureImage | string |
アクターによって選択された特定の署名に使用されたイメージ ファイル。 |
KeyValuePairOfStringAndString
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
キー
|
key | string | |
|
value
|
value | string |
SignatureField
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
署名フィールド名
|
name | string |
特定の署名フィールドの名前 |
|
署名フィールド ページ
|
page | integer |
特定のドキュメントに対して特定の署名フィールドが配置されるページ。 |
|
署名フィールドの幅座標
|
x | double |
特定の文書に配置されたページを基準とした特定の署名フィールドの位置の幅の値。 |
|
署名フィールドの hight 座標
|
y | double |
特定のドキュメントに配置されているページを基準にした特定の署名フィールドの位置の高い値。 |
|
署名フィールド hight
|
height | double |
特定の署名フィールドの Hight 値。 |
|
署名フィールドの幅
|
width | double |
特定の署名フィールドの幅の値。 |
OrganisationWorkgroup
ドシエ内で使用されるワークグループ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ワークグループ ID
|
id | guid |
ワークグループの一意の ID |
|
ワークグループ名
|
name | string |
特定のワークグループの名前 |
RequestModel
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リクエストID
|
id | guid |
要求の一意の ID |
|
要求名
|
dossierName | string |
特定の要求の名前。 |
|
ドキュメントを要求する
|
documents | array of DocumentModel |
この要求に含まれるドキュメントの一覧。 |
|
要求の状態
|
status | string |
特定の要求の状態。 (新規、完了など)。 |
|
要求アクター
|
actors | array of ExtendedSignerModel |
特定の要求のすべてのアクターの一覧。 |
|
ドキュメント署名
|
signatures | array of SignatureData |
特定の要求のすべての署名の一覧。 |
|
要求の種類
|
dossierType | string |
特定の要求の型。 (E.g. PDF、SBR 保証など)。 |
|
キャンセルの理由
|
reasons | string |
ユーザーまたはアクターによる特定の要求の取り消しの理由。 |
|
署名者のメモ
|
signerNote | string |
符号以外のアクションを持たない 1 つ以上のアクターに注意してください。 |
|
受信者のメモ
|
recipientNote | string |
ダウンロード以外のアクションを持たない 1 つ以上のアクターに注意してください。 |
|
承認者のメモ
|
accorderNote | string |
承認要求以外のアクションを持たない 1 つ以上のアクターに注意してください。 |
|
要求の有効期限
|
expires | date-time |
特定の要求の有効期限の日付と時刻。 |
|
状態情報
|
emailActivity | array of EmailActivity |
アクターによるアクションの実行プロセスに関する状態情報。 |
|
自分の要求
|
myDossier | boolean |
特定の要求の所有者であるかどうかを示します。 |
|
ワークグループ ID
|
workgroup | guid |
ワークグループの一意の ID。 |
|
セキュリティクリアランスレベル
|
clearancelevel | integer |
特定の要求のセキュリティクリアランスのレベル。 |
DocumentModel
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
id | guid |
ドキュメントの一意の ID |
|
ドキュメント名
|
name | string |
特定のドキュメントの名前 |
|
ドキュメントの種類
|
documentType | string |
特定のドキュメントを入力します。 |
|
要求インデックス
|
dossierIndex | integer |
特定の要求に属するすべてのドキュメントのインデックス。 |
|
ドキュメントの状態
|
documentstatus | string |
特定のドキュメントの状態。 (新規、完了など)。 |
|
ドキュメント アクター
|
actors | array of SignerModel |
特定のドキュメントのすべてのアクターの一覧。 |
ファイル
これは基本的なデータ型 'file' です。