ID Analyzer (プレビュー)

  • リファレンス

ID アナライザーには、ID を検証するさまざまな製品が存在するため、ご自身のアプリケーションに最適なソリューションを選択するには、その各製品について基本的な知識を理解する必要があります。

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

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

ID Analyzer プラットフォームは、企業、組織、および個人に、国境を越えて機能する真にグローバルな ID 検証ソリューション、特定のニーズと要求に合わせて調整できるソリューション、継続的にアップグレードおよび改善されていくセキュリティ システムを提供します。

世界中の 190 以上の国々で 4000 以上の異なる形式の ID 全体で完全な ID 検証アクセスと情報アクセスを提供する、現代社会について考慮して設計された非常にグローバルなソリューションです。

前提条件

  • ID Analyzer の開発者アカウント。 サインアップで、無料アカウントを登録できます
  • アカウントに登録すると、Web ポータルで ID Analyzer の API キーが提供されます。 この API キーを使用して、コネクタで認証します

資格情報の入手方法

  1. サインアップに移動します
  2. 必須情報を入力します。
  3. Eメールの確認画面が表示されたら、確認します。
  4. ID Analyzer の Web ポータルに新しい API キーとアカウントの詳細が表示されます。 「コピー」ボタンを押して、後で使用できるようにクリップボードに保存します。

よくあるご質問

顧客のプライバシーが心配ですが、API は顧客に関する情報を保存しますか?

すべてが顧客の Vault にのみ保存され、恣意的に漏洩されることはありません。 他の場所にコピーが作成されることはありません。

「クレジット」とは何のためのものですか。API クレジットを購入するにはどうすればよいですか?

アカウントのプリペイド クレジットの残量です。 月額プランをお持ちの場合は、月単位のクォータがプリペイド クレジットの前に使用されます。

ドキュメントが本物か偽物かを確認するにはどうすればよいですか?

認証を有効にすると、結果に認証スコアが含まれます。

接続の作成

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

既定

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

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

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

名称 タイプ 内容 必要
API API キー securestring この API の API キー True

調整制限

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

アクション

AML データベースを検索中

AML API を使用すると、制裁、PEP、指名手配犯を、名前やドキュメント番号を使用して ID Analyzer グローバル AML データベースから検索できます。 さらに生年月日と国籍で結果をフィルターできます。
Core API の設定

リモートの物理ドキュメントを検証する、多機能 ID 検証 API。リモートの物理ドキュメントの信頼性と顔を、ユーザーの写真を含むドキュメントと照合します。
DocuPass セッションを作成しています

ID 検証を要求するすべてのユーザーに対して検証セッションを作成できます。
DocuPass 署名セッションを作成しています

ユーザーが ID 検証なしで法的ドキュメントのレビューおよび電子署名を行うように署名セッションを作成できます。 ユーザーの ID 検証を実行してからドキュメントの署名を許可する場合は、ID 検証のセッションを作成してください。
Vault からエントリを削除する

HTTP POST リクエストを発行すると、1 件以上の Vault エントリを削除できます。
Vault から画像を削除する

Vault エントリから画像を削除する場合は、HTTP POST リクエストを発行します。 メモ: 画像を削除しても、キャッシュの影響で画像の URL に短期間アクセスできる可能性があります。
Vault に画像を追加する

HTTP POST 要求を作成し、画像をアップロードして既存の Vault エントリに追加できます。
Vault のエントリ コンテンツを取得する

エントリに Vault を追加すると、Core API と DocuPass API の両方が vaultid という名前の Vault エントリ識別子を返します。 この識別子を使用して Vault エントリのコンテンツをクエリする場合は、次のエンドポイントに HTTP POST リクエストを送信します。
Vault エントリを更新する

HTTP POST 要求を作成し、Vault エントリの複数のフィールドから 1 つのフィールドまたは値を更新できます。
エントリの一覧表示とフィルター

Vault 内部に保存されているすべてのエントリの一覧を表示するか、特定の値を持つエントリを検索するには、HTTP POST 要求を次のエンドポイントに送信します。
コールバックの検証中

データがこのサーバーから送信されたことを確認するために使用します。
トレーニングの状態

Vault のトレーニングが現在進行中か、完了済みかを確認します。
顔検索

顔検索を使用すると、人物の画像を使用して Vault 全体を検索します。 顔検索機能を使用する場合は、Web ポータルから顔検索インデックスを有効化して、Vault のデータセットを定期的にトレーニングする必要があります。
顔検索のトレーニング

顔検索を実行する前に、トレーニング コマンドを発行して Vault 内のドキュメント データセットをトレーニングする必要があります。 また、Web ポータルから Vault のデータをトレーニングすることもできます。 このトレーニング タスクは非同期であり、トレーニング時間は Vault が含むエントリと画像の件数によって異なります。 数秒から 1 時間程度かかる可能性があります。

AML データベースを検索中

操作 ID:
SearchingAML

AML API を使用すると、制裁、PEP、指名手配犯を、名前やドキュメント番号を使用して ID Analyzer グローバル AML データベースから検索できます。 さらに生年月日と国籍で結果をフィルターできます。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
name
 name string

任意の言語での個人や組織の名前またはエイリアスです。
documentnumber
 documentnumber string

個人のパスポート番号、国民識別番号、運転免許証番号など
エンティティ
 entity string

person: 個人; legalentity: 会社または組織
country
 country string

国/国籍が一致するか、または国の情報がないエンティティのみを返します。
dob
 dob string

生年月日が一致するか、または生年月日の情報がないエンティティのみを返します。
データベース
 database string

AML チェックを実行するソース データベースを指定します。空白にすると、すべてのソース データベースがチェックされます。 データベース コードをコンマで区切ります。例: un_sc、us_ofac。 ソース データベースおよび対応するコードの一覧については、AML API の概要をご覧ください。

戻り値

名前 パス 型 説明
aml
 items array of object

AML の一致の一覧を含む配列です。一致が見つからない場合は、空の配列を返します。 詳細については、AML API リファレンスをご覧ください。
エンティティ
 items.entity string

個人または法人
fullname
 items.fullname array of string

個人または法人の名前
firstname
 items.firstname array of string

個人の名
lastname
 items.lastname array of string

個人の姓
middlename
 items.middlename array of string

個人のミドル ネーム
エイリアス
 items.alias array of string

エンティティの代替名または外部名です
dob
 items.dob array of string

個人の生年月日。YYYY、YYYY-MM、または YYYY-MM-DD の形式で入力できます。
address
 items.address array of string

