検証済み
カスタム ドキュメント署名プロセスの作成を可能にする検証済み API のコネクタ。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | 認証済 |
[URL] | https://verified.eu/en/#about-us |
メール | support@verified.eu |
Connector Metadata | |
---|---|
発行者 | CRM Konsulterna i Sverige AB |
Web サイト | https://verified.eu/ |
プライバシー ポリシー | https://verified.eu/trust-center |
カテゴリー | コンテンツとファイル;生産性 |
Verified は、電子 ID およびデジタル署名のサービス プロバイダーとしてのソフトウェアです。 このコネクタを使用すると、Verified の API に統合して、アプリケーション内にシンプルで直感的な署名プロセスを作成します。
このコネクタの発行元は、Verified を代表して CRM-Konsulterna I Sverige AB です。
続行するには、次のものが必要です。
- Verified アカウントに サインアップします
このコネクタは、基本認証を使用します。 ユーザーは、接続を作成するときに、ユーザー名、パスワード、および会社 ID を提示する必要があります。 ユーザー名とパスワードは、確認済みポータルへのログインに使用するものと同じです。 会社 ID を取得するには、確認済みポータルにログインする必要があります。複数ある場合は正しい会社を選択し、URL から会社 ID をコピーします。
一般的な使用例は、署名プロセスを開始および管理することです。つまり、署名するドキュメントを Verified に送信し、署名されたドキュメントを定期的に取得するための自動化を設定します。 検証済み署名プロセスを開始するために使用される一般的なアクションには、エンベロープの作成-記述子またはエンベロープの作成-デフォルト、ドキュメントをエンベロープに追加、ファイルをドキュメントに追加、受信者をエンベロープに追加、エンベロープの公開ステータスの更新が含まれます。 ドキュメントの確認済みステータスを確認するために使用される一般的なアクションには、ID によるエンベロープの取得、エンベロープ ID によるすべてのドキュメントの取得、document id によるファイルの取得、ID によるファイルURLの取得が含まれます。次の手順で使用するセキュリティ トークンを取得するための最初の手順として、[セキュリティ トークンの生成] アクションが常に使用されることに注意してください。
次の制限事項が現在知られています。
- すべてのフローの開始時に、後続のすべてのステップで再利用される認証トークンを作成する必要があります。
- ドキュメントを追加するには、特定の URL に HTTP リクエストを送信する必要があります。
実際のドキュメントをアップロードするには、検証済み API でファイルを作成し、検証済み API から応答された blob URL にドキュメント ハッシュをアップロードする必要があります。
エンベロープを作成するステップは、エンベロープへの完全なパスである uid で応答します (例: "/ Envelopes / ABCDE")。 他のステップでは、uid の最後の部分 (この例では "ABCDE" の実際のエンベロープ ID) のみが必要です。
これを実行する方法の例を次に示します
substring(outputs('Create_new_default_envelope')?['body/uid'],11)
ドキュメントを作成するステップは、ヘッダー内の新しいドキュメントの場所で応答します。 場所は、ドキュメントへの完全なパスです (例: "/ api / Envelopes / ABCDE / documents / FGHIJ")。 次の手順では、ドキュメント ID (この場合は FGHIJ) のみが必要です。
これを実行する方法の例を次に示します
substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))
エンベロープに関する情報をロードすると、関連するフローが応答の一部になります (例: "/ flow / default")。 応答ではフローの ID と呼ばれますが、別のステップ (フロー ステータスの取得など) がフロー ID を要求している場合は、最後の部分のみが必要です。
これを実行する方法の例を次に示します
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
会社が必要なアクションには、Company Id という追加のフィールドがあります。値が提示されると、それが使用されます。それ以外の場合は、接続のデフォルトが使用されます。 フォーマットは以下である必要があります:
/companies/<your company Id>
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | 内容 | 必要 |
---|---|---|---|
ユーザー名 | securestring | この API のユーザー名 | True |
password | securestring | この API のパスワード | True |
企業 ID | string | 会社 ID は Verified によって提供されます。 app.verified.eu にログインすると、URL で見つけることができます | True |
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
ID でエンベロープを削除する |
指定されたエンベロープを削除します。 |
ID でエンベロープを取得する |
指定されたエンベロープの詳細を取得します。 |
id でドキュメントを削除する |
指定されたドキュメントを削除します。 |
ID でドキュメントを取得する |
指定されたドキュメントの情報を取得します。 |
ID でファイル URL を取得します |
指定されたファイルへの URL を取得します。 |
ID でファイルを取得する |
指定されたファイルに関する情報を取得します。 |
ID で会社を取得する |
指定された会社の情報を取得します。 |
ID で受信者を更新する |
受信者を更新します。 |
ID で記述子を取得する |
特定の記述子の情報をその記述子で取得します。 |
すべてのエンベロープを照会する |
指定のフィルターに一致するすべてのエンベロープをクエリします。 |
すべてのエンベロープ受信者を取得します |
指定したエンベロープの受信者をすべて取得します。 |
すべての記述子を取得する |
現在の会社に存在するすべての記述子のリストを取得します。 このリストはフィルタリングできます。 |
エンベロープ ID ですべてのドキュメントを取得する |
特定の封筒に関連するすべてのドキュメントを取得します。 |
エンベロープ ID でフロー状態を取得する |
指定したエンベロープの現在のフロー状態を取得します。 |
エンベロープのごみ箱状態の設定 |
指定されたエンベロープの状態を破棄済みに設定します。 |
エンベロープの中止状態の設定 |
指定されたエンベロープの状態を中止に設定します。 |
エンベロープの作成 - 規定 |
既定の記述子を使用して新しいエンベロープを作成します |
エンベロープの公開ステータスを更新する |
指定されたエンベロープの公開の状態を更新します。 |
エンベロープの特定受信者を取得する |
指定したエンベロープの特定の受信者を取得します。 |
エンベロープを作成する - 記述子 |
特定の記述子に基づいてエンベロープを作成します。 |
エンベロープ設定を更新する |
特定のエンベロープの設定を更新します。 |
セキュリティ トークンを生成する |
検証済み API から認証トークンを取得します。 |
テンプレートからドキュメントを生成する |
事前構成したテンプレートからドキュメントを生成します。 |
ドキュメント ID でファイルを取得する |
特定のドキュメントに接続されているすべてのファイルを取得します。 |
ドキュメントの中止状態の設定 |
指定されたドキュメントの状態を中止に設定します。 |
ドキュメントをエンベロープに追加する |
新規ドキュメントを既存のエンベロープに追加します。 |
ファイルをドキュメントに追加する |
ファイルを既存のドキュメントに追加します。 |
ユーザー情報を取得する |
現在ログインしているユーザーの情報を取得します。 |
ユーザー設定を取得する |
指定されたユーザーの設定を更新します。 |
受信者をエンベロープに追加する |
指定したエンベロープに受信者を追加します。 |
既定の説明を取得する |
エンベロープの既定記述子を取得します。 |
署名リンクを作成する |
署名リンクを作成します。 実装はフロー固有であり、特定のフローでは欠落している可能性があります。 |
通知の送信 |
指定されたエンベロープの受信者に通知を送信します。 |
指定されたエンベロープを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
指定されたエンベロープの詳細を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
戻り値
- Envelope
- Envelope
指定されたドキュメントを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
指定されたドキュメントの情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
戻り値
- Document
- Document
指定されたファイルへの URL を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
File Id
|
file-id | True | string |
当該ファイルの ID |
As Object
|
asObject | boolean |
応答が Object かどうかを定義します |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
URL
|
url | string |
ファイル URL |
指定されたファイルに関する情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
File Id
|
file-id | True | string |
当該ファイルの ID |
戻り値
- File
- File
指定された会社の情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
Company Id
|
company-id | True | string |
当該会社の ID |
戻り値
- Company
- Company
受信者を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
受信者の ID
|
recipient-id | True | string |
当該受信者の ID |
First Name
|
givenName | True | string | |
Last Name
|
familyName | True | string | |
Language
|
language | True | string | |
Signing Method
|
signingMethod | True | string | |
通知メソッド
|
notificationMethod | string | ||
E-Mail
|
True | string | ||
Telephone
|
telephone | string |
フォーマットは + である必要があります |
|
Order
|
order | integer | ||
Action
|
action | True | string |
受信者が実行するアクションの検証済みの名前です。 |
Label
|
label | True | string |
受信者の役割/アクションのラベル |
Name
|
name | True | string |
受信者の役割の Verified 名 |
Secure
|
secure | boolean | ||
SMS
|
sms | boolean | ||
SSN
|
ssn | string | ||
Bank
|
bank | string |
特定の記述子の情報をその記述子で取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
Envelope Descriptor Id
|
envelope-descriptor-id | True | string |
エンベロープ記述子の ID |
戻り値
- Descriptor
- Descriptor
指定のフィルターに一致するすべてのエンベロープをクエリします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
Filters
|
filters | string |
クエリをフィルタリングしてサブアマウントを選択します |
|
送信者
|
from | integer |
開始日 |
|
Limit
|
limit | integer |
限度金額 |
|
Sort
|
sort | string |
並べ替え順 |
戻り値
- response
- array of EnvelopeDescriptorString
指定したエンベロープの受信者をすべて取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
戻り値
現在の会社に存在するすべての記述子のリストを取得します。 このリストはフィルタリングできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
Filters
|
filters | string |
クエリをフィルタリングしてサブアマウントを選択します |
戻り値
特定の封筒に関連するすべてのドキュメントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
戻り値
指定したエンベロープの現在のフロー状態を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
フロー ID
|
flow-id | True | string |
当該フローの ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Token
|
token | string |
指定されたエンベロープの状態を破棄済みに設定します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Comment
|
comment | string |
指定されたエンベロープの状態を中止に設定します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
コメント
|
comment | string |
既定の記述子を使用して新しいエンベロープを作成します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
メール
|
string | |||
First Name
|
givenName | string | ||
Last Name
|
familyName | string | ||
Automatic Reminders
|
automaticReminders | number | ||
Expiration
|
expiration | string | ||
Hash
|
hash | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
uid
|
uid | string |
指定されたエンベロープの公開の状態を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Published
|
published | True | boolean |
指定したエンベロープの特定の受信者を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
受信者の ID
|
recipient-id | True | string |
当該受信者の ID |
戻り値
- Recipient
- Recipient
特定の記述子に基づいてエンベロープを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
Envelope Descriptor Id
|
envelope-descriptor-id | True | string |
エンベロープ記述子の ID |
メール
|
string | |||
First Name
|
givenName | string | ||
Last Name
|
familyName | string | ||
Automatic Reminders
|
automaticReminders | number | ||
Expiration
|
expiration | string | ||
Hash
|
hash | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
uid
|
uid | string |
特定のエンベロープの設定を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Sequential Signing
|
sequentialSigning | boolean | ||
Greeting
|
greeting | string | ||
Expiration
|
expiration | date |
次のフォーマット 2017-02-26T21:59:59.999Z の日付 |
|
Automatic Reminders
|
automaticReminders | number |
期限切れまでの X 日数 |
検証済み API から認証トークンを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Token
|
token | string |
トークンへのアクセス |
事前構成したテンプレートからドキュメントを生成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
Template Id
|
template-id | True | string |
使用すべきテンプレートの Id |
|
object |
特定のドキュメントに接続されているすべてのファイルを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
戻り値
- response
- array of File
指定されたドキュメントの状態を中止に設定します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
新規ドキュメントを既存のエンベロープに追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Hash
|
hash | integer | ||
件名
|
name | True | string | |
Source
|
source | string |
戻り値
ファイルを既存のドキュメントに追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Document Id
|
document-id | True | string |
当該ドキュメントの ID |
Name
|
name | True | string | |
FileType
|
fileType | True | string | |
Hash
|
hash | string |
戻り値
- File
- File
現在ログインしているユーザーの情報を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
戻り値
- Body
- UserInfo
指定されたユーザーの設定を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
Company Id
|
company-id | True | string |
当該会社の ID |
User Id
|
user-id | True | string |
当該ユーザーの ID |
戻り値
- Body
- Setting
指定したエンベロープに受信者を追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
First Name
|
givenName | True | string | |
Last Name
|
familyName | True | string | |
Language
|
language | True | string | |
Signing Method
|
signingMethod | True | string | |
通知メソッド
|
notificationMethod | string | ||
E-Mail
|
True | string | ||
Telephone
|
telephone | string |
フォーマットは + である必要があります |
|
Order
|
order | integer | ||
Action
|
action | True | string |
受信者が実行するアクションの検証済みの名前です。 |
Label
|
label | True | string |
受信者の役割/アクションのラベル |
Name
|
name | True | string |
受信者の役割の Verified 名 |
Secure
|
secure | boolean | ||
SMS
|
sms | boolean | ||
SSN
|
ssn | string | ||
Bank
|
bank | string |
戻り値
エンベロープの既定記述子を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
Filters
|
filters | string |
クエリをフィルタリングしてサブアマウントを選択します |
戻り値
- Descriptor
- Descriptor
署名リンクを作成します。 実装はフロー固有であり、特定のフローでは欠落している可能性があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
Id
|
id | string | ||
Redirect To
|
redirectTo | uri |
署名後にユーザーをリダイレクトするための完全な URL。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
[URL]
|
getSignLink.recipient.{recipient-id}.url | string |
指定されたエンベロープの受信者に通知を送信します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Token
|
token | True | string |
'セキュリティ トークンの生成' アクションから受け取ったトークン |
企業 ID
|
x-namespace | string |
アクションに使用すべき会社 Id。 形式: "/会社/。 設定されていない場合は、デフォルトで接続会社 ID になります。 |
|
エンベロープ Id
|
envelope-id | True | string |
当該エンベロープの ID |
グリーティング
|
greeting | string | ||
受信者の ID
|
id | True | string |
通知を送信する受信者の ID。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
Global
|
global | string | |
Signatory Language
|
preferences.signatoryLanguage | string | |
Greeting
|
preferences.greeting | string | |
Signing Method
|
preferences.signingMethod | string | |
Reminder Offset
|
preferences.reminderOffset | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
First Name
|
givenName | string | |
Last Name
|
familyName | string | |
Email
|
string | ||
Language
|
metadata.language | string | |
Missing Password
|
missingPassword | boolean | |
Is Enabled
|
isEnabled | boolean | |
Namespace
|
namespace | string | |
Enabled
|
enabled | boolean | |
UID
|
uid | string | |
Id
|
id | string | |
Roles
|
roles | array of Role | |
Validated
|
validated | boolean |
名前 | パス | 型 | 説明 |
---|---|---|---|
Name
|
name | string | |
Reg. Number
|
regNumber | string | |
Created
|
created | string | |
Modified
|
modified | string | |
Address
|
address | string | |
City
|
city | string | |
Zip Code
|
zipCode | string | |
Logo
|
logo | string | |
Country
|
country | string | |
UId
|
uid | string | |
Id
|
id | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
UID
|
uid | string |
受信者 UID |
Namespace
|
namespace | string |
受信者の名前空間 |
Created
|
created | string |
作成した受信者 |
Role
|
role | RoleActionString | |
Last Name
|
familyName | string |
受信者の姓 |
First Name
|
givenName | string |
受信者の名 |
Language
|
language | string |
受信者の言語 |
メール
|
string |
受信者のメール |
|
Signing Method
|
signingMethod | string |
受信者の署名方法 |
通知メソッド
|
notificationMethod | string | |
Order
|
order | integer |
受信者の注文 |
Id
|
id | string |
受信者の ID |
Modified
|
modified | string |
変更された受信者 |
通知済み
|
notified | boolean | |
Completed
|
completed | boolean | |
demandAttachment
|
demandAttachment | boolean |
名前 | パス | 型 | 説明 |
---|---|---|---|
タイプ
|
action.type | string | |
方法
|
action.methods | array of string | |
Label
|
label | string |
Label |
Num. Max
|
numMax | integer |
Num. Max |
Num. Min
|
numMin | integer |
Num. Min |
Role Name
|
roleName | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
Action
|
action | ActionString |
アクション |
Label
|
label | string |
ラベル |
Num. Max
|
numMax | integer |
Num. Max |
Num. Min
|
numMin | integer |
Num. Min |
Role Name
|
roleName | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
Id
|
id | string |
エンベロープ Id |
UID
|
uid | string |
エンベロープの UID |
Namespace
|
namespace | string |
エンベロープの名前空間 |
Version
|
version | integer |
エンベロープのバージョン |
Published
|
published | boolean |
公開されたエンベロープ |
Complete
|
completed | boolean |
完了したエンベロープ |
Aborted
|
aborted | boolean |
中止されたエンベロープ |
Trashed
|
trashed | boolean |
破棄されたエンベロープ |
Sequential Signing
|
sequentialSigning | boolean | |
Autmatic Reminders
|
automaticReminders | integer | |
Created
|
created | string |
作成されたエンベロープ |
Modified
|
modified | string |
変更されたエンベロープ |
Expired
|
expired | boolean |
有効期限が切れたエンベロープ |
Flow
|
flow | Flow | |
Descriptor
|
descriptor | Descriptor | |
Person
|
sender | Person | |
Documents
|
documents | array of Document | |
Recipients
|
recipients | array of Recipient | |
Tags
|
tags | array of object | |
Owners
|
owners | array of Person |
名前 | パス | 型 | 説明 |
---|---|---|---|
Id
|
id | string |
エンベロープ ID |
UID
|
uid | string |
エンベロープの UID |
Namespace
|
namespace | string |
エンベロープの名前空間 |
Version
|
version | integer |
エンベロープのバージョン |
Published
|
published | boolean |
公開されたエンベロープ |
Complete
|
completed | boolean |
完了したエンベロープ |
Aborted
|
aborted | boolean |
中止されたエンベロープ |
Trashed
|
trashed | boolean |
破棄されたエンベロープ |
Sequential Signing
|
sequentialSigning | boolean | |
Autmatic Reminders
|
automaticReminders | integer | |
Created
|
created | string |
作成されたエンベロープ |
Modified
|
modified | string |
変更されたエンベロープ |
Expired
|
expired | boolean |
有効期限が切れたエンベロープ |
Flow
|
flow | Flow | |
Descriptor
|
descriptor | string |
エンベロープの記述子 |
Person
|
sender | Person | |
Documents
|
documents | array of Document | |
Recipients
|
recipients | array of Recipient | |
Tags
|
tags | array of object | |
Owners
|
owners | array of Person |
名前 | パス | 型 | 説明 |
---|---|---|---|
Id
|
id | string |
ファイル Id |
URL
|
url | string |
ファイルの URL |
Name
|
name | string |
ファイル名 |
MimeType
|
mimeType | string | |
File Type
|
fileType | string | |
Storage Path
|
storagePath | string | |
Uploaded At
|
uploadedAt | string | |
Created
|
created | string |
作成されたファイル |
Owners
|
owners | array of object | |
UID
|
owners.uid | string |
ファイル所有者 UID |
Id
|
owners._id | string |
ファイル所有者 ID |
Namespace
|
namespace | string | |
UID
|
uid | string |
ファイル UID |
名前 | パス | 型 | 説明 |
---|---|---|---|
Id
|
id | string |
フロー ID |
Name
|
name | string |
フロー名 |
名前 | パス | 型 | 説明 |
---|---|---|---|
Name
|
name | string |
記述子名 |
Version
|
version | integer |
記述子のバージョン |
UID
|
uid | string |
記述子の UID |
Deleted
|
deleted | boolean |
削除された記述子 |
Public
|
public | boolean |
記述子公開 |
Expired
|
expired | boolean |
有効期限が切れた記述子 |
Id
|
id | string |
記述子 Id |
Mandatory
|
mandatory | boolean |
記述子必須 |
Label
|
label | string |
記述子ラベル |
Type
|
type | string |
記述子タイプ |
Roles
|
roles | array of Role | |
Owners
|
owners | array of Person | |
Flow
|
flow | Flow | |
defaultValues
|
defaultValues | DefaultValues |
defaultValues |
Instances
|
instances | array of object |
名前 | パス | 型 | 説明 |
---|---|---|---|
UID
|
uid | string |
個人の UID |
First Name
|
givenName | string |
個人の名 |
Last Name
|
familyName | string |
個人の姓 |
Email
|
string |
個人のメール |
|
Language
|
language | string |
個人の言語 |
Order
|
order | integer |
個人の順番 |
名前 | パス | 型 | 説明 |
---|---|---|---|
Label
|
label | string |
ドキュメント ラベル |
Type
|
type | string |
ドキュメントのタイプ |
Hash
|
hash | integer |
ドキュメント ハッシュ |
Num. Max
|
numMax | integer |
ドキュメント番号 最高 |
Num. Min
|
numMin | integer |
ドキュメント番号 最低 |
UID
|
uid | string |
ドキュメントの UID |
Namespace
|
namespace | string |
ドキュメントの名前空間 |
Source
|
source | string |
ドキュメントのソース |
Created
|
created | string |
作成されたドキュメント |
Name
|
name | string |
ドキュメント名 |
Id
|
id | string |
ドキュメント ID |
Modified
|
modified | string |
変更されたドキュメント |
Rejected
|
rejected | boolean |
拒否されたドキュメント |
Signed
|
signed | boolean |
署名されたドキュメント |
Trashed
|
trashed | boolean |
破棄されたドキュメント |
Aborted
|
aborted | boolean |
ドキュメントは中止されました |
Version
|
version | integer |
ドキュメントのバージョン |
attachments
|
attachments | array of Attachment | |
Flow
|
flow | Flow | |
roles
|
roles | array of Role | |
Template
|
template | Template | |
Descriptor
|
descriptor | Descriptor |
名前 | パス | 型 | 説明 |
---|---|---|---|
Label
|
label | string |
添付ファイルのラベル |
Num. Max
|
numMax | integer |
添付ファイルの番号 最高 |
Num. Min
|
numMin | integer |
添付ファイル番号最小 |
Hash
|
hash | integer |
添付ファイルのハッシュ |
名前 | パス | 型 | 説明 |
---|---|---|---|
Type
|
type | string |
テンプレートのタイプ |
HTML
|
html | string | |
PDFHTML
|
pdfHtml | string | |
Id
|
id | string | |
UID
|
uid | string | |
Namespace
|
namespace | string | |
Version
|
version | integer | |
Created
|
created | string | |
Modified
|
modified | string | |
Modified
|
published | boolean | |
Completed
|
completed | boolean | |
Aborted
|
aborted | boolean |
defaultValues
名前 | パス | 型 | 説明 |
---|---|---|---|
Person
|
signer | Person | |
Person
|
reviewer | Person |