コネクティブ eSignatures

  • リファレンス

Connective eSignatures は、有名な電子署名ソリューションであり、膨大な量の署名方法、および非常に厳格な (国際) 規制に対するコンプライアンスを提供します。 eSignatures を使用すると、紙ベースのプロセスを、無類のユーザー エクスペリエンスを備えたエンドツーエンドの電子フローに変換できます。 署名プロセスを希望どおりに合理化し、お気に入りのビジネス アプリケーションからすべての種類のドキュメントを直接送信、署名、追跡できます。 ご使用になれば、500 以上ものお客様満足度の声を実感できます。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Connective サポート
[URL] https://connective.eu/contact-support/
メール service@connective.eu
Connector Metadata
発行者 Connective
Web サイト https://www.connective.eu
プライバシー ポリシー https://connective.eu/privacy-policy/
カテゴリ IT 操作; 生産性

デジタル署名、ID サービス、およびスマート ドキュメント生成のスペシャリストである Connective は、Power Automate 用の Connective eSignatures コネクタを使用できるようにしました。 コネクタを使用すると、企業はお気に入りの Microsoft 365 アプリケーション (Microsoft Teams から Word、SharePoint、ダイナミクス、OneDrive、およびその他多数) から直接デジタル署名が必要なドキュメントを転送できます。

コネクタの使用を開始する方法

コネクタの使用を開始するには、Connective の関係管理に連絡するか、Web サイトの連絡先ページにアクセスして資格情報を取得してください。

このページでは、利用可能な異なるアクションについて詳しく説明し、これらのアクションを実装する複数の方法についての分析情報を提供します。

詳細については、ドキュメント Web サイトを参照するか、またはサポートお問い合わせフォームまたはサポート メールボックス: service@connective.eu を通じてサポート チームにいつでもお問い合わせください

用語集を使用して、このドキュメント内で使用されているさまざまな用語を説明できます

アクション​​

Connective eSignatures コネクタは eSignatures の API v3 に基づいています。 eSignatures API は、外部アプリケーションを統合し、このドキュメントに記載されている機能を使用して署名フローを作成および管理できるようにする REST API です。

使用可能なアクションは、異なるグループにグループ化できます

アクション グループ 利用可能なアクション
ドキュメントのアップロード パッケージを作成する
パッケージにドキュメントを追加する
署名場所を取得する
プロセス情報を設定する
パッケージ状態を設定する
インスタント パッケージを作成する
ドキュメントの状態を取得する パッケージ状態を‬取得する
パッケージの一覧を取得する
その他のアクション 署名者をスキップする
パッケージをダウンロードする
パッケージ有効期限の拡張機能
パッケージ アラームを送信する
パッケージを削除する
監査証明を取得する パッケージ監査証明を取得する
ドキュメント監査証明を取得する
関連付け ID を使用してパッケージ監査証明を取得する
関連付け ID を使用してドキュメント監査証明を取得する
外部ソースから証明を追加する

接続の作成

コネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

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

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

件名 タイプ 内容 必要
Connective eSignatures 環境 URL 文字列 Connective eSignatures 環境への URL、 例: esignatures.connective.eu 真
API ユーザー名 securestring API にアクセスするための API ユーザー名 真
API パスワード securestring API にアクセスする API パスワード 真

調整制限

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

アクション

インスタント パッケージを作成する

この呼び出しにより、単一ドキュメントを伴うパッケージが作成され、署名の準備が即座に行われます
ドキュメント ID 付きのパッケージの監査証明

パッケージが完全に署名されると、パッケージの監査証明 xml を取得できます。 同じことがドキュメントにも当てはまります。これは完全に署名されたパッケージを含む場合にのみ機能します。
ドキュメント相関監査証明のダウンロード

関連付け IDは、eSignatures アプリケーションの複数のパス間でパッケージまたはドキュメントを追跡するために使用されます。
パッケージ リマインダーを送信する