エンティティの住所または居住国
国籍
 items.nationality array of string

エンティティの国または国籍
出生地
 items.birthplace array of string

個人の出生地
性別
 items.gender array of string

個人の性別: M または F
documentnumber
 items.documentnumber array of object

エンティティに関連付けられているドキュメントの一覧です。
id
 items.documentnumber.id string

ドキュメント番号
id_formatted
 items.documentnumber.id_formatted string

英数字のドキュメント番号
country
 items.documentnumber.country string

ISO2 国コード
type
 items.documentnumber.type string

P = パスポート番号、I = ID 番号、D = 運転免許証番号、O = その他/不明な種類のドキュメント
プログラム
 items.program array of string

認可プログラム
メモ
 items.note array of string

エンティティへの追加メモ
時刻
 items.time string

エンティティがソース一覧に追加された時刻、または最後に更新された時刻の UTC TZ タイムスタンプ
ステータス
 items.status string

エンティティの職位/役職、または認可の現在の状態
source
 items.source array of string

正式なソース URL の一覧
データベース
 items.database string

ID アナライザーの AML データベース コード
スキーマ
 items.schema string

Core API の設定

操作 ID:
SettingCoreAPI

リモートの物理ドキュメントを検証する、多機能 ID 検証 API。リモートの物理ドキュメントの信頼性と顔を、ユーザーの写真を含むドキュメントと照合します。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
file_base64
 file_base64 string

application/x-www-form-urlencoded または application/json を使用して、base64 エンコードされた画像を文字列としてアップロードできます。
url
 url string

Core API を使用すると、自分のサーバーからリモート画像をダウンロードできます。
file_back_base64
 file_back_base64 string

両面スキャンを実行する際に使用する、Base64 でエンコードされたドキュメント裏面の画像。
url_back
 url_back string

両面スキャンの実行に使用される、ドキュメントの裏面のリモート画像です。
face_base64
 face_base64 string

写真の生体認証を実行する際に使用する、Base64 でエンコードした人物の顔の画像。
faceurl
 faceurl string

写真による生体認証の実行に使用される、個人の顔のリモート画像です。
video_base64
 video_base64 string

ビデオの生体認証を実行する際に使用する、Base64 でエンコードされたセルフィー ビデオ。
videourl
 videourl string

ビデオによる生体認証の実行に使用される、リモートでホストされたセルフィー ビデオです。
パスコード
 passcode string

4 桁の数字
正確性
 accuracy integer

ドキュメント認識と OCR 結果に適用する速度と精度を構成します。 低い精度では応答時間が 1 秒未満に短縮されますが、高い精度では通常 2〜3 秒かかります。
認証
 authenticate boolean

ドキュメントを検証して、偽のドキュメントではないことや、改変が加えられていないことをチェックします。
authenticate_module
 authenticate_module string

ドキュメントの検証に使用するモジュールを指定します。
biometric_threshold
 biometric_threshold float

顔の生体認証に合格するための最小スコアを指定する
return_confidence
 return_confidence boolean

各データ フィールドの信頼度スコアを返します。
return_empty
 return_empty boolean

このパラメーターを有効にすると、API が空のフィールドに対して null を返すよう設定できます。
ocr_scaledown
 ocr_scaledown integer

500 ～ 4000 の数または 0
outputimage
 outputimage boolean

ドキュメントから画像を切り取って生成します。
outputface
 outputface boolean

ドキュメントから顔の領域を切り取って画像を生成します。
outputmode
 outputmode string

ドキュメントと顔の切り取りを URL または base64 エンコードのコンテンツとして出力します。
dualsidecheck
 dualsidecheck boolean

両面スキャンを実行する際に、ドキュメントの名前、番号、および種類がドキュメントの表面と裏面で一致していることを確認してください。 一致しない情報がある場合、エラー 14 がスローされます。
verify_expiry
 verify_expiry boolean

有効期限に基づいて、有効期限内のドキュメントかどうかを確認します。
verify_documentno
 verify_documentno string

提供したドキュメント番号が、ドキュメントと一致するかどうかを確認します。
verify_dob
 verify_dob string

入力した生年月日がドキュメントと一致するかどうかを確認します。 (YYYY/MM/DD)
verify_age
 verify_age string

ドキュメント所有者の年齢が指定した範囲内かどうかを確認します。 (範囲、例: 18～40)
verify_address
 verify_address string

提供した住所がドキュメントと一致するかどうかを確認します。
verify_postcode
 verify_postcode string

提供した郵便番号がドキュメントと一致するかどうかを確認します。
country
 country string

指定した国で発行されたドキュメントかどうかを確認し、国が異なる場合はエラー コード 10 をスローします。 複数の値はコンマで区切ります。 たとえば "US,CA" は米国とカナダによるドキュメントを受け入れます。
地域
 region string

指定した都道府県で発行されたドキュメントかどうかを確認し、都道府県が異なる場合はエラー コード 11 をスローします。 複数の値はコンマで区切ります。 たとえば "CA,TX" はカリフォルニアとテキサスによるドキュメントを受け入れます。
type
 type string

ドキュメントが、指定した種類のうちの 1 つかどうかを確認し、種類が異なる場合はエラー コード 12 をスローします。 例えば、"PD" であればパスポートまたは運転免許所が許可されます。
checkblocklist
 checkblocklist boolean

Vault に含まれるブロック対象のエントリと、ドキュメントのデータを照合します。 ドキュメントがブロック対象のエントリと一致する場合は エラー 15 をスローします
vault_save
 vault_save boolean

セキュリティで保護された Vault にドキュメントの画像と解析された情報を保存します。 Vault API または Web ポータルを使用して、Vault 内のドキュメント エントリから一覧を作成、検索、または更新することができます。
vault_saveunrecognized
 vault_saveunrecognized boolean

ドキュメントを認識できない場合でも、ドキュメントの画像を Vault に保存します。
vault_noduplicate
 vault_noduplicate boolean

重複した画像が保存されるのを防ぎます。
vault_automerge
 vault_automerge boolean

同じドキュメント番号を持つ画像を、Vault 内の 1 件のエントリに自動でマージします。
vault_customdata1
 vault_customdata1 string

Vault エントリに関連付けるカスタム文字列を 5 つまで追加できます。これはエントリのフィルター処理や検索に使用できます。
vault_customdata2
 vault_customdata2 string

Vault エントリに関連付けるカスタム文字列を 5 つまで追加できます。これはエントリのフィルター処理や検索に使用できます。
vault_customdata3
 vault_customdata3 string

