次の方法で共有

Taktikal Core (プレビュー)

  • リファレンス

Taktikal Core には、署名プロセスに関する詳細情報に対して署名、封印、認証、取得を行う機能があります。

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

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)
お問い合わせ先
件名 Taktikal
[URL] https://docs.taktikal.com/
メール help@taktikal.com
Connector Metadata
発行者 Taktikal
Web サイト https://taktikal.com/
プライバシー ポリシー https://www.taktikal.com/privacy
カテゴリー 生産性

Taktikal Core API は、独自のインターフェイスで新しいソリューションを構築し、すでに運用されているソリューションと統合するための強力な方法です。

署名のためにドキュメントを独自のシステムから直接送信でき、署名後、ドキュメントと関連メタデータをドキュメント システムに自動的に送り返すことができます。 署名プロセス中のドキュメントのステータスを監視し、ID 番号またはその他の一意の識別子に基づいてステータスを呼び出すこともできます。

前提条件

Taktikal Core API を使用するには、弊社の営業チーム (sales@taktikal.is) にご連絡いただき、必要な API 認証情報を取得してください。

資格情報の入手方法

アクセスを作成し、API 認証情報を取得するには、私たちの営業チームにお問い合わせください。

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

コア API は、署名されたドキュメントを取得し、アイスランドの e-ID を使用して認証し、すべての署名プロセスを管理できます

  • 認証には、/Auth/Start を使用して認証プロセスを開始し、次に /Auth/Poll を使用して認証のステータスを確認します。
  • 単一の文書に署名するには、単一の文書に対して /management/signing を呼び出し、複数の文書の一括署名に対して /management/signing/sequential を呼び出します。
  • 署名プロセスに関する詳細なログを取得するには、/signing/activity/{ProcessKey} を呼び出します。

既知の問題と制限事項

  • リクエストには Basic 認証の Authorization ヘッダーが必要です。それが companyKe yと API-Key です
  • 現時点では、アイスランドの電子 ID を使用した署名のみが対象となります。
  • PDF は Base64 文字列を提供する必要があります。
  • 署名者は有効な電子メールと携帯電話番号を持っている必要があります。

一般的なエラーと解決策

現在、署名には PDF のみが受け入れられます。

よくあるご質問

API の詳細については、https://docs.taktikal.com 配下を参照してください

署名プロセスは 1 つの POST リクエストで開始されます。 署名プロセスを開始するには、有効な PDF ドキュメントと、ドキュメントに署名する必要がある署名者のリストが必要です。 Taktikal は、署名者への文書の表示を処理します。また、communicationdeliveryType が選択されている場合、Taktikal は、署名するリンクを含む SMS または電子メールを署名者に送信します。 参加者全員が文書に署名した後、Taktikal は登録されている関連配信パスに文書を送信します。

flowKey は Taktikal によって提供されるキーです。 このキーで、Taktikal にこのリクエストの処理方法を指示します。 一部の flowKey については、Taktikal がドキュメントの作成を処理します。 また、署名後に署名されたドキュメントがどこに配信されるかも制御します。

接続を作成する

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

既定

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

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

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

件名 タイプ Description Required
会社キー securestring この API の 会社キー True
API Key securestring この API の API キー True

調整制限

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

アクション

1 人以上の署名者による新しい署名プロセスを作成します

1 人以上の署名者による新しい署名プロセスを作成します。
PDF ドキュメントを封印する

Base64 文字列として提供された PDF ドキュメントを封印します。
processKey と signeeKey による署名プロセスを取得します

processkey と signeeKey による署名プロセスを取得します。
XML ドキュメントを封印する

Base64 文字列として提供された XML ドキュメントを封印します。
アイスランド の e-ID を使用してユーザーの認証ステータスを確認します

/Auth/Start からの応答が成功すると、AuthRequestId が返され、認証が完了したかどうかを確認するために使用されます。 認証が終了し、成功すると、LookupType に応じて顧客オブジェクトが設定されます。 検索タイプは、Icelandic National Registry で取得される情報のタイプを示します。

LookupType に応じて、次の 3 つの異なるデータセットが返されます。

  1. 名前: 認証された人の SSN と名前のみを返します。 これには追加の検索コストはかかりません。

  2. NameAddress: 名前、SSN、および住所情報を返します。 これには追加の検索コストがかかります。 LookupType の値が指定されていない場合、これが既定値になります。

  3. NameAddressFamily: 名前、SSN、住所データ、性別コード、家族情報を返します。