会社のポリシーでは、ドキュメントの特定期間内の処理が必要になる場合があります。 “リマインダーの送信” 呼び出しをトリガーすると、署名していないすべての人が検索され、リマインダーとして追加通知が送信されます。
パッケージからドキュメントをダウンロードする

パッケージにある署名入りドキュメントは、この呼び出しを使用して外部システムでひとつずつダウンロードできます。 各ドキュメントは、DocumentType パラメータの値に応じて、PDF または XML ファイル ストリームとしてダウンロードされます。
パッケージにドキュメントを追加する

この呼び出しにより、既存のパッケージにドキュメントが追加されます。
パッケージの一覧

現在の状態を含むパッケージの一覧を取得する
パッケージの状態を‬取得する

パッケージとそのドキュメントの現在の状態を取得します。
パッケージの状態を設定する

パッケージの状態の設定呼び出しを使用して、パッケージの状態を変更できます。
パッケージの監査証明

パッケージが完全に署名されると、パッケージの監査証明 xml を取得できます。 同じことがドキュメントにも当てはまります。これは完全に署名されたパッケージを含む場合にのみ機能します。
パッケージをダウンロードする

署名されたドキュメントを含むパッケージは、この呼び出しを使用して外部システムからダウンロードできます。
パッケージを作成する

この呼び出しにより空のパッケージが作成され、ドキュメントを追加できるようになります
パッケージを削除する

eSignatures では、パッケージが最終状態に達した後は、データベースからパッケージを自動的に削除しません。 それらは無期限に保存されます。 データベースからパッケージを削除するには、ユーザーはパッケージの削除呼び出しを使用できます。
パッケージ相関監査証明のダウンロード

関連付け IDは、eSignatures アプリケーションの複数のパス間でパッケージまたはドキュメントを追跡するために使用されます。
プロセス情報を設定する

この Web サービス メソッドは、プロセスに関与するユーザー (関係者) を更新し、実行する必要のある手順を割り当てます。
外部ソースから証明を追加する

この呼び出しにより、API ユーザーは外部ソースからドキュメント上の場所に追加証明を追加できます。
期限切れのタイムスタンプ

パッケージの作成呼び出しで、パッケージが ExpiryTimestamp パラメーターの値を渡すと、パッケージの状態が期限切れになる場合があります。 そのようなパッケージは署名できなくなります。
署名場所を取得する

この呼び出しは、パッケージ内のドキュメントにあるすべての署名場所の概要を提供します。
署名者をスキップする

この呼び出しは、まだ署名していないすべての署名者をスキップし、状態を “スキップ済” に設定します。これにより、パッケージ全体が “完了” としてマークされます。

インスタント パッケージを作成する

操作 ID:
CreateInstantPackage

この呼び出しにより、単一ドキュメントを伴うパッケージが作成され、署名の準備が即座に行われます

パラメーター

名前 キー 必須 型 説明
ドキュメント
 Document byte

base64 エンコード形式の添付ドキュメント。 マルチパート形式を使用しない限り必須です。
DocumentLanguage
 DocumentLanguage string

署名テキストで使用する言語。 現在サポートされている言語: en、nl、de、fr、es。
DocumentName
 DocumentName string

eSignatures ポータルに表示されるドキュメントとパッケージの名前。
ExternalPackageData
 ExternalPackageData string

ExternalPackageData
開始元
 Initiator string

登録済ユーザーの電子メール アドレス
タイプ
 Type string

署名者 / 受信者
OrderIndex
 OrderIndex integer

この番号は、当事者がアクションを実行する必要がある順序を指定します。
PageNumber
 PageNumber integer

署名場所を追加するページの番号
幅
 Width string

幅
高さ
 Height string

高さ
← キー
 Left string

ページの左側からの位置
上詰め
 Top string

ページの上部からの位置
MarkerOrFieldId
 MarkerOrFieldId string

署名フィールド、テキスト マーカー、または textfield への一意の参照。
SigningType
 SigningType string

この当事者のセッションで使用される署名の種類。
CommitmentTypes
 CommitmentTypes array of string