Vault エントリに関連付けるカスタム文字列を 5 つまで追加できます。これはエントリのフィルター処理や検索に使用できます。
vault_customdata4
 vault_customdata4 string

Vault エントリに関連付けるカスタム文字列を 5 つまで追加できます。これはエントリのフィルター処理や検索に使用できます。
vault_customdata5
 vault_customdata5 string

Vault エントリに関連付けるカスタム文字列を 5 つまで追加できます。これはエントリのフィルター処理や検索に使用できます。
aml_check
 aml_check boolean

ドキュメントの所有者名とドキュメント番号を、ID Analyzer AML データベースと照合します。
aml_database
 aml_database string

データベース コードをコンマで区切ります。例: un_sc、us_ofac。
aml_strict_match
 aml_strict_match boolean

このパラメーターを有効化すると、国籍と生年月日が完全に一致するエンティティのみを照合することで、誤検知を削減できます。
contract_generate
 contract_generate string

ユーザー データで自動入力する契約テンプレート ID です。
contract_format
 contract_format string

出力ドキュメントの形式です。 PDF、DOCX、HTML から選択できます。
contract_prefill_data
 contract_prefill_data object

戻り値

名前 パス 型 説明
documentNumber
 result.documentNumber string

ドキュメントに関連付けられている一意の識別子 (パスポート番号、運転免許証番号、カード番号など)
personalNumber
 result.personalNumber string

国内の個人に関連付けられている一意の個人 ID (例: 国民識別番号)
firstName
 result.firstName string

名
lastName
 result.lastName string

姓
middleName
 result.middleName string

ミドル ネーム
fullName
 result.fullName string

名と姓を判別できない場合は、代わりに氏名を返します
firstName_local
 result.firstName_local string

利用できる場合に、ローカル言語で表した名
lastName_local
 result.lastName_local string

利用できる場合は、ローカル言語で表した姓
middleName_local
 result.middleName_local string

利用できる場合は、ローカル言語で表したミドル ネーム
fullName_local
 result.fullName_local string

利用できる場合に、ローカル言語で表した氏名
性別
 result.sex string

性別: M=男性、F=女性、X=指定なし
高さ
 result.height string

身長
重量
 result.weight string

体重
hairColor
 result.hairColor string

髪の色 - ANSI D-20 髪の色コード (3 文字)
eyeColor
 result.eyeColor string

目の色 - ANSI D-20 目の色コード (3 文字)
年齢
 result.age integer

ドキュメント所有者の年齢
dob
 result.dob string

生年月日 (YYYY/MM/DD 形式)
dob_day
 result.dob_day integer

生年月日の日 1 ～ 31
dob_month
 result.dob_month integer

生年月日の月 1 ～ 12
dob_year
 result.dob_year integer

YYYY 形式で表した生年月日の年
有効期限
 result.expiry string

YYYY/MM/DD で表したドキュメントの有効期限
expiry_day
 result.expiry_day integer

有効期限 1 ～ 31
expiry_month
 result.expiry_month integer

有効期限の月 1～12
expiry_year
 result.expiry_year integer

有効期限の年 (YYYY)
daysToExpiry
 result.daysToExpiry integer

ドキュメントが期限切れになるまでの日数
発行済み
 result.issued string

YYYY/MM/DD 形式で表した発行日
issued_day
 result.issued_day integer

発行日 1 ～ 31
issued_month
 result.issued_month integer

発行した月 1～12
issued_year
 result.issued_year integer

発行年 (YYYY)
daysFromIssue
 result.daysFromIssue integer

ドキュメントの発行日からの日数
住所 1
 result.address1 string

住所 1
住所 2
 result.address2 string

住所行 2
郵便番号
 result.postcode string

住所の郵便番号
placeOfBirth
 result.placeOfBirth string

出生地
vehicleClass
 result.vehicleClass string

運転免許証の車両クラス
制限
 result.restrictions string

運転免許証の制限
裏書き
 result.endorsement string

運転免許証の裏書き
optionalData
 result.optionalData string

ドキュメントに含まれている余分な不特定データ
optionalData2
 result.optionalData2 string

ドキュメントに含まれている余分な不特定データ
documentType
 result.documentType string

ドキュメントの種類: P=パスポート、D=運転免許証、I=ID カード、V=Visa、R=在留カード、O=その他
documentSide
 result.documentSide string

ドキュメントの面: FRONT、BACK、または BIODATA
issuerOrg_region_full
 result.issuerOrg_region_full string

ドキュメント発行者の小地域/都道府県です。 (例: カリフォルニア)
issuerOrg_region_abbr
 result.issuerOrg_region_abbr string

ドキュメント発行者の小地域/都道府県の略称です。 (例: CA)
issuerOrg_full
 result.issuerOrg_full string

ドキュメントの発行国。 (例: 米国)
issuerOrg_iso2
 result.issuerOrg_iso2 string

ISO2 の国コードで表したドキュメントの発行国。 (例: US)
issuerOrg_iso3
 result.issuerOrg_iso3 string

ISO3 の国コードで表したドキュメントの発行国。 (例: USA)
nationality_full
 result.nationality_full string

ドキュメント所有者の国籍。 (例: 米国)
nationality_iso2
 result.nationality_iso2 string

ISO2 で表したドキュメント所有者の国籍。 (例: US)
nationality_iso3
 result.nationality_iso3 string

ISO3 で表したドキュメント所有者の国籍。 (例: USA)
internalId
 result.internalId string

ID アナライザーのシステムで、一意のドキュメント ID を識別するために使用します。種類が同じドキュメントは ID も同じである必要があります。
documentNumber
 confidence.documentNumber float

documentNumber の信頼度
firstName
 confidence.firstName float

firstName の信頼度
lastName
 confidence.lastName float

姓/苗字の信頼度
middleName
 confidence.middleName float

ミドル ネームの信頼度
dob_month
 confidence.dob_month float

dob_month の信頼度
dob_day
 confidence.dob_day float

dob_day の信頼度
dob_year
 confidence.dob_year float

dob_year の信頼度
issued_month
 confidence.issued_month float

issued_month の信頼度
issued_day
 confidence.issued_day float

issued_day の信頼度
issued_year
 confidence.issued_year float

issued_year の信頼度
expiry_month
 confidence.expiry_month float

expiry_month の信頼度
expiry_day
 confidence.expiry_day float

expiry_day の信頼度
expiry_year
 confidence.expiry_year float

expiry_year の信頼度
性別
 confidence.sex float

性別の信頼度
高さ
 confidence.height float