'LookupType.NameAddressFamily' が選択されている場合、返される追加の値は 'メタ' で返されます。

応答にエラーがあるか、完了していない場合、顧客オブジェクトは null になり、StatusMessage に詳細メッセージが含まれます。
アイスランド のe-ID を使用して認証プロセスを開始します

アイスランドの e-ID による認証は、携帯電話または Audkenni アプリで行うことができます。

  • 携帯電話の使用: AuthenticationContextType は 'Sim' に設定し、phoneNumber はアイスランドの携帯電話番号に設定する必要があります。 ssn は無視されます。
  • Audkenni アプリの使用: AuthenticationContextType を 'App' に設定し、ssn を Icdlandic 社会保障番号に設定する必要があります。 phoneNumber は無視されます。

flowKey は常に提供する必要があり、Taktikal ポータルでアクセスできます。
アイスランドの e-ID を使用して認証プロセスを開始し、シーケンシャル署名プロセスを実行します

アイスランドの e-ID による認証は、携帯電話または Audkenni アプリで行うことができます。

  • 携帯電話の使用: AuthenticationContextType は 'Sim' に設定し、phoneNumber はアイスランドの携帯電話番号に設定する必要があります。 ssn は無視されます。
  • Audkenni アプリの使用: AuthenticationContextType を 'App' に設定し、ssn を Icdlandic 社会保障番号に設定する必要があります。 phoneNumber は無視されます。
シーケンシャル署名プロセスをキャンセルする

指定されたシーケンス キーに基づいてシーケンシャル署名プロセスをキャンセルします。 シーケンシャル プロセスをキャンセルするユーザー (メールアドレス) を指定することができます。
会社のアクティビティ ログを取得します

会社のアクティビティ ログを取得します
指定された ProcessKey および SigneeKey の署名者を更新する

署名者のプロパティは、提供された ProcessKey と SigneeKey に基づいて更新できます。
新しいシーケンシャル (一括) 署名プロセスを作成する

1 つ以上の署名プロセスを含む新しいシーケンシャル (一括) 署名プロセスを作成します。 シーケンス内の各署名プロセスには 1 人以上の署名者がいます。

例:

  • ある企業がドキュメント A と B への署名を必要としているとします。 署名者 X はドキュメント A と B に署名し、署名者 Y はドキュメント A に署名し、署名者 Z はドキュメント B に署名する必要があります。
  • 次に、2 つの CreateSigningProcess オブジェクトの配列を含む新しい CreateSequentalSigning です。 署名者 X と Y はドキュメント A の CreateSigningProcess の署名者として追加され、署名者 X と Z はドキュメント B の署名者として追加されます。

詳細なドキュメントは https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ で確認できます
特定の期間のユーザー (メール) のアクティビティ ログを取得します

ある期間のユーザーのアクティビティ ログを取得します。
署名プロセスのアクティビティ ログを取得します

署名プロセスのアクティビティ ログを取得します。
署名プロセスをキャンセルする

指定されたプロセス キーに基づいて署名プロセスをキャンセルします。

1 人以上の署名者による新しい署名プロセスを作成します

操作 ID:
CreateSigningProcesssigning_Post

1 人以上の署名者による新しい署名プロセスを作成します。

パラメーター

名前 キー 必須 型 説明
pdfDocument
 pdfDocument string

署名するドキュメントの Base64 文字列です。 flowKey がドキュメントの作成を処理する場合、これは必要ありません。
pdfFileName
 pdfFileName string

PdfDocument が使用されている場合は、ファイル名の値を指定する必要があります。
flowKey
 flowKey True string

flowKey は Taktikal によって提供されます。 このキーで、Taktikal にこのリクエストの処理方法を指示します。 一部の flowKey については、Taktikal がドキュメントの作成を処理します。 また、署名後に署名されたドキュメントがどこに配信されるかも制御します。
processKey
 processKey string
名称
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
メールアドレス
 email string
address
 address string
郵便番号
 postalCode string
市
 city string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
customSmsText
 customSmsText string
signatureType
 signatureType string
language
 language string
Dictionary
 meta object

Dictionary<String,String>
fileName
 fileName string
fileContent
 fileContent string
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

既定値は false です。 true に設定すると、ドキュメントを表示する前に、すべての署名者がその e-Id を使用して認証する必要があります。
signInOrder
 signInOrder boolean