コミットメント タイプの 1 つ以上の OID。 署名ポリシーが使用されている場合にのみ渡すことができます。
MandatedSignerValidation
 MandatedSignerValidation string

eID その他のスマート カード、または itsme 署名セッション中に実行する検証の種類。
MandatedSignerIds
 MandatedSignerIds array of string

現在のセッション中に署名できる eID または他のスマート カードを定義します。
SignaturePolicyId
 SignaturePolicyId string

署名の署名ポリシーの詳細。
Phonenumber
 Phonenumber string

SMS OTP を受信する電話番号。
RedirectUrl
 RedirectUrl string

署名後にエンド ユーザーがリダイレクトされる URL。
SendNotifications
 SendNotifications boolean

eSignatures では、署名を許可されているすべての人に電子メールを送信できます。
UserRoles
 UserRoles array of string

署名者のロールまたは機能。
LegalNoticeCode
 LegalNoticeCode string

法的通知
LegalNoticeText
 LegalNoticeText string

事前定義された 3 つの法的通知のいずれも適用されない場合の、カスタム法的通知テキスト。
EmailAddress
 EmailAddress string

EmailAddress
FirstName
 FirstName string

FirstName
LastName
 LastName string

LastName
BirthDate
 BirthDate string

BirthDate
言語
 Language string

言語
ExternalStakeholderReference
 ExternalStakeholderReference string

ExternalStakeholderReference
CallBackUrl
 CallBackUrl string

このパッケージのアクションが完了するたびに呼び出される REST API URL
相関 ID
 CorrelationId string

どのパッケージまたはドキュメントが関連付けがあるかを示す ID
DocumentGroupCode
 DocumentGroupCode string

ドキュメントを表示するドキュメント グループを識別する ‘コード’
ThemeCode
 ThemeCode string

パッケージに適用される必要のあるテーマ
DownloadUnsignedFiles
 DownloadUnsignedFiles boolean

このパラメーターは、署名する前にパッケージを WYSIWYS からダウンロードできるかどうかを決定します
ReassignEnabled
 ReassignEnabled boolean

このパラメーターは、WYSIWYS から別の承認者/署名者に、パッケージを再割り当てできるかどうかを決定します。
ActionUrlExpirationPeriodInDays
 ActionUrlExpirationPeriodInDays integer

このパラメーターは、アクション URL が使用しない場合に期限切れになるまでの日数を決定します。
ExpiryTimestamp
 ExpiryTimestamp string

呼び出し側のアプリケーションにより指定される参照。 このパラメーターは eSignatures ポータルでは使用されません
ExternalDocumentReference
 ExternalDocumentReference string

呼び出し側のアプリケーションにより指定された参照で、このパラメーターは eSignatures ポータルでは使用されません
ExternalPackageReference
 ExternalPackageReference string

呼び出し側のアプリケーションにより指定された参照で、このパラメーターは eSignatures ポータルでは使用されません
F2FRedirectUrl
 F2FRedirectUrl string

すべてのフィールドが ‘対面’ 署名で署名された後、またはすべてのフィールドが拒否されたときにエンド ユーザーがリダイレクトされる URL。
NotificationCallBackUrl
 NotificationCallBackUrl string

エンド ユーザーが通知を要求したときに呼び出される REST API URL。 URL が指定されていない場合、折り返しの呼び出しは実行されません
PdfErrorHandling
 PdfErrorHandling string

小さな欠陥を含む PDF の処理方法
表記
 Representation string

base64 形式の添付表現ドキュメント
RepresentationType
 RepresentationType string

表現ドキュメントの種類で、表現の入力時に存在する必要があります。 “application/pdf” のみがサポートされています。
SigningTemplateCode
 SigningTemplateCode string

ポータルで構成されたテンプレートは、必要なすべての情報を提供します
TargetType
 TargetType string

TargetType は、署名する前に PDF/A への追加変換を実行する必要があるかどうかを定義します

戻り値