高さの信頼度
重量
 confidence.weight float

重さの信頼度
住所 1
 confidence.address1 float

住所 1 の信頼度
住所 2
 confidence.address2 float

住所 2 の信頼度
郵便番号
 confidence.postcode float

郵便番号の信頼度
vehicleClass
 confidence.vehicleClass float

vehicleClass の信頼度
制限
 confidence.restrictions float

制限の信頼度
裏書き
 confidence.endorsement float

裏書きの信頼度
eyeColor
 confidence.eyeColor float

eyeColor の信頼度
年齢
 confidence.age float

年齢の信頼度
dob
 confidence.dob float

生年月日の信頼度
daysToExpiry
 confidence.daysToExpiry float

daysToExpiry の信頼度
有効期限
 confidence.expiry float

有効期限の信頼度
発行済み
 confidence.issued float

発行済みの信頼度
daysFromIssue
 confidence.daysFromIssue float

daysFromIssue の信頼度
fullName
 confidence.fullName float

fullName の信頼度
isIdentical
 face.isIdentical boolean

生体認証の結果: 成功または失敗
信頼度
 face.confidence string

2 つの顔の類似度を示す 0 ～ 1 の値です。完全に一致すれば 1 になります。
エラー
 face.error integer

エラー コード
error_message
 face.error_message string

エラー メッセージ。 例: 顔の画像から顔のデータが見つかりません
合格
 verification.passed boolean

ドキュメントがすべての検証に合格した場合、true を返します。 少なくとも 1 つの検証タイプにドキュメントが失敗した場合、false を返します。
顔
 verification.result.face boolean

生体認証を有効化した場合に、類似の信頼度スコアが、設定済みのしきい値を超えているかどうか。
notexpired
 verification.result.notexpired boolean

ドキュメントが期限切れでないかどうかを示します。
name
 verification.result.name boolean

指定された名前が ID から解析された名前と一致するかどうかを示します。
dob
 verification.result.dob boolean

指定された生年月日が ID から解析された生年月日と一致するかどうかを示します。
documentNumber
 verification.result.documentNumber boolean

指定されたドキュメント番号が ID から解析されたドキュメント番号と一致するかどうかを示します。
郵便番号
 verification.result.postcode boolean

指定された郵便番号が ID から解析された郵便番号と一致するかどうかを示します。
address
 verification.result.address boolean

指定された住所が ID から解析された住所と一致するかどうかを示します。
checkdigit
 verification.result.checkdigit boolean

ドキュメントの種類にチェック ディジット/SOUNDEX アルゴリズムがある場合は、チェック ディジットが有効かどうかを示します。
年齢
 verification.result.age boolean

ドキュメントの所有者が設定された年齢範囲内かどうかを示します。
cccode
 verification.result.cccode boolean

ドキュメントの種類に中国商用コード (CC コード) の実装がある場合は、CC コードが有効かどうかを示します。
スコア
 authentication.score float

スコアは 0～1 のフロート値になります。 有効なドキュメントのスコアは 1 に近づき、偽物や編集済みのドキュメントのスコアは 0 に近づきます。 境界はユーザーの裁量で決定できます。まず最初は 0.5 未満のスコアを拒否することを推奨します
合格
 authentication.breakdown.data_visibility.passed boolean
合格
 authentication.breakdown.image_quality.passed boolean
合格
 authentication.breakdown.feature_referencing.passed boolean
合格
 authentication.breakdown.exif_check.passed boolean
code
 authentication.breakdown.exif_check.code integer
reason
 authentication.breakdown.exif_check.reason string
重要度
 authentication.breakdown.exif_check.severity string
合格
 authentication.breakdown.publicity_check.passed boolean
code
 authentication.breakdown.publicity_check.code integer
reason
 authentication.breakdown.publicity_check.reason string
重要度
 authentication.breakdown.publicity_check.severity string
合格
 authentication.breakdown.text_analysis.passed boolean
合格
 authentication.breakdown.biometric_analysis.passed boolean
合格
 authentication.breakdown.security_feature_check.passed boolean
code
 authentication.breakdown.security_feature_check.code integer
reason
 authentication.breakdown.security_feature_check.reason string
重要度
 authentication.breakdown.security_feature_check.severity string
合格
 authentication.breakdown.recapture_check.passed boolean
code
 authentication.breakdown.recapture_check.code integer
reason
 authentication.breakdown.recapture_check.reason string
重要度
 authentication.breakdown.recapture_check.severity string
警告
 authentication.warning array of string

ドキュメントの有効性に関する警告メッセージを含む、文字列の配列。
aml
 aml array of object

AML の一致の一覧を含む配列です。一致が見つからない場合は、空の配列を返します。 詳細については、AML API リファレンスをご覧ください。
エンティティ
 aml.entity string

個人または法人
fullname
 aml.fullname array of string

個人または法人の名前
firstname
 aml.firstname array of string

個人の名
lastname
 aml.lastname array of string

個人の姓
middlename
 aml.middlename array of string

個人のミドル ネーム
エイリアス
 aml.alias array of string

エンティティの代替名または外部名です
dob
 aml.dob array of string

個人の生年月日。YYYY、YYYY-MM、または YYYY-MM-DD の形式で入力できます。
address
 aml.address array of string

エンティティの住所または居住国
国籍
 aml.nationality array of string

エンティティの国または国籍
出生地
 aml.birthplace array of string

個人の出生地
性別
 aml.gender array of string

個人の性別: M または F
documentnumber
 aml.documentnumber array of object

エンティティに関連付けられているドキュメントの一覧です。
id
 aml.documentnumber.id string

ドキュメント番号
id_formatted
 aml.documentnumber.id_formatted string

英数字のドキュメント番号
country
 aml.documentnumber.country string

ISO2 国コード
type
 aml.documentnumber.type string

P = パスポート番号、I = ID 番号、D = 運転免許証番号、O = その他/不明な種類のドキュメント
プログラム
 aml.program array of string

認可プログラム
メモ
 aml.note array of string

エンティティへの追加メモ
時刻
 aml.time string

エンティティがソース一覧に追加された時刻、または最後に更新された時刻の UTC TZ タイムスタンプ
ステータス
 aml.status string

エンティティの職位/役職、または認可の現在の状態
source
 aml.source array of string

正式なソース URL の一覧
データベース
 aml.database string

ID アナライザーの AML データベース コード
スキーマ
 aml.schema string
document_url
 contract.document_url string

生成されたドキュメントの URL
エラー
 contract.error string