既定値は false です。 署名者の順序を制御します。 まず、署名要求は署名者一覧の最初の人にのみ送信されます。 その人が署名した後、次の署名者は同様に行います。
signatureLocation
 signatureLocation string

BottomLastPage または既定値の TopFirstPage を指定できます。 ドキュメント内のどこに署名を表示するかを制御します。
user
 user string

要求を送信するユーザーのメール アドレス。 空白にできます。
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
flattenDocument
 flattenDocument boolean

既定値は false です。 true に設定すると、ドキュメントの入力フィールドをフラット化しようとします。
reminderRule
 reminderRule string

リマインダーを送信します。何もしない場合は空のままにします。 形式は「x 日後の firstReminder: その後 y 日ごと」にする必要があります。たとえば、「1:3」の場合、1 日後に 1 回リマインダーが送信され、その後 3 日ごとに送信されます。 リマインダーなしの場合は空または null のままにします。有効な値は、最初のリマインダーが 0 ～ 30 日の間で送信され (0 はリマインダーなしを意味します)、その後は 0 ～ 15日ごとに送信されます (0 は、リマインダーなしを意味します。したがって 0: 10 は10日ごとにのみリマインダーを送信し、12:0 は 12 日後に 1 回だけリマインダーを送信します

戻り値

SigningProcess

SigningProcess
SigningProcess

PDF ドキュメントを封印する

操作 ID:
SealingRequestsealing_Post

Base64 文字列として提供された PDF ドキュメントを封印します。

パラメーター

名前 キー 必須 型 説明
pdfDocument
 pdfDocument True string

封印する PDF ドキュメントの Base64String。
flowKey
 flowKey True string

会社に属するフローの一意識別子。
reason
 reason string

封印に表示する理由を設定する
languageType
 languageType string

戻り値

SealingResponse

SealingResponse
SealingResponse

processKey と signeeKey による署名プロセスを取得します

操作 ID:
GetSigningProcessBySigneeProcessKeysigneeSigneeKey_Get

processkey と signeeKey による署名プロセスを取得します。

パラメーター

名前 キー 必須 型 説明
単一のドキュメント署名プロセスの一意識別子。
 ProcessKey True string

単一のドキュメント署名プロセスの一意識別子。
単一の署名プロセスに署名する人の一意識別子。
 SigneeKey True string

単一の署名プロセスに署名する人の一意識別子。
ユーザー エージェントは、Web ブラウザーやメール クライアントなど、ユーザーのために機能するソフトウェアです。
 UserAgent string

ユーザー エージェントは、Web ブラウザーやメール クライアントなど、ユーザーのために機能するソフトウェアです。

戻り値

SigningProcess

SigningProcess
SigningProcess

XML ドキュメントを封印する

操作 ID:
SealingXmlRequestsealingxml_Post

Base64 文字列として提供された XML ドキュメントを封印します。

パラメーター

名前 キー 必須 型 説明
xmlDocument
 xmlDocument True string

封印する XML ドキュメントの Base64String
flowKey
 flowKey True string

Taktikal が提供する、封印に使用できる有効な flowKey

戻り値

Object

返答
object

アイスランド の e-ID を使用してユーザーの認証ステータスを確認します

操作 ID:
AuthPollPoll_Post

/Auth/Start からの応答が成功すると、AuthRequestId が返され、認証が完了したかどうかを確認するために使用されます。 認証が終了し、成功すると、LookupType に応じて顧客オブジェクトが設定されます。 検索タイプは、Icelandic National Registry で取得される情報のタイプを示します。

LookupType に応じて、次の 3 つの異なるデータセットが返されます。

  1. 名前: 認証された人の SSN と名前のみを返します。 これには追加の検索コストはかかりません。

  2. NameAddress: 名前、SSN、および住所情報を返します。 これには追加の検索コストがかかります。 LookupType の値が指定されていない場合、これが既定値になります。

  3. NameAddressFamily: 名前、SSN、住所データ、性別コード、家族情報を返します。

'LookupType.NameAddressFamily' が選択されている場合、返される追加の値は 'メタ' で返されます。

応答にエラーがあるか、完了していない場合、顧客オブジェクトは null になり、StatusMessage に詳細メッセージが含まれます。

パラメーター

名前 キー 必須 型 説明
authRequestId
 authRequestId True string
flowKey
 flowKey True string

会社に属するフローの一意識別子。
lookupType
 lookupType True string

戻り値

PollCustomer

PollCustomer
PollCustomer

アイスランド のe-ID を使用して認証プロセスを開始します

操作 ID:
AuthStartStart_Post

アイスランドの e-ID による認証は、携帯電話または Audkenni アプリで行うことができます。

  • 携帯電話の使用: AuthenticationContextType は 'Sim' に設定し、phoneNumber はアイスランドの携帯電話番号に設定する必要があります。 ssn は無視されます。
  • Audkenni アプリの使用: AuthenticationContextType を 'App' に設定し、ssn を Icdlandic 社会保障番号に設定する必要があります。 phoneNumber は無視されます。

flowKey は常に提供する必要があり、Taktikal ポータルでアクセスできます。

パラメーター

名前 キー 必須 型 説明
ssn
 ssn string
phoneNumber
 phoneNumber string
flowKey
 flowKey True string

会社に属するフローの一意識別子。
authenticationContextType
 authenticationContextType True string

戻り値

StartAuthResponse

StartAuthResponse
StartAuthResponse

アイスランドの e-ID を使用して認証プロセスを開始し、シーケンシャル署名プロセスを実行します

操作 ID:
RequestToViewSequenceStartsequentialSequenceKeyauth_Post

アイスランドの e-ID による認証は、携帯電話または Audkenni アプリで行うことができます。

  • 携帯電話の使用: AuthenticationContextType は 'Sim' に設定し、phoneNumber はアイスランドの携帯電話番号に設定する必要があります。 ssn は無視されます。
  • Audkenni アプリの使用: AuthenticationContextType を 'App' に設定し、ssn を Icdlandic 社会保障番号に設定する必要があります。 phoneNumber は無視されます。

パラメーター

名前 キー 必須 型 説明
シーケンシャル (一括) 署名プロセスの一意識別子。
 SequenceKey True string

シーケンシャル (一括) 署名プロセスの一意識別子。
sequenceKey
 sequenceKey True string
loginHint
 loginHint True string
authenticationContextType
 authenticationContextType True string

戻り値

StartAuthResponse

StartAuthResponse
StartAuthResponse

シーケンシャル署名プロセスをキャンセルする

操作 ID:
CancelSequenceSigningsigningsequential_Delete

指定されたシーケンス キーに基づいてシーケンシャル署名プロセスをキャンセルします。 シーケンシャル プロセスをキャンセルするユーザー (メールアドレス) を指定することができます。

パラメーター

名前 キー 必須 型 説明
指定する必要があるシーケンシャル署名プロセス識別子。
 SequenceKey True string

指定する必要があるシーケンシャル署名プロセス識別子。
キャンセルできるのは、署名プロセスを開始したユーザーのみです。
 User True string

キャンセルできるのは、署名プロセスを開始したユーザーのみです。

戻り値

SequentialSigning

SequentialSigning
SequentialSigning

会社のアクティビティ ログを取得します

操作 ID:
GetSigningProcessActivityByCompanyactivitycompany_Get

会社のアクティビティ ログを取得します

パラメーター

名前 キー 必須 型 説明
検索するログの開始日は、EndDate よりも前の日付である必要があります。
 StartDate True date-time

検索するログの開始日は、EndDate よりも前の日付である必要があります。
検索するログの終了日は、StartDate よりも後の日付である必要があります。
 EndDate True date-time

検索するログの終了日は、StartDate よりも後の日付である必要があります。
結果セットをページングして N 個の結果のみを返すために使用されます。
 Take integer

結果セットをページングして N 個の結果のみを返すために使用されます。
結果セットをページングして最初の N 個の結果をスキップするために使用されます。
 Skip integer

結果セットをページングして最初の N 個の結果をスキップするために使用されます。
ユーザーのメール。
 User string

ユーザーのメール。
特定のフロー タイプのアクティビティのみを取得するために使用できます。
 FlowType string

特定のフロー タイプのアクティビティのみを取得するために使用できます。
値がある場合は、この flowKey に一致するレコードのみを返します。
 FlowKey string

値がある場合は、この flowKey に一致するレコードのみを返します。

戻り値

リスト<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

指定された ProcessKey および SigneeKey の署名者を更新する

操作 ID:
UpdateSigneeProcessKeysigneeSigneeKey_Create

署名者のプロパティは、提供された ProcessKey と SigneeKey に基づいて更新できます。

パラメーター

名前 キー 必須 型 説明
単一の署名プロセスに署名する人の一意識別子。
 SigneeKey True string

単一の署名プロセスに署名する人の一意識別子。
単一のドキュメント署名プロセスの一意識別子。
 ProcessKey True string

単一のドキュメント署名プロセスの一意識別子。
メールアドレス
 email string
address
 address string
郵便番号
 postalCode string
市
 city string
signeeKey
 signeeKey True string
processKey
 processKey True string
reason
 reason string
user
 user string

戻り値

署名者

署名者
Signee

新しいシーケンシャル (一括) 署名プロセスを作成する

操作 ID:
CreateSequentialSigningsigningsequential_Post

1 つ以上の署名プロセスを含む新しいシーケンシャル (一括) 署名プロセスを作成します。 シーケンス内の各署名プロセスには 1 人以上の署名者がいます。

例:

  • ある企業がドキュメント A と B への署名を必要としているとします。 署名者 X はドキュメント A と B に署名し、署名者 Y はドキュメント A に署名し、署名者 Z はドキュメント B に署名する必要があります。
  • 次に、2 つの CreateSigningProcess オブジェクトの配列を含む新しい CreateSequentalSigning です。 署名者 X と Y はドキュメント A の CreateSigningProcess の署名者として追加され、署名者 X と Z はドキュメント B の署名者として追加されます。

詳細なドキュメントは https://docs.taktikal.is/docs/api/using-the-signing-api/sequence-signing/ で確認できます

パラメーター

名前 キー 必須 型 説明
pdfDocument
 pdfDocument string

署名するドキュメントの Base64 文字列です。 flowKey がドキュメントの作成を処理する場合、これは必要ありません。
pdfFileName
 pdfFileName string

PdfDocument が使用されている場合は、ファイル名の値を指定する必要があります。
flowKey
 flowKey True string

flowKey は Taktikal によって提供されます。 このキーで、Taktikal にこのリクエストの処理方法を指示します。 一部の flowKey については、Taktikal がドキュメントの作成を処理します。 また、署名後に署名されたドキュメントがどこに配信されるかも制御します。
processKey
 processKey string
名称
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
メールアドレス
 email string
address
 address string
郵便番号
 postalCode string
市
 city string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
customSmsText
 customSmsText string
signatureType
 signatureType string
language
 language string
Dictionary
 meta object

Dictionary<String,String>
fileName
 fileName string
fileContent
 fileContent string
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string
requiresAuth
 requiresAuth boolean

既定値は false です。 true に設定すると、ドキュメントを表示する前に、すべての署名者がその e-Id を使用して認証する必要があります。
signInOrder
 signInOrder boolean

既定値は false です。 署名者の順序を制御します。 まず、署名要求は署名者一覧の最初の人にのみ送信されます。 その人が署名した後、次の署名者は同様に行います。
signatureLocation
 signatureLocation string

BottomLastPage または既定値の TopFirstPage を指定できます。 ドキュメント内のどこに署名を表示するかを制御します。
user
 user string

要求を送信するユーザーのメール アドレス。 空白にできます。
sequenceKey
 sequenceKey string
activityDisplayName
 activityDisplayName string
flattenDocument
 flattenDocument boolean

既定値は false です。 true に設定すると、ドキュメントの入力フィールドをフラット化しようとします。
reminderRule
 reminderRule string

リマインダーを送信します。何もしない場合は空のままにします。 形式は「x 日後の firstReminder: その後 y 日ごと」にする必要があります。たとえば、「1:3」の場合、1 日後に 1 回リマインダーが送信され、その後 3 日ごとに送信されます。 リマインダーなしの場合は空または null のままにします。有効な値は、最初のリマインダーが 0 ～ 30 日の間で送信され (0 はリマインダーなしを意味します)、その後は 0 ～ 15日ごとに送信されます (0 は、リマインダーなしを意味します。したがって 0: 10 は10日ごとにのみリマインダーを送信し、12:0 は 12 日後に 1 回だけリマインダーを送信します
user
 user True string

シーケンシャル署名プロセスを開始するユーザー
requiresAuth
 requiresAuth boolean

既定値は false です。 true に設定すると、ドキュメントを表示する前に、すべての署名者がその e-Id を使用して認証する必要があります。
signInOrder
 signInOrder boolean

既定値は false です。 署名者の順序を制御します。 まず、署名要求は署名者一覧の最初の人にのみ送信されます。 その人が署名した後、次の署名者は同様に行います。

戻り値

SequentialSigning

SequentialSigning
SequentialSigning

特定の期間のユーザー (メール) のアクティビティ ログを取得します

操作 ID:
GetSigningProcessActivityForUseractivityuser_Get

ある期間のユーザーのアクティビティ ログを取得します。

パラメーター

名前 キー 必須 型 説明
ユーザーのメール。
 User string

ユーザーのメール。
検索するログの開始日は、EndDate よりも前の日付である必要があります。
 StartDate True date-time

検索するログの開始日は、EndDate よりも前の日付である必要があります。
検索するログの終了日は、StartDate よりも後の日付である必要があります。
 EndDate True date-time

検索するログの終了日は、StartDate よりも後の日付である必要があります。
単一の署名プロセスでフィルタリングするには if を使用します。
 ProcessKey string

単一の署名プロセスでフィルタリングするには if を使用します。
特定のフロー タイプのアクティビティのみを取得するために使用できます。
 FlowType string

特定のフロー タイプのアクティビティのみを取得するために使用できます。
結果セットをページングして N 個の結果のみを返すために使用されます。
 Take integer

結果セットをページングして N 個の結果のみを返すために使用されます。
結果セットをページングして最初の N 個の結果をスキップするために使用されます。
 Skip integer

結果セットをページングして最初の N 個の結果をスキップするために使用されます。
値がある場合は、この flowKey に一致するレコードのみを返します
 FlowKey string

値がある場合は、この flowKey に一致するレコードのみを返します。

戻り値

リスト<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

署名プロセスのアクティビティ ログを取得します

操作 ID:
GetSigningProcessActivityactivityProcessKey_Get

署名プロセスのアクティビティ ログを取得します。

パラメーター

名前 キー 必須 型 説明
ユーザーのメール。
 User string

ユーザーのメール。
検索するログの開始日は、EndDate よりも前の日付である必要があります。
 StartDate True date-time

検索するログの開始日は、EndDate よりも前の日付である必要があります。
検索するログの終了日は、StartDate よりも後の日付である必要があります。
 EndDate True date-time

検索するログの終了日は、StartDate よりも後の日付である必要があります。
単一の署名プロセスでフィルタリングするには if を使用します。
 ProcessKey True string

単一の署名プロセスでフィルタリングするには if を使用します。
特定のフロー タイプのアクティビティのみを取得するために使用できます。
 FlowType string

特定のフロー タイプのアクティビティのみを取得するために使用できます。
結果セットをページングして N 個の結果のみを返すために使用されます。
 Take integer

結果セットをページングして N 個の結果のみを返すために使用されます。
結果セットをページングして最初の N 個の結果をスキップするために使用されます。
 Skip integer

結果セットをページングして最初の N 個の結果をスキップするために使用されます。
値がある場合は、この flowKey に一致するレコードのみを返します。
 FlowKey string

値がある場合は、この flowKey に一致するレコードのみを返します。

戻り値

リスト<SigningProcessActivityLogWrapper>
array of SigningProcessActivityLogWrapper

署名プロセスをキャンセルする

操作 ID:
CancelSigningProcesssigning_Delete

指定されたプロセス キーに基づいて署名プロセスをキャンセルします。

パラメーター

名前 キー 必須 型 説明
単一のドキュメント署名プロセスの一意識別子。
 ProcessKey string

単一のドキュメント署名プロセスの一意識別子。
文字列オブジェクト。通常は、ポータルにアクセスできる従業員のメールアドレスです。
 User string

文字列オブジェクト。通常は、ポータルにアクセスできる従業員のメールアドレスです。

戻り値

SigningProcess

SigningProcess
SigningProcess

定義

署名者

署名者

名前 パス 型 説明
名称
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
メールアドレス
 email string
address
 address string
郵便番号
 postalCode string
市
 city string
key
 key string
署名済み
 signed boolean
signedAt
 signedAt date-time
processKey
 processKey string
reason
 reason string
hidePersonalCode
 hidePersonalCode boolean
communicationDeliveryType
 communicationDeliveryType string
url
 url string
signatureType
 signatureType string
language
 language string
customSmsText
 customSmsText string

SigningAttachment

SigningAttachment

名前 パス 型 説明
fileName
 fileName string
fileContent
 fileContent string

AttachmentReference

AttachmentReference

名前 パス 型 説明
id
 id string
fileName
 fileName string
contentLength
 contentLength integer
contentType
 contentType string
url
 url string
description
 description string
processKey
 processKey string
attachmentType
 attachmentType string
signeeKey
 signeeKey string

Dictionary_String_String_

Dictionary<String,String>

名前 パス 型 説明
Dictionary
 object

Dictionary<String,String>

SigningProcessActivityLogWrapper

SigningProcessActivityLogWrapper

名前 パス 型 説明
processKey
 processKey string
activityLog
 activityLog array of SigningProcessActivityLog
署名者
 signees array of SigneeActivityLog
sequenceSignees
 sequenceSignees array of SequentialSigningSigneeActivityLog
attachmentReferences
 attachmentReferences array of AttachmentReference
activityDisplayName
 activityDisplayName string

SigningProcessActivityLog

SigningProcessActivityLog

名前 パス 型 説明
flowKey
 flowKey string

会社に属するフローの一意識別子。
processKey
 processKey string
signeeKey
 signeeKey string
ステータス
 status string
description
 description string
userAgent
 userAgent string
fileName
 fileName string
createdAt
 createdAt date-time
createdBy
 createdBy string
requiresAuth
 requiresAuth boolean
signInOrder
 signInOrder boolean
signatureLocation
 signatureLocation string
sequenceKey
 sequenceKey string

SigneeActivityLog

SigneeActivityLog

名前 パス 型 説明
processKey
 processKey string
signeeKey
 signeeKey string
ssn
 ssn string
名称
 name string
address
 address string
郵便番号
 postalCode string
市
 city string
電話番号
 phone string
メールアドレス
 email string
createdAt
 createdAt date-time
createdBy
 createdBy string
updatedAt
 updatedAt date-time
signatureType
 signatureType string

SequentialSigningSigneeActivityLog

SequentialSigningSigneeActivityLog

名前 パス 型 説明
sequenceKey
 sequenceKey string
signeeKey
 signeeKey string
url
 url string
signingKeys
 signingKeys array of SigneeKeys

SigneeKeys

SigneeKeys

名前 パス 型 説明
signeeKey
 signeeKey string
processKey
 processKey string

SequentialSigning

SequentialSigning

名前 パス 型 説明
key
 key string
ステータス
 status string
requiresAuth
 requiresAuth boolean
user
 user string
signInOrder
 signInOrder boolean
署名者
 signees array of SequentialSigningSignee
signingProcesses
 signingProcesses array of SigningProcess

SequentialSigningSignee

SequentialSigningSignee

名前 パス 型 説明
key
 key string
url
 url string
signingKeys
 signingKeys array of SigneeKeys

SigningProcess

SigningProcess

名前 パス 型 説明
key
 key string
署名者
 signees array of Signee
flowKey
 flowKey string

会社に属するフローの一意識別子。
ステータス
 status string
Dictionary
 meta Dictionary_String_String_

Dictionary<String,String>
pdfFileName
 pdfFileName string
attachments
 attachments array of SigningAttachment
attachmentReferences
 attachmentReferences array of AttachmentReference
requiresAuth
 requiresAuth boolean
user
 user string
signInOrder
 signInOrder boolean
signatureLocation
 signatureLocation string
sequenceKey
 sequenceKey string
flattenDocument
 flattenDocument boolean

StartAuthResponse

StartAuthResponse

名前 パス 型 説明
authRequestId
 authRequestId string
verificationCode
 verificationCode string

SealingResponse

SealingResponse

名前 パス 型 説明
pdfDocument
 pdfDocument string

大変お世話になっております

大変お世話になっております

名前 パス 型 説明
名称
 name string
ssn
 ssn string
phoneNumber
 phoneNumber string
メールアドレス
 email string
address
 address string
郵便番号
 postalCode string
市
 city string
token
 token string
flowKey
 flowKey string

会社に属するフローの一意識別子。
Dictionary
 meta Dictionary_String_String_

Dictionary<String,String>

PollCustomer

PollCustomer

名前 パス 型 説明
大変お世話になっております
 customer Customer

大変お世話になっております
statusMessage
 statusMessage string
waitingForUserInput
 waitingForUserInput boolean

オブジェクト

’オブジェクト’ という種類です。