名前 パス 型 説明
PackageId
 PackageId string

パッケージの一意識別子。
CreationTimestamp
 CreationTimestamp string

サーバーに応じてパッケージが作成された日時。

ドキュメント ID 付きのパッケージの監査証明

操作 ID:
PackageAuditProofDoc

パッケージが完全に署名されると、パッケージの監査証明 xml を取得できます。 同じことがドキュメントにも当てはまります。これは完全に署名されたパッケージを含む場合にのみ機能します。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 packageId True string

パッケージの一意の ID
ドキュメントの一意の ID
 documentId True string

ドキュメントの一意の ID

戻り値

本文​​
Content

ドキュメント相関監査証明のダウンロード

操作 ID:
DocumentCorrelationAuditProof

関連付け IDは、eSignatures アプリケーションの複数のパス間でパッケージまたはドキュメントを追跡するために使用されます。

パラメーター

名前 キー 必須 型 説明
関連付けの識別子。
 correlationId True string

関連付けの識別子。

戻り値

本文
Content

パッケージ リマインダーを送信する

操作 ID:
SendPackageReminders

会社のポリシーでは、ドキュメントの特定期間内の処理が必要になる場合があります。 “リマインダーの送信” 呼び出しをトリガーすると、署名していないすべての人が検索され、リマインダーとして追加通知が送信されます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 PackageId True string

パッケージの一意の ID

パッケージからドキュメントをダウンロードする

操作 ID:
DownloadDocumentFromPackage

パッケージにある署名入りドキュメントは、この呼び出しを使用して外部システムでひとつずつダウンロードできます。 各ドキュメントは、DocumentType パラメータの値に応じて、PDF または XML ファイル ストリームとしてダウンロードされます。

パラメーター

名前 キー 必須 型 説明
署名パッケージの一意の ID
 id True string

署名パッケージの一意の ID
パッケージが含むドキュメントを表す一意の ID
 documentId True string

パッケージが含むドキュメントを表す一意の ID

戻り値

応答
binary

パッケージにドキュメントを追加する

操作 ID:
AddDocumentToPackage

この呼び出しにより、既存のパッケージにドキュメントが追加されます。

パラメーター

名前 キー 必須 型 説明
パッケージの識別子。
 PackageId True string

パッケージの一意の ID
ドキュメント
 Document string

base64 エンコード形式の添付ドキュメント。
DocumentLanguage
 DocumentLanguage string

署名テキストで使用する言語。
DocumentName
 DocumentName string

eSignatures ポータルに表示されるドキュメントの名前。
PageNumber
 PageNumber integer

署名場所を追加するページの番号
幅
 Width string

幅
高さ
 Height string

高さ
← キー
 Left string

ページの左側からの位置
上詰め
 Top string

ページの上部からの位置
MarkerOrFieldId
 MarkerOrFieldId string

署名フィールド、テキスト マーカー、または textfield への一意の参照。
相関 ID
 CorrelationId string

このパッケージ内のどのドキュメントが、他のパッケージで過去に署名されたドキュメントと関連付けられているかを示す ID。
DocumentType
 DocumentType string

署名するドキュメントの種類。
ExternalDocumentReference
 ExternalDocumentReference string

呼び出し側のアプリケーションにより指定される参照。
エラーコード
 ErrorCode string

変数情報を含むエラー コード。
メッセージ
 Message string

ローカライズされていないエラー メッセージの詳細テキスト
表記
 Representation string

base64 形式の添付表現ドキュメント。 これは PDF データである必要があります。
RepresentationType
 RepresentationType string

表現ドキュメントの種類。
TargetType
 TargetType string

TargetType は、署名する前に PDF/A への追加変換を実行する必要があるかどうかを定義します。

戻り値

名前 パス 型 説明
DocumentId
 DocumentId string

ドキュメントの一意の ID
CreationTimestamp
 CreationTimestamp string

フローを作成した日時。 形式: YYYY-MM-DDThh:mm:ss+zz:zz
場所
 Locations array of object