契約の生成に失敗した場合、このフィールドには「契約テンプレート ID が無効」などの理由が入力されます。
vaultid
 vaultid string

vault_save が有効な場合に Vault エントリを表す一意の識別子です。
matchrate
 matchrate float

API によって正常に認識されたフィールドの比率です。比率が低い場合、ドキュメントの画像がぼやけている可能性があります。
出力
 output string

outputimage を true に設定して outputmode が url の場合、このフィールドは切り出したドキュメントの画像を示す URL (または両面スキャンの URL の配列) を含みます。 このリンクの有効性が保証されるのは 600 秒間のみで、その後順次削除されます。
outputface
 outputface string

outputface を true に設定して outputmode が url の場合、このフィールドは切り出した顔画像を示す URL を含みます。 このリンクの有効性が保証されるのは 600 秒間のみで、その後順次削除されます。
切り取り
 cropped string

outputimage を true に設定して outputmode が base64 の場合、このフィールドは切り出したドキュメントの base64 でエンコードした JPEG 形式の画像 (または両面スキャンの base64 でエンコードした画像の配列) を含みます
croppedface
 croppedface string

outputface を true に設定して outputmode が base64 の場合に、このフィールドはドキュメントから切り出した顔領域を base64 でエンコードした JPEG 形式の画像を含みます。
executionTime
 executionTime float

API 操作にかかった時間 (秒) です。
responseID
 responseID string

要求/応答を識別する一意の識別子です。
クォータ
 quota integer

API クォータの残量です。無料または年単位のサブスクライバーの場合は毎月初日にリセットされ、月単位のサブスクライバーの場合は各請求サイクルの初日にリセットされます。 サブスクリプション プランをお持ちの場合は、月単位のクォータがクレジットの前に使用されます。
クレジット
 credit integer

ご使用のアカウントのテスト クレジット残量です。 サブスクリプション プランをお持ちの場合は、月単位のクォータがクレジットの前に使用されます。

DocuPass セッションを作成しています

操作 ID:
CreatingDocuPass

ID 検証を要求するすべてのユーザーに対して検証セッションを作成できます。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
type
 type integer

0: Iframe モジュール、1: モバイル モジュール、2: リダイレクト モジュール、3: ライブ モバイル モジュール
companyname
 companyname True string

自分の会社名または製品名です。
callbackurl
 callbackurl string

検証結果を受け取る Webhook/コールバック URL です。
生体認証
 biometric integer

顔を検証するために、セルフィー写真やセルフィー ビデオの撮影をユーザーに依頼します。
biometric_threshold
 biometric_threshold float

顔の生体認証に合格するための最小スコアを指定する
authenticate_minscore
 authenticate_minscore float

ドキュメントが検証に合格するためには、最小の信頼性スコアを満たす必要があります。 有効性/信頼性の確認を無効かする場合は 0 を設定します。
authenticate_module
 authenticate_module integer

ドキュメントの検証に使用するモジュールを指定します。
maxattempt
 maxattempt integer

1 回の検証要求の最大失敗許容回数です。
successredir
 successredir string

ID 認証に成功した場合、この URL にブラウザーがリダイレクトされます。
failredir
 failredir string

ID 認証に失敗した場合、この URL にブラウザーがリダイレクトされます。
customid
 customid string

データベースでユーザーを識別するために使用します。 この値は Vault の docupass_customid に保存されます。
再利用可能
 reusable boolean

このパラメーターを有効化すると、複数のユーザーが同じ URL で自分の ID を確認できるようになり、新しい DocuPass 参照コードがユーザーごとに自動で生成されます。
phoneverification
 phoneverification boolean

検証の際にユーザーに電話番号の入力を要求するかどうかを示します。DocuPass ではモバイルと固定電話のどちらの番号でも検証できます。 (サブスクライバーのみ)
documenttype
 documenttype string

ユーザーは指定された種類のドキュメントをアップロードする必要があります。 例えば、"PD" であればパスポートまたは運転免許所が許可されます。
documentcountry
 documentcountry string

ISO ALPHA-2 国コード。
documentregion
 documentregion string

都道府県/地域の完全名または略名です。
dualsidecheck
 dualsidecheck boolean

両面スキャンを実行する際に、ドキュメントの名前、番号、および種類がドキュメントの表面と裏面で一致していることを確認してください。 一致しない情報がある場合、エラー 14 がスローされます。
verify_expiry
 verify_expiry boolean

期限切れではないドキュメントのみを受け取る
verify_documentno
 verify_documentno string

検証が必要なドキュメント番号。
verify_name
 verify_name string

検証が必要な、名と姓を含む氏名。
verify_dob
 verify_dob string

YYYY/MM/DD 形式で表した、検証が必要な生年月日。
verify_age
 verify_age string

年齢の範囲。例: 18 ～ 40
verify_address
 verify_address string

検証が必要な完全な住所。
verify_postcode
 verify_postcode string

検証が必要な、完全な郵便番号。
verify_phone
 verify_phone string

検証が必要な、完全な電話番号。
vault_save
 vault_save boolean

ユーザー ドキュメントと解析された情報を Vault に保存します。
return_documentimage
 return_documentimage boolean

コールバック要求でユーザーがアップロードしたドキュメント画像を返します。
return_faceimage
 return_faceimage boolean

コールバック要求でユーザーがアップロードした顔画像を返します。
return_type
 return_type integer

返される画像の種類 (base64 エンコードの画像コンテンツ、または画像 URL) を指定します。 (画像 URL は 7 日間のみ保存されます)
welcomemessage
 welcomemessage string

最初のページの汎用挨拶文を、自作のテキストに置き換えます (最大 1,000 文字)
nobranding
 nobranding boolean

DocuPass の全ページでブランド ロゴを非表示にします。 (サブスクライバーのみ)
ロゴ
 logo string

カスタム ブランド ロゴ。 (サブスクライバーのみ)
customhtmlurl
 customhtmlurl string

DocuPass に独自の HTML ページと CSS を使用します。 (サブスクライバーのみ)
language
 language string

DocuPass はユーザー デバイスの言語を自動で検出し、対応する言語で表示します。
有効期限
 expiry integer

DocuPass セッションが期限切れになるまでの秒数です。 期限切れになると、ユーザーは現在のセッションを継続できず、エラー コールバックが送信されます。
qr_color
 qr_color string

QR コードの表示に使用する色。 (ライブ モバイルと標準モバイルのみ)
qr_bgcolor
 qr_bgcolor string

QR コードの背景に使用する色。 (ライブ モバイルと標準モバイルのみ)
qr_size
 qr_size integer