署名の可能な場所を表します
ID
 Locations.Id string

この場所の一意の ID
Label
 Locations.Label string

検出済または指定済ラベル
PageNumber
 Locations.PageNumber integer

場所が見つかったページ。

パッケージの一覧

操作 ID:
PackageList

現在の状態を含むパッケージの一覧を取得する

パラメーター

名前 キー 必須 型 説明
どのページを返すかを知るための継続トークン / GUID。
 ContinuationToken string

どのページを返すかを知るための継続トークン / GUID。 空であるか、以前の呼び出しから返されたトークンである必要があります。
最大数量を取得または設定します。
 MaxQuantity integer

最大数量を取得または設定します。
並べ替えフィールドを取得または設定します。
 SortField string

並べ替えフィールドを取得または設定します。
並べ替えフィールドを取得または設定します。
 SortOrder string

並べ替えフィールドを取得または設定します。
作成前の日付を取得または設定します。
 CreatedBeforeDate string

作成前の日付を取得または設定します。
状態を取得または設定します。
 Status string

状態を取得または設定します。
作成後の日付を取得または設定します。
 createdAfterDate string

作成後の日付を取得または設定します。

戻り値

名前 パス 型 説明
ContinuationToken
 ContinuationToken string

ContinuationToken
MaxQuantity
 MaxQuantity integer

MaxQuantity
合計
 Total integer

合計
項目
 Items array of Package

パッケージの状態を‬取得する

操作 ID:
GetPackageStatus

パッケージとそのドキュメントの現在の状態を取得します。

パラメーター

名前 キー 必須 型 説明
署名パッケージの一意の ID
 Id True string

署名パッケージの一意の ID

戻り値

eSignatures ポータル ユーザーにファイル名として表示されるパッケージの説明。

本文​​
PackageStatus

パッケージの状態を設定する

操作 ID:
SetPackageStatus

パッケージの状態の設定呼び出しを使用して、パッケージの状態を変更できます。

パラメーター

名前 キー 必須 型 説明
署名パッケージの一意の ID
 Id True string

署名パッケージの一意の ID
ステータス
 Status string

保留中 / 取消済

戻り値

eSignatures ポータル ユーザーにファイル名として表示されるパッケージの説明。

本文​​
PackageStatus

パッケージの監査証明

操作 ID:
PackageAuditProof

パッケージが完全に署名されると、パッケージの監査証明 xml を取得できます。 同じことがドキュメントにも当てはまります。これは完全に署名されたパッケージを含む場合にのみ機能します。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 packageId True string

パッケージの一意の ID

戻り値

本文​​
Content

パッケージをダウンロードする

操作 ID:
DownloadPackage

署名されたドキュメントを含むパッケージは、この呼び出しを使用して外部システムからダウンロードできます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 id True string

パッケージの一意の ID

戻り値

応答
binary

パッケージを作成する

操作 ID:
CreatePackage

この呼び出しにより空のパッケージが作成され、ドキュメントを追加できるようになります

パラメーター

名前 キー 必須 型 説明
コンテンツ タイプ
 Content-Type True string

コンテンツ タイプ
開始元
 Initiator string

登録済みユーザーの電子メール アドレス。
PackageName
 PackageName string

eSignatures ポータルおよび zip ファイルとしてダウンロードするときに表示されるパッケージ名。
CallBackUrl
 CallBackUrl string

このパッケージのアクションが完了するたびに呼び出される REST API URL。
相関 ID
 CorrelationId string

どのパッケージが関連付けがあるかを示す ID。
DocumentGroupCode
 DocumentGroupCode string

パッケージを表示するドキュメント グループを識別する ‘コード’。
ThemeCode
 ThemeCode string

パッケージに適用される必要のあるテーマ
DownloadUnsignedFiles
 DownloadUnsignedFiles boolean

このパラメーターは、署名する前にパッケージを WYSIWYS からダウンロードできるかどうかを決定します。
ReassignEnabled
 ReassignEnabled boolean

このパラメーターは、WYSIWYS から別の承認者/署名者に、パッケージを再割り当てできるかどうかを決定します。
ActionUrlExpirationPeriodInDays
 ActionUrlExpirationPeriodInDays integer

このパラメーターは、アクション URL が使用しない場合に期限切れになるまでの日数を決定します。
ExpiryTimestamp
 ExpiryTimestamp string

このパッケージの有効期限が切れて署名できなくなった日時。
ExternalPackageReference
 ExternalPackageReference string

呼び出し側のアプリケーションにより指定される参照。 このパラメーターは eSignatures ポータルでは使用されません。
ExternalPackageData
 ExternalPackageData string

このフィールドは今後使用するために予約されています。 デビット カード署名などのサードパーティ サービスと統合するための顧客固有の拡張機能に使用できます。
F2FRedirectUrl
 F2FRedirectUrl string

すべてのフィールドが '対面' 署名で署名された後、またはすべてのフィールドが拒否されたときにエンド ユーザーがリダイレクトされる URL。
NotificationCallBackUrl
 NotificationCallBackUrl string

エンド ユーザーが通知を要求したときに呼び出される REST API URL。

戻り値

名前 パス 型 説明
PackageId
 PackageId string

パッケージの一意識別子。
CreationTimestamp
 CreationTimestamp string

サーバーに応じてパッケージが作成された日時。

パッケージを削除する

操作 ID:
DeletePackage

eSignatures では、パッケージが最終状態に達した後は、データベースからパッケージを自動的に削除しません。 それらは無期限に保存されます。 データベースからパッケージを削除するには、ユーザーはパッケージの削除呼び出しを使用できます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 id True string

パッケージの一意の ID

パッケージ相関監査証明のダウンロード

操作 ID:
PackageCorrelationAuditProof

関連付け IDは、eSignatures アプリケーションの複数のパス間でパッケージまたはドキュメントを追跡するために使用されます。

パラメーター

名前 キー 必須 型 説明
関連付けの識別子。
 correlationId True string

関連付けの識別子。

戻り値

本文​​
Content

プロセス情報を設定する

操作 ID:
SetProcessInformation

この Web サービス メソッドは、プロセスに関与するユーザー (関係者) を更新し、実行する必要のある手順を割り当てます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 id True string

パッケージの一意の ID
タイプ
 Type string

タイプ
OrderIndex
 OrderIndex string

この番号は、当事者がアクションを実行する必要がある順序を指定します。
LocationIds
 LocationIds array of string

現在のユーザーが署名を配置する必要がある場所 ID。
SigningType
 SigningType string

この当事者のセッションで使用される署名の種類。
CommitmentTypes
 CommitmentTypes array of string

コミットメント タイプの 1 つ以上の OID。 署名ポリシーが使用されている場合にのみ渡すことができます。
MandatedSignerValidation
 MandatedSignerValidation string

eID その他のスマート カード、または itsme 署名セッション中に実行する検証の種類。
MandatedSignerIds
 MandatedSignerIds array of string

現在のセッション中に署名できる eID または他のスマート カードを定義します。
SignaturePolicyId
 SignaturePolicyId string

署名の署名ポリシーの詳細。
Phonenumber
 Phonenumber string

SMS OTP を受信する電話番号。
RedirectURL
 RedirectURL string

署名または拒否した後にエンド ユーザーがリダイレクトされる URL。 リダイレクトは、署名または拒否した直後に発生します。
SendNotifications
 SendNotifications boolean

eSignatures は、署名などのアクションが必須な当事者に電子メールを送信できます
UserRoles
 UserRoles array of string

現在のユーザーが署名を配置する必要がある場所 ID。
LegalNoticeCode
 LegalNoticeCode string

3 つの値は、アプリケーションに組み込まれている 3 つの法的通知を指します。 これらは、構成インデックスで変更できます。
LegalNoticetext
 LegalNoticetext string

事前定義された 3 つの法的通知のいずれも適用されない場合の、カスタム法的通知テキスト
EmailAddress
 EmailAddress string

メール アドレス
FirstName
 FirstName string

名
言語
 Language string

この関係者の UI 言語。 現在サポートされている言語: en、nl、de、fr、es。
LastName
 LastName string

姓
BirthDate
 BirthDate string

生年月日の形式: YYYY-MM-DD
ExternalStakeholderReference
 ExternalStakeholderReference string

呼び出し側のアプリケーションにより指定される参照。 このパラメーターは eSignatures ポータルでは使用されません。

外部ソースから証明を追加する

操作 ID:
ProofExternalSource

この呼び出しにより、API ユーザーは外部ソースからドキュメント上の場所に追加証明を追加できます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意 ID
 packageId True string

パッケージの一意 ID
内容
 Content string

証明の実際のコンテンツ。
LocationId
 LocationId string

証明コンテンツが生成された署名の場所。
件名
 Name string

証明の名前。
タイプ
 Type string

コンピューターが読み取れる “種類” キー。 自由に選べます。
内容
 Description string

ユーザーが読み取れる証明の簡単な説明。
IpAddress
 IpAddress string

証明が追加された外部ソースのエンド ユーザーの IP アドレス。

期限切れのタイムスタンプ

操作 ID:
ExpiryTimeStamp

パッケージの作成呼び出しで、パッケージが ExpiryTimestamp パラメーターの値を渡すと、パッケージの状態が期限切れになる場合があります。 そのようなパッケージは署名できなくなります。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 id True string

パッケージの一意の ID
ExpiryTimestamp
 ExpiryTimestamp date-time

署名場所を取得する

操作 ID:
GetSigningLocations

この呼び出しは、パッケージ内のドキュメントにあるすべての署名場所の概要を提供します。

パラメーター

名前 キー 必須 型 説明
署名フィールドの ID
 Id True string

署名フィールドの ID

戻り値

名前 パス 型 説明
ドキュメント​
 Documents array of object
DocumentId
 Documents.DocumentId string

ドキュメントの一意の ID
ExternalDocumentReference
 Documents.ExternalDocumentReference string

識別用の外部参照。 必ず一意の値を使用してください。
場所
 Documents.Locations array of object

署名の可能な場所を表します
ID
 Documents.Locations.Id string

この場所の一意の ID。
Label
 Documents.Locations.Label string

要求パラメーターとして入力した値。
PageNumber
 Documents.Locations.PageNumber integer

署名を参照できるページの番号。

署名者をスキップする

操作 ID:
SkipSigners

この呼び出しは、まだ署名していないすべての署名者をスキップし、状態を “スキップ済” に設定します。これにより、パッケージ全体が “完了” としてマークされます。

パラメーター

名前 キー 必須 型 説明
パッケージの一意の ID
 PackageId True string

パッケージの一意の ID

定義

パッケージ

名前 パス 型 説明
ID
 Id string
PackageStatus
 PackageStatus string
ExternalPackageReference
 ExternalPackageReference string

PackageDocument

パッケージ内の各ドキュメントの詳細

名前 パス 型 説明
DocumentId
 DocumentId string

ドキュメントの一意の ID
ExternalDocumentReference
 ExternalDocumentReference string

ドキュメントをパッケージに追加という呼び出しを介して渡された、このドキュメントの外部参照を返します。
DocumentName
 DocumentName string

ドキュメントの名前
DocumentType
 DocumentType string

パッケージ内のドキュメントの種類。

PackageStatus

eSignatures ポータル ユーザーにファイル名として表示されるパッケージの説明。

名前 パス 型 説明
PackageName
 PackageName string

eSignatures ポータル ユーザーにファイル名として表示されるパッケージの説明。
CreationTimestamp
 CreationTimestamp string

サーバーに応じてパッケージが作成された日時。
開始元
 Initiator string

作成時に渡されたパッケージの開始元フィールド。
ExpiryTimestamp
 ExpiryTimestamp string

ドキュメントの有効期限が切れる UTC 形式の時刻。 null 値を指定可能。
ExternalPackageReference
 ExternalPackageReference string

作成時に渡されたパッケージの外部参照 ID を返します。
F2FSigningUrl
 F2FSigningUrl string

すべての署名セッションから一度に選択できるパッケージへのリンク。
PackageStatus
 PackageStatus string

パッケージ全体の状態:
PackageDocuments
 PackageDocuments array of PackageDocument

パッケージ内の各ドキュメントの詳細。
関係者
 Stakeholders array of object

パッケージを操作する各ユーザーの詳細。
タイプ
 Stakeholders.Type string

関係者の種類: ユーザー、PersonGroup、または ContactGroup。
PersonGroupName
 Stakeholders.PersonGroupName string

ユーザー グループの名前。 種類が要求で PersonGroup に設定されている場合にのみ返されます。
ContactGroupCode
 Stakeholders.ContactGroupCode string

連絡先グループのコード。 種類が要求で ContactGroup に設定されている場合にのみ返されます。
EmailAddress
 Stakeholders.EmailAddress string

署名者の電子メール アドレス。
ExternalStakeholderReference
 Stakeholders.ExternalStakeholderReference string

外部システムでこのユーザーを識別する外部参照。
StakeholderId
 Stakeholders.StakeholderId string

一意の ID。
当事者
 Stakeholders.Actors array of object

実行するすべての手順の詳細。
ActorId
 Stakeholders.Actors.ActorId string

アクション、関係者、およびドキュメントのこの組み合わせの一意の ID。
ActionUrl
 Stakeholders.Actors.ActionUrl string

このユーザーがパッケージを操作するために開くことができる URL。
ActionUrls
 Stakeholders.Actors.ActionUrls array of object

PersonGroup または ContactGroup のさまざまなユーザーがパッケージを操作するために開くことができる URL の配列。
EmailAddress
 Stakeholders.Actors.ActionUrls.EmailAddress string

ユーザーの電子メール アドレス。
URL
 Stakeholders.Actors.ActionUrls.Url string

このユーザーがパッケージを操作するために開くことができる URL。
ActorStatus
 Stakeholders.Actors.ActorStatus string

下書き (パッケージの状態は下書き)
タイプ
 Stakeholders.Actors.Type string

署名者 / 受信者
CompletedBy
 Stakeholders.Actors.CompletedBy string

アクションを完了したエンド ユーザーの名前。
CompletedTimestamp
 Stakeholders.Actors.CompletedTimestamp string

このアクションが完了した時点のタイムスタンプ。
理由
 Stakeholders.Actors.Reason string

パッケージの状態を最終状態に変更したユーザーにより入力されたテキストを返します (例: 拒否)。
場所
 Stakeholders.Actors.Locations array of object

署名の可能な場所を表します。
ID
 Stakeholders.Actors.Locations.Id string

この場所の一意の ID
UsedSigningType
 Stakeholders.Actors.Locations.UsedSigningType string

ドキュメントの署名に使用された署名の種類を返します。

内容

名前 パス 型 説明
アップロード
 uploads array of object
アップロード
 uploads.upload array of object
開始
 uploads.upload.start date-time
終了
 uploads.upload.end date-time
署名
 uploads.upload.signatures array of object
証明
 uploads.upload.signatures.proofs array of object
名前
 uploads.upload.signatures.proofs.proof.name string
種類
 uploads.upload.signatures.proofs.proof.type string
インデックス
 uploads.upload.signatures.proofs.proof.index boolean
ipAddress
 uploads.upload.signatures.proofs.proof.ipAddress string
locationId
 uploads.upload.signatures.locationId string
インデックス
 uploads.indexes array of object
識別子
 uploads.indexes.index.identifier boolean
コンテンツ
 uploads.indexes.index.content string
packageCorrelationId
 uploads.packageCorrelationId string
packageId
 uploads.packageId string

バイナリ

これは基本的なデータ型 [バイナリ] です。