QR コードのサイズ (1～50)。 (ライブ モバイルと標準モバイルのみ)
qr_margin
 qr_margin integer

QR コードに使用する境界線の太さ (1～50)。 (ライブ モバイルと標準モバイルのみ)

戻り値

名前 パス 型 説明
reference
 reference string

DocuPass セッションを表す一意の参照コードです。
type
 type integer

DocuPass モジュール タイプを作成しました。
customid
 customid string

DocuPass セッションの作成時に使用されるカスタム ID です。
url
 url string

DocuPass Web アプリへの一意の URL です。 ID の検証を開始するには、このリンクをユーザーに送信するか、リンクを Web サイトまたはモバイル アプリに埋め込む必要があります。
qrcode
 qrcode string

ユーザーがスキャンできる URL の QR コードの画像
base_url
 base_url string

このリンクをユーザーに送信し、参照コードの入力を要求して検証を開始することができます。
HTML
 html string

HTML のサンプルです。Web ページに挿入できます。
smssent
 smssent integer

sms_verification_link パラメーターで SMS を正常に送信した場合、確認として電話番号を含みます。
有効期限
 expiry integer

このセッションが期限切れになる時刻を示す UTC UNIX タイムスタンプです。期限切れになると、ユーザーはリンクを使用できなくなり、エラー コールバックが送信されます。

DocuPass 署名セッションを作成しています

操作 ID:
CreatingDocuPassSignatureSession

ユーザーが ID 検証なしで法的ドキュメントのレビューおよび電子署名を行うように署名セッションを作成できます。 ユーザーの ID 検証を実行してからドキュメントの署名を許可する場合は、ID 検証のセッションを作成してください。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
companyname
 companyname True string

自分の会社名が検証ページに表示されるため、自分の会社の ID 情報を送信していることをエンド ユーザーが確認できます
template_id
 template_id string

ユーザー データで自動入力する契約テンプレート ID です。
contract_format
 contract_format string

出力ドキュメントの形式です。 (PDF、DOCX、HTML)
callbackurl
 callbackurl string

この URL に契約ファイルを送信します。 生成したドキュメントを保存するために、vault_save を有効にするか、callbackurl を指定する必要があります。
successredir
 successredir string

ドキュメントの確認と署名が完了すると、この URL にブラウザーがリダイレクトされます。 DocuPass 参照コードと customid が URL の末尾に追加されます
customid
 customid string

サーバーのコールバック URL に送信するカスタム文字列。これを successredir と failredir でクエリ文字列として設定したリダイレクト URL に追加し、データベースでユーザーを識別する際に使用します。 データベースでユーザーを識別するために使用します。 この値は Vault の docupass_customid に保存されます。
再利用可能
 reusable boolean

このパラメーターを有効にすると、複数のユーザーが同じ URL でドキュメントのレビューおよび署名を行えるようになり、新しい DocuPass 参照コードがユーザーごとに自動で生成されます。
sms_contract_link
 sms_contract_link string

モバイルの完全な国際電話番号
vault_save
 vault_save boolean

生成されたドキュメントを Vault に保存します。 生成したドキュメントを保存するために、vault_save を有効にするか、callbackurl を指定する必要があります。
nobranding
 nobranding boolean

DocuPass の全ページでブランド ロゴを非表示にします。
customhtmlurl
 customhtmlurl string

DocuPass に独自の HTML ページと CSS を使用します。 HTML と CSS を変更した場合は、それを自身のサーバーにアップロードすることで、各セッションの最初に DocuPass が最新の HTML ページをサーバーからダウンロードする必要があります。
language
 language string

DocuPass はユーザー デバイスの言語を自動で検出し、対応する言語で表示します。 自動言語検出をオーバーライドする場合は、このパラメーターを設定します。(en、fr、nl、de、es、zh-TW、zh-CN)
有効期限
 expiry integer

DocuPass セッションが期限切れになるまでの秒数です。 期限切れになると、ユーザーは現在のセッションを継続できず、エラー コールバックが送信されます。
qr_color
 qr_color string

QR コードの表示に使用する色
qr_bgcolor
 qr_bgcolor string

QR コードの背景に使用する色
qr_size
 qr_size integer

QR コードのサイズ
qr_margin
 qr_margin integer

QR コードに使用する境界線の太さ

戻り値

名前 パス 型 説明
reference
 reference string

DocuPass セッションを表す一意の参照コードです。
customid
 customid string

DocuPass セッションの作成時に使用されるカスタム ID です。
url
 url string

DocuPass Web アプリへの一意の URL です。 ドキュメントをレビューおよび署名するには、このリンクをユーザーに送信するか、リンクを Web サイトまたはモバイル アプリに埋め込む必要があります。
qrcode
 qrcode string

ユーザーがスキャンできる URL の QR コードの画像
base_url
 base_url string

このリンクをユーザーに送信し、参照コードの入力を要求してドキュメントに署名することができます。
html_qrcode
 html_qrcode string

Web ページに QR コードを表示する HTML のサンプルです。
html_iframe
 html_iframe string

iframe を Web ページに挿入する HTML のサンプルです。
smssent
 smssent string

sms_contract_link パラメーターで SMS を正常に送信した場合、確認として電話番号を含みます。
有効期限
 expiry integer

このセッションが期限切れになる時刻を示す UTC UNIX タイムスタンプです。期限切れになると、ユーザーはリンクを使用できなくなり、エラー コールバックが送信されます。

Vault からエントリを削除する

操作 ID:
DeleteVaultEntry

HTTP POST リクエストを発行すると、1 件以上の Vault エントリを削除できます。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
id
 id True array of string

id

戻り値

名前 パス 型 説明
成功
 success integer

Vault から画像を削除する

操作 ID:
DeleteImageFromVault

Vault エントリから画像を削除する場合は、HTTP POST リクエストを発行します。 メモ: 画像を削除しても、キャッシュの影響で画像の URL に短期間アクセスできる可能性があります。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
id
 id True string

画像を含む Vault エントリの識別子。
imageid
 imageid string

削除する画像の ID。

戻り値

名前 パス 型 説明
成功
 success integer

Vault に画像を追加する

操作 ID:
AddImageToVault

HTTP POST 要求を作成し、画像をアップロードして既存の Vault エントリに追加できます。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
id
 id True string

画像を追加する Vault エントリ識別子
type
 type True string

画像の種類を設定します。0=ドキュメント、1=個人
画像
 image string

Base64 エンコードされた画像データです。
imageurl
 imageurl string

リモート画像の URL です。

戻り値

名前 パス 型 説明
成功
 success integer
id
 image.id string

画像識別子
type
 image.type string

ドキュメントは 0、ユーザーは 1 です
ハッシュ
 image.hash string

画像の MD5 ハッシュ
url
 image.url string

画像の URL
作成時間
 image.createtime string

時刻の画像が UTC でアップロードされました

Vault のエントリ コンテンツを取得する

操作 ID:
GetVault

エントリに Vault を追加すると、Core API と DocuPass API の両方が vaultid という名前の Vault エントリ識別子を返します。 この識別子を使用して Vault エントリのコンテンツをクエリする場合は、次のエンドポイントに HTTP POST リクエストを送信します。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
id
 id string

Vault エントリの識別子です。

戻り値

名前 パス 型 説明
成功
 success integer
id
 data.id string

Vault エントリ識別子
作成時間
 data.createtime string

エントリ作成のタイムスタンプ (UTC)
updatetime
 data.updatetime string

前回の修正のタイムスタンプ (UTC)
trustlevel
 data.trustlevel string

認証が有効な場合に、このスコアが自動的に計算されます。 (0: 未定義、1: 無効なドキュメント、2: 疑わしい、3: 有効)
trustnote
 data.trustnote string

ドキュメントの有効性に関する警告です。
docupass_reference
 data.docupass_reference string

DocuPass セッションへの参照コード
docupass_success
 data.docupass_success string

DocuPass の検証について成功か失敗かを示す 0 または 1 です。
docupass_failedreason
 data.docupass_failedreason string

DocuPass の検証に失敗した場合の、失敗の理由です。
docupass_customid
 data.docupass_customid string

DocuPass の検証の作成時に customid が渡されました。
documentNumber
 data.documentNumber string

ドキュメントを表す一意識別子 (パスポート番号や運転免許証番号 など)
documentNumber_formatted
 data.documentNumber_formatted string

自動生成された documentNumber の記号を含まない文字列。このフィールドは結果のフィルターに使用します。
personalNumber
 data.personalNumber string

ドキュメントのセカンダリ ID 番号
firstName
 data.firstName string

名
middleName
 data.middleName string

ミドル ネーム
lastName
 data.lastName string

姓
fullName
 data.fullName string

氏名 (他の名前フィールドを更新しても fullName は更新されません)
firstName_local
 data.firstName_local string

ローカル言語で表した名
middleName_local
 data.middleName_local string

ローカル言語で表したミドル ネーム
lastName_local
 data.lastName_local string

ローカル言語で表した姓
fullName_local
 data.fullName_local string

ローカル言語で表した氏名
dob
 data.dob string

誕生日
発行済み
 data.issued string

発行日
有効期限
 data.expiry string

有効期限
性別
 data.sex string

M: 男性、F: 女性、X: 指定なし
高さ
 data.height string

身長
重量
 data.weight string

体重
hairColor
 data.hairColor string

髪の色
eyeColor
 data.eyeColor string

目の色
住所 1
 data.address1 string

住所 1
住所 2
 data.address2 string

住所行 2
郵便番号
 data.postcode string

住所の郵便番号
placeOfBirth
 data.placeOfBirth string

出生地
documentType
 data.documentType string

P: パスポート、D: 運転免許証、I: ID カード、V: Visa、R: 在留カード、O: その他
documentName
 data.documentName string

ドキュメントの名前
vehicleClass
 data.vehicleClass string

運転免許証に記載された車両の分類
制限
 data.restrictions string

運転の制限
裏書き
 data.endorsement string

運転免許証の裏書き
email
 data.email string

ユーザーのメール アドレス
携帯電話
 data.mobile string

ユーザーの携帯電話番号
固定回線
 data.landline string

ユーザーの固定電話の電話番号
issueAuthority
 data.issueAuthority string

ドキュメントの発行機関
issuerOrg_region_full
 data.issuerOrg_region_full string

ドキュメント発行者の小地域/都道府県です。 例: カリフォルニア
issuerOrg_region_abbr
 data.issuerOrg_region_abbr string

ドキュメント発行者の小地域/都道府県の略称です。 例: CA
issuerOrg_iso2
 data.issuerOrg_iso2 string

ISO2 の国コードで表したドキュメントの発行国。 例: US
nationality_iso2
 data.nationality_iso2 string

ISO2 で表したドキュメント所有者の国籍。 例: US
optionalData
 data.optionalData string

ドキュメントに含まれている余分な不特定データ
optionalData2
 data.optionalData2 string

ドキュメントに含まれている余分な不特定データ
customdata1
 data.customdata1 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列
customdata2
 data.customdata2 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列
customdata3
 data.customdata3 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列
customdata4
 data.customdata4 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列
customdata5
 data.customdata5 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列
ブロック
 data.block string

同じドキュメントが Core API または DocuPass に送信されないようブロックするには、このパラメーターを設定します。
契約
 data.contract string

Core API や DocuPass を使用して生成/署名した契約書または法的ドキュメントへのリンク
画像
 data.image array of object

エントリに関連付けられている画像の一覧を含みます。
id
 data.image.id string

画像識別子
type
 data.image.type string

ドキュメントは 0、ユーザーは 1 です
ハッシュ
 data.image.hash string

画像の MD5 ハッシュ
url
 data.image.url string

画像の URL
作成時間
 data.image.createtime string

時刻の画像が UTC でアップロードされました

Vault エントリを更新する

操作 ID:
UpdateVaultEntry

HTTP POST 要求を作成し、Vault エントリの複数のフィールドから 1 つのフィールドまたは値を更新できます。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
id
 id True string

Vault エントリの識別子です。
住所 1
 address1 string

住所 1。
住所 2
 address2 string

住所 2。
ブロック
 block string

同じドキュメントが Core API または DocuPass に送信されないようブロックするには、このパラメーターを設定します。 0: ブロックなし 1: ドキュメント番号をブロック 2: 名/姓をブロック 3: ドキュメント番号と名/姓の両方をブロック。
customdata1
 customdata1 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列です。
customdata2
 customdata2 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列です。
customdata3
 customdata3 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列です。
customdata4
 customdata4 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列です。
customdata5
 customdata5 string

カスタム メモをエントリに追加するために使用できる 5 つのカスタム文字列です。
dob
 dob string

誕生日 (YYYY-MM-DD)。
documentName
 documentName string

ドキュメントの名前。
documentNumber
 documentNumber string

ドキュメントを表す一意識別子 (パスポート番号や運転免許証番号 など)
documentType
 documentType string

P: パスポート D: 運転免許証 I: ID カード V: Visa R: 在留カード O: その他
docupass_customid
 docupass_customid string

DocuPass の検証の作成時に customid が渡されました。
docupass_failedreason
 docupass_failedreason string

DocuPass の検証に失敗した場合の、失敗の理由です。
docupass_reference
 docupass_reference string

DocuPass セッションへの参照コードです。
docupass_success
 docupass_success string

DocuPass の検証について成功か失敗かを示す 0 または 1 です。
email
 email string

ユーザーのメール アドレス。
有効期限
 expiry string

有効期限 (YYYY-MM-DD)
eyeColor
 eyeColor string

目の色。
firstName
 firstName string

名
firstName_local
 firstName_local string

ローカル言語での名です。
fullName
 fullName string

氏名 (他の名前フィールドを更新しても fullName は更新されません)
fullName_local
 fullName_local string

ローカル言語での名です。
hairColor
 hairColor string

髪の色。
高さ
 height string

人物の身長。
issueAuthority
 issueAuthority string

ドキュメントの発行機関。
発行済み
 issued string

発行日 (YYYY-MM-DD)
issuerOrg_iso2
 issuerOrg_iso2 string

ISO2 の国コードで表したドキュメントの発行国。 例: US
issuerOrg_region_abbr
 issuerOrg_region_abbr string

ドキュメント発行者の小地域/都道府県の略称です。 例: CA
issuerOrg_region_full
 issuerOrg_region_full string

ドキュメント発行者の小地域/都道府県です。 例: カリフォルニア
固定回線
 landline string

ユーザーの固定電話の電話番号です。
lastName
 lastName string

姓 / 苗字。
lastName_local
 lastName_local string

ローカル言語で表した姓。
middleName
 middleName string

ミドル ネーム。
middleName_local
 middleName_local string

ローカル言語で表したミドル ネーム。
携帯電話
 mobile string

ユーザーの携帯電話番号。
nationality_iso2
 nationality_iso2 string

ISO2 で表したドキュメント所有者の国籍。 例: US
optionalData
 optionalData string

ドキュメントに含まれている余分な不特定データです。
optionalData2
 optionalData2 string

ドキュメントに含まれている余分な不特定データです。
personalNumber
 personalNumber string

ドキュメントのセカンダリ ID 番号。
placeOfBirth
 placeOfBirth string

出生地。
郵便番号
 postcode string

住所の郵便番号。
制限
 restrictions string

運転の制限。
性別
 sex string

M=男性、F=女性、X=指定なし
trustlevel
 trustlevel string

0: 未定義、1: 無効なドキュメント、2: 疑わしい、3: 有効。認証を有効化すると、このスコアを自動で計算します。
trustnote
 trustnote string
vehicleClass
 vehicleClass string

運転免許証に記載された車両の分類。
重量
 weight string

ユーザーの体重。

戻り値

名前 パス 型 説明
成功
 success integer

エントリの一覧表示とフィルター

操作 ID:
ListVaultEntries

Vault 内部に保存されているすべてのエントリの一覧を表示するか、特定の値を持つエントリを検索するには、HTTP POST 要求を次のエンドポイントに送信します。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
orderby
 orderby string

結果の並べ替えに使用されるフィールドの名前です。
並べ替え
 sort string

結果を、ASC で昇順に並べ替え、DESC で降順に並べ替えます。
limit
 limit integer

返される Vault エントリの数。 (1～100)
offset
 offset integer

特定のエントリから始まる一覧を返します。例えば limit=10 の場合に結果の 3 ページ目にアクセスするには offset=20 を使用します
filter
 filter array of string

filter

戻り値

名前 パス 型 説明
制限
 limit integer

現在の制限
offset
 offset integer

現在のオフセット
nextoffset
 nextoffset integer

次のデータ セットのオフセット値です。 現在のデータ セットが最後のデータ セットである場合、このフィールドは返されません。
total
 total integer

見つかったエントリの合計数。
items
 items array of

見つかったエントリの配列と、そのすべてのコンテンツ。GET メソッドが返すコンテンツと一致します。

コールバックの検証中

操作 ID:
ValidatingCallback

データがこのサーバーから送信されたことを確認するために使用します。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
reference
 reference True string

POST BODY で受信した参照コードです。
ハッシュ
 hash True string

POST BODY で受信したハッシュです。

戻り値

名前 パス 型 説明
成功
 success boolean
reference
 reference string

DocuPass セッションの参照コード

トレーニングの状態

操作 ID:
TrainingStatus

Vault のトレーニングが現在進行中か、完了済みかを確認します。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。

戻り値

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

nottrained: トレーニングが実行されていない、notstarted: トレーニングが実行中ではない、running: トレーニングが現在実行中である、succeeded: トレーニングが成功した、failed: トレーニングが失敗した
startTime
 startTime string

トレーニングが前回開始された時刻 (UTC) です。
statusChangeTime
 statusChangeTime string

状態が最後に変更された時刻 (UTC) です。
lastSuccessTime
 lastSuccessTime string

トレーニングが最後に成功した時刻 (UTC) です。
エラー
 error string

失敗したトレーニング状態に関連するエラー メッセージ。

顔検索

操作 ID:
FaceSearch

顔検索を使用すると、人物の画像を使用して Vault 全体を検索します。 顔検索機能を使用する場合は、Web ポータルから顔検索インデックスを有効化して、Vault のデータセットを定期的にトレーニングする必要があります。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。
画像
 image string

Base64 エンコードされた画像データです。
imageurl
 imageurl string

リモート画像の URL です。
maxentry
 maxentry integer

一致するエントリの数。1 ～ 10 の値で返されます。
しきい値
 threshold float

顔の最小類似度スコアを 0 ～ 1 の範囲で設定する必要があります。

戻り値

名前 パス 型 説明
items
 items array of

一致するエントリが見つかった場合、リスト コマンドと同様に、完全なコンテンツを含むドキュメントの一覧を返します。

顔検索のトレーニング

操作 ID:
FaceSearchTraining

顔検索を実行する前に、トレーニング コマンドを発行して Vault 内のドキュメント データセットをトレーニングする必要があります。 また、Web ポータルから Vault のデータをトレーニングすることもできます。 このトレーニング タスクは非同期であり、トレーニング時間は Vault が含むエントリと画像の件数によって異なります。 数秒から 1 時間程度かかる可能性があります。

パラメーター

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

プライベート API キーを Web ポータルで使用できます。

戻り値

名前 パス 型 説明
成功
 success integer