ID 分析器 (預覽版)
ID Analyzer 提供多種不同的身份驗證產品,您需要了解每種產品的基本知識,以便為您的應用選擇最佳解決方案。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | ID 分析器支援 |
| URL | https://www.idanalyzer.com/contact.html |
| support@idanalyzer.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 埃維斯技術 |
| 網站 | https://www.idanalyzer.com/ |
| 隱私策略 | https://www.idanalyzer.com/privacy-policy.html |
| 類別 | IT運營;生產力 |
ID Analyzer 平台為企業、組織和個人提供真正的全球身份驗證解決方案,無國界運作,可根據您的特定需求和要求量身定制的解決方案,以及不斷升級和改進的安全系統。
在全球 190+ 個國家/地區提供超過 4000+ 種不同形式的 ID 的完整身份驗證訪問和信息,這在很大程度上是一個專為現代世界而設計的全球解決方案。
先決條件
- 具有 ID Analyzer 的開發人員帳戶。 您可以在註冊中註冊一個免費帳戶
- 註冊帳戶後,您將在 ID Analyzer 的 門戶網站中獲得一個 API 密鑰。 使用此 API 金鑰向連接器進行驗證
如何取得認證
- 導航至 註冊
- 輸入所需資訊。
- 當出現提示時驗證您的電子郵件。
- 您將在 ID Analyzer 的 入口網站 中看到您的新 API 金鑰以及您的帳戶詳細資訊。 按「複製」按鈕將其儲存到剪貼簿以供以後使用。
FAQ
我擔心客戶的隱私,API 會保存有關我客戶的信息嗎?
所有內容將僅存儲在客戶端的金庫中,不會被任意洩露。 它在其他地方不會有任何副本。
「積分」有什麼用,如何購買 API 積分?
您帳戶的剩餘預付信用額度。 如果您有月度計劃,您的每月配額將在預付積分之前使用。
如何檢查文件是真的還是假的?
開啟身份驗證,結果將包含身份驗證分數。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API API 金鑰 | securestring | 此 API 的 API 金鑰 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 人臉搜索訓練 |
在執行臉部搜尋之前,您必須發出訓練指令來訓練 Vault 內的文件資料集。 您也可以透過入口網站訓練您的保管庫資料。 訓練任務是非同步的,訓練時間取決於儲存庫項目和映像的數量。 這可能需要幾秒鐘到一個小時。 |
| 列出和篩選項目 |
若要列出儲存在保存庫內的所有項目,或搜尋具有特定值的項目,請將 HTTP POST 要求傳送至下列端點。 |
| 取得保管庫條目內容 |
將項目新增至保存庫時,Core API 和 DocuPass API 都會傳回名為 vaultid 的保存庫項目識別碼。 您可以使用 ID 將 HTTP POST 要求提交至下列端點,以查詢保存庫中項目的內容。 |
| 將影像新增至 Vault |
您可以上傳影像,並透過發出 HTTP POST 要求,將它新增至現有的儲存庫項目。 |
|
建立 Docu |
您可以建立簽名會話,使用者將在其中檢閱和電子簽署法律文件,而無需進行身分驗證。 如果您想要同時執行身分驗證並讓使用者簽署某些文件,請改為建立身分驗證工作階段。 |
|
建立Docu |
您可以為每個需要身分驗證的使用者建立驗證工作階段。 |
| 從 Vault 刪除影像 |
您可以透過發出 HTTP POST 要求來刪除保存庫項目內的影像。 請注意,刪除影像後,由於快取,影像的 URL 可能仍可在短時間內存取。 |
| 從 Vault 刪除項目 |
您可以透過提出 HTTP POST 要求來刪除單一或多個儲存庫項目。 |
| 搜尋反洗錢資料庫 |
AML API 允許您使用姓名、文件編號或兩者搜索 ID Analyzer 全球 AML 數據庫中的製裁、PEP 和通緝犯。 您可以進一步過濾生日和國籍的結果。 |
| 更新 Vault 項目 |
您可以透過提出 HTTP POST 要求來更新儲存庫項目中單一欄位的值或多個欄位的值。 |
| 核心 API 設定 |
多功能 ID 驗證 API,用於驗證遠程實體文檔、其真實性和面部匹配文檔與您的用戶照片。 |
| 臉部搜尋 |
臉部搜尋可讓您使用人物影像搜尋整個保管庫。 若要使用臉部搜尋功能,您必須在入口網站下啟用臉部搜尋索引,並定期訓練您的保存庫資料集。 |
| 訓練狀態 |
檢查跳馬訓練是否仍在進行中或已完成。 |
| 驗證回呼 |
確保數據是從我們的服務器發送的。 |
人臉搜索訓練
在執行臉部搜尋之前,您必須發出訓練指令來訓練 Vault 內的文件資料集。 您也可以透過入口網站訓練您的保管庫資料。 訓練任務是非同步的,訓練時間取決於儲存庫項目和映像的數量。 這可能需要幾秒鐘到一個小時。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer |
列出和篩選項目
若要列出儲存在保存庫內的所有項目,或搜尋具有特定值的項目,請將 HTTP POST 要求傳送至下列端點。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
orderby
|
orderby | string |
用來排序結果的欄位名稱。 |
|
|
排序
|
sort | string |
ASC 按升序排序結果,DESC 按降序排序。 |
|
|
limit
|
limit | integer |
要傳回的儲存庫項目數目。 (1 至 100) |
|
|
位移
|
offset | integer |
從特定項目開始的傳回清單,例如,當 limit=10 時,若要存取結果的第三頁,請使用 offset=20 |
|
|
篩選
|
filter | array of string |
篩選 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
limit
|
limit | integer |
目前的限制 |
|
位移
|
offset | integer |
目前偏移 |
|
下一個偏移量
|
nextoffset | integer |
下一組資料的偏移值。 如果目前的資料集是最終的資料集,則不會傳回此欄位。 |
|
總計
|
total | integer |
找到的項目總數。 |
|
items
|
items | array of |
找到的項目及其完整內容的陣列,與 GET 方法傳回的內容相同。 |
取得保管庫條目內容
將項目新增至保存庫時,Core API 和 DocuPass API 都會傳回名為 vaultid 的保存庫項目識別碼。 您可以使用 ID 將 HTTP POST 要求提交至下列端點,以查詢保存庫中項目的內容。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
識別碼
|
id | string |
Vault 項目識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer | |
|
識別碼
|
data.id | string |
保管庫項目識別碼 |
|
創建時間
|
data.createtime | string |
以 UTC 為單位建立項目的時間戳記 |
|
更新時間
|
data.updatetime | string |
上次修改的時間戳記(UTC) |
|
信任層級
|
data.trustlevel | string |
如果啟用驗證,則會自動計算此分數。 (0:未確定,1:無效文件,2:可疑,3:有效) |
|
信任筆記
|
data.trustnote | string |
與文件有效性相關的警告。 |
|
docupass_reference
|
data.docupass_reference | string |
DocuPass 工作階段的參考代碼 |
|
docupass_success
|
data.docupass_success | string |
0 或 1,無論 DocuPass 驗證成功還是失敗。 |
|
docupass_failedreason
|
data.docupass_failedreason | string |
如果DocuPass驗證失敗,則為失敗的原因。 |
|
docupass_customid
|
data.docupass_customid | string |
customid 在建立 DocuPass 驗證時傳遞。 |
|
文件編號
|
data.documentNumber | string |
文件的唯一識別碼(護照號碼/駕駛執照號碼等) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
自動產生的 documentNumber 字串,不含任何符號,此欄位對於篩選結果很有用。 |
|
個人編號
|
data.personalNumber | string |
文件上的次要識別碼號碼 |
|
名字
|
data.firstName | string |
名字/名字 |
|
中間名
|
data.middleName | string |
中間名 |
|
lastName
|
data.lastName | string |
姓氏/姓氏 |
|
全名
|
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 |
當地語言全名 |
|
出生日期
|
data.dob | string |
出生日期 |
|
發行
|
data.issued | string |
發行日期 |
|
expiry
|
data.expiry | string |
到期日 |
|
性
|
data.sex | string |
M:男,F:女,X:未指定 |
|
height
|
data.height | string |
人的身高 |
|
weight
|
data.weight | string |
人的體重 |
|
頭髮顏色
|
data.hairColor | string |
頭髮顏色 |
|
眼睛顏色
|
data.eyeColor | string |
眼睛顏色 |
|
位址1
|
data.address1 | string |
地址行 1 |
|
位址2
|
data.address2 | string |
地址行 2 |
|
郵遞區號
|
data.postcode | string |
地址郵遞區號 |
|
出生地
|
data.placeOfBirth | string |
出生地 |
|
文件類型
|
data.documentType | string |
P:護照,D:駕照,I:身分證,V:簽證,R:居留卡,O:其他 |
|
documentName 文件名稱
|
data.documentName | string |
文件名稱 |
|
車輛類別
|
data.vehicleClass | string |
駕駛執照上的車輛類別 |
|
限制
|
data.restrictions | string |
駕駛限制 |
|
背書
|
data.endorsement | string |
駕駛執照背書 |
|
電子郵件
|
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 格式簽發的國家代碼。 範例:美國 |
|
nationality_iso2
|
data.nationality_iso2 | string |
ISO2 中的文件持有人國籍。 範例:美國 |
|
選用資料
|
data.optionalData | string |
文件中包含的額外非特定資料 |
|
可選資料2
|
data.optionalData2 | string |
文件中包含的額外非特定資料 |
|
自訂資料1
|
data.customdata1 | string |
5 個自訂字串,可用於將自訂備忘新增至條目 |
|
自訂資料2
|
data.customdata2 | string |
5 個自訂字串,可用於將自訂備忘新增至條目 |
|
自訂資料3
|
data.customdata3 | string |
5 個自訂字串,可用於將自訂備忘新增至條目 |
|
自訂資料4
|
data.customdata4 | string |
5 個自訂字串,可用於將自訂備忘新增至條目 |
|
自訂資料5
|
data.customdata5 | string |
5 個自訂字串,可用於將自訂備忘新增至條目 |
|
區塊
|
data.block | string |
設定此參數可阻止將相同的文件提交到 Core API 或 DocuPass。 |
|
合約
|
data.contract | string |
連結至使用 Core API 或 DocuPass 產生/簽署的合約或法律文件 |
|
圖片
|
data.image | array of object |
包含與項目相關聯的影像清單。 |
|
識別碼
|
data.image.id | string |
影像識別碼 |
|
型別
|
data.image.type | string |
0 代表文件,1 代表個人 |
|
雜湊
|
data.image.hash | string |
圖像的 MD5 雜湊 |
|
url
|
data.image.url | string |
影像的網址 |
|
創建時間
|
data.image.createtime | string |
圖像在 UTC 中上傳的時間 |
將影像新增至 Vault
您可以上傳影像,並透過發出 HTTP POST 要求,將它新增至現有的儲存庫項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
識別碼
|
id | True | string |
要新增影像的 Vault 項目識別碼 |
|
型別
|
type | True | string |
設定影像類型:0=文件,1=人物 |
|
圖片
|
image | string |
Base64 編碼的影像資料。 |
|
|
imageurl
|
imageurl | string |
遠端影像 URL。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer | |
|
識別碼
|
image.id | string |
影像識別碼 |
|
型別
|
image.type | string |
0 代表文件,1 代表個人 |
|
雜湊
|
image.hash | string |
圖像的 MD5 雜湊 |
|
url
|
image.url | string |
影像的網址 |
|
創建時間
|
image.createtime | string |
圖像在 UTC 中上傳的時間 |
建立 DocuPass 簽名工作階段
您可以建立簽名會話,使用者將在其中檢閱和電子簽署法律文件,而無需進行身分驗證。 如果您想要同時執行身分驗證並讓使用者簽署某些文件,請改為建立身分驗證工作階段。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
公司名稱
|
companyname | True | string |
您的公司名稱將顯示在整個驗證頁面中,以便最終用戶知道他們正在向您的公司提交身份信息 |
|
template_id
|
template_id | string |
合約範本 ID 以自動填入使用者資料。 |
|
|
contract_format
|
contract_format | string |
輸出文件格式。 (PDF、DOCX、HTML) |
|
|
callbackurl
|
callbackurl | string |
合約檔案將傳送至此網址。 您必須啟用vault_save或指定callbackurl,才能儲存產生的文件。 |
|
|
成功redir
|
successredir | string |
在文件經過審核和簽署後,瀏覽器將被重新導向到此 URL。 DocuPass 參考代碼和 customid 將附加到 URL 的末尾 |
|
|
自訂ID
|
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 | boolean |
隱藏所有 DocuPass 頁面上的品牌標誌。 |
|
|
自訂htmlurl
|
customhtmlurl | string |
使用您自己的 HTML 頁面和 CSS 進行 DocuPass。 對 HTML 和 CSS 進行更改後,您需要將它們上傳到您自己的服務器,在每個會話開始時,DocuPass 將從您的服務器下載最新的 HTML 頁面。 |
|
|
語言
|
language | string |
DocuPass 會自動偵測使用者裝置語言並顯示對應的語言。 設定此參數以覆寫自動語言偵測。(英語、法語、荷蘭語、德語、西班牙語、zh-TW語、zh-CN語) |
|
|
expiry
|
expiry | integer |
DocuPass 工作階段到期前的秒數。 到期後,使用者將無法繼續進行目前工作階段,也會傳送失敗的回呼。 |
|
|
qr_color
|
qr_color | string |
QR 碼前景的顏色 |
|
|
qr_bgcolor
|
qr_bgcolor | string |
二維碼背景的顏色 |
|
|
qr_size
|
qr_size | integer |
二維碼大小 |
|
|
qr_margin
|
qr_margin | integer |
二維碼邊框粗細 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
參考
|
reference | string |
DocuPass 工作階段的唯一參考代碼。 |
|
自訂ID
|
customid | string |
建立 DocuPass 工作階段時使用的自訂 ID。 |
|
url
|
url | string |
DocuPass Web 應用程式的唯一 URL。 將此連結傳送給您的使用者,或將其嵌入到您的網站或行動應用程式中以檢閱和簽署文件。 |
|
二維碼
|
qrcode | string |
QR 碼圖像 URL 供用戶掃描 |
|
base_url
|
base_url | string |
您可以將此連結傳送給您的使用者,並要求他們輸入參考代碼以簽署文件。 |
|
html_qrcode
|
html_qrcode | string |
在網頁上顯示 QR 碼的範例 HTML。 |
|
html_iframe
|
html_iframe | string |
將 iframe 插入網頁的範例 HTML。 |
|
簡訊
|
smssent | string |
包含電話號碼,作為透過sms_contract_link引數成功傳送簡訊時的確認。 |
|
expiry
|
expiry | integer |
UTC UNIX 時間戳記,指出此工作階段何時到期,到期後,使用者將無法再使用連結,並傳送失敗的回呼。 |
建立DocuPass工作階段
您可以為每個需要身分驗證的使用者建立驗證工作階段。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
型別
|
type | integer |
0:iframe模塊,1:移動模塊,2:重定向模塊,3:實時移動模塊 |
|
|
公司名稱
|
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 | integer |
每個驗證要求的最大失敗嘗試次數。 |
|
|
成功redir
|
successredir | string |
當身份驗證成功時,瀏覽器將被重新導向到此 URL。 |
|
|
failredir
|
failredir | string |
當身份驗證失敗時,瀏覽器將被重定向到此 URL。 |
|
|
自訂ID
|
customid | string |
它對於識別資料庫中的使用者很有用。 此值將儲存在 Vault 下的 docupass_customid 下。 |
|
|
可重複使用
|
reusable | boolean |
啟用此參數將允許多個使用者透過相同的 URL 驗證其身份,將自動為每個使用者產生新的 DocuPass 參考代碼。 |
|
|
電話驗證
|
phoneverification | boolean |
無論是要求使用者輸入電話號碼進行驗證,DocuPass 都支援行動或固定電話號碼驗證。 (只限訂戶) |
|
|
文件類型
|
documenttype | string |
使用者必須上傳特定類型的文件。 例如,“PD”將接受護照和駕駛執照。 |
|
|
文件國家/地區
|
documentcountry | string |
ISO ALPHA-2 國家代碼。 |
|
|
文件區域
|
documentregion | string |
州/地區全名或縮寫。 |
|
|
雙側檢查
|
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。 (圖片網址只會保留7天) |
|
|
歡迎訊息
|
welcomemessage | string |
將第一頁的通用問候語訊息替換為您的自訂文字(最多 1,000 個字元) |
|
|
無品牌
|
nobranding | boolean |
隱藏所有 DocuPass 頁面上的品牌標誌。 (只限訂戶) |
|
|
標誌
|
logo | string |
客製化品牌標誌。 (只限訂戶) |
|
|
自訂htmlurl
|
customhtmlurl | string |
使用您自己的 HTML 頁面和 CSS 進行 DocuPass。 (只限訂戶) |
|
|
語言
|
language | string |
DocuPass 會自動偵測使用者裝置語言並顯示對應的語言。 |
|
|
expiry
|
expiry | integer |
DocuPass 工作階段到期前的秒數。 到期後,使用者將無法繼續進行目前工作階段,也會傳送失敗的回呼。 |
|
|
qr_color
|
qr_color | string |
QR 碼前景的顏色。 (僅適用於 Live Mobile 和 Standard Mobile) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
二維碼背景的顏色。 (僅適用於 Live Mobile 和 Standard Mobile) |
|
|
qr_size
|
qr_size | integer |
二維碼大小(1-50)。 (僅適用於 Live Mobile 和 Standard Mobile) |
|
|
qr_margin
|
qr_margin | integer |
QR 碼的邊框粗細(1-50)。 (僅適用於 Live Mobile 和 Standard Mobile) |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
參考
|
reference | string |
DocuPass 工作階段的唯一參考代碼。 |
|
型別
|
type | integer |
DocuPass 模組類型已建立。 |
|
自訂ID
|
customid | string |
建立 DocuPass 工作階段時使用的自訂 ID。 |
|
url
|
url | string |
DocuPass Web 應用程式的唯一 URL。 將此連結傳送給您的使用者,或將其嵌入您的網站或行動應用程式中以開始身分驗證。 |
|
二維碼
|
qrcode | string |
QR 碼圖像 URL 供用戶掃描 |
|
base_url
|
base_url | string |
您可以將此連結傳送給您的使用者,並要求他們輸入參考代碼以開始驗證。 |
|
HTML全文
|
html | string |
您可以插入網頁的範例 HTML。 |
|
簡訊
|
smssent | integer |
包含電話號碼,作為透過sms_verification_link引數成功傳送簡訊時的確認。 |
|
expiry
|
expiry | integer |
UTC UNIX 時間戳記,指出此工作階段何時到期,到期後,使用者將無法再使用連結,並傳送失敗的回呼。 |
從 Vault 刪除影像
您可以透過發出 HTTP POST 要求來刪除保存庫項目內的影像。 請注意,刪除影像後,由於快取,影像的 URL 可能仍可在短時間內存取。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
識別碼
|
id | True | string |
包含影像的 Vault 項目識別碼。 |
|
imageid
|
imageid | string |
要刪除的影像的 ID。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer |
從 Vault 刪除項目
您可以透過提出 HTTP POST 要求來刪除單一或多個儲存庫項目。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
識別碼
|
id | True | array of string |
識別碼 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer |
搜尋反洗錢資料庫
AML API 允許您使用姓名、文件編號或兩者搜索 ID Analyzer 全球 AML 數據庫中的製裁、PEP 和通緝犯。 您可以進一步過濾生日和國籍的結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
名稱
|
name | string |
任何語言的個人或組織名稱或別名。 |
|
|
文件編號
|
documentnumber | string |
護照號碼、國民身分證號碼或駕駛執照號碼等。 |
|
|
實體
|
entity | string |
person:人;法人實體:公司或組織 |
|
|
country
|
country | string |
僅傳回具有相符國家/國籍或沒有國家/地區資訊的實體。 |
|
|
出生日期
|
dob | string |
僅傳回具有相符生日或沒有生日資訊的實體。 |
|
|
資料庫
|
database | string |
指定要執行AML檢查的來源資料庫,如果留空,將檢查所有來源資料庫。 每個資料庫程式碼都用逗號分隔,例如:un_sc,us_ofac。 如需來源資料庫的完整清單和對應程式碼,請造訪 AML API 概觀。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
反洗錢
|
items | array of object |
包含 AML 相符項目清單的陣列,如果找不到相符項目,則會傳回空陣列。 如需具體詳細資訊,請參閱 AML API 參考。 |
|
實體
|
items.entity | string |
個人或法人實體 |
|
全名
|
items.fullname | array of string |
個人或法人實體名稱 |
|
名字
|
items.firstname | array of string |
人名 |
|
姓氏
|
items.lastname | array of string |
人員姓氏 |
|
中間名
|
items.middlename | array of string |
人員中間名 |
|
別名
|
items.alias | array of string |
實體的替代名稱或外國名稱 |
|
出生日期
|
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 |
|
文件編號
|
items.documentnumber | array of object |
與實體相關聯的文件清單。 |
|
識別碼
|
items.documentnumber.id | string |
文件編號 |
|
id_formatted
|
items.documentnumber.id_formatted | string |
英數字元文件編號 |
|
country
|
items.documentnumber.country | string |
ISO2 國家代碼 |
|
型別
|
items.documentnumber.type | string |
P = 護照號碼,I = 身分證號碼,D = 駕駛執照號碼,O = 其他/未知文件類型 |
|
程式
|
items.program | array of string |
制裁計劃 |
|
注意
|
items.note | array of string |
實體的附加說明 |
|
time
|
items.time | string |
將實體新增至來源清單或上次更新時的 UTC TZ 時間戳記 |
|
狀態
|
items.status | string |
實體的職位/職稱或制裁的當前狀態 |
|
來源
|
items.source | array of string |
官方來源 URL 清單 |
|
資料庫
|
items.database | string |
ID Analyzer AML 資料庫程式碼 |
|
結構描述
|
items.schema | string |
更新 Vault 項目
您可以透過提出 HTTP POST 要求來更新儲存庫項目中單一欄位的值或多個欄位的值。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
識別碼
|
id | True | string |
Vault 項目識別碼。 |
|
位址1
|
address1 | string |
位址行 1。 |
|
|
位址2
|
address2 | string |
位址行 2。 |
|
|
區塊
|
block | string |
設定此參數可阻止將相同的文件提交到 Core API 或 DocuPass。 0:無封鎖 1:封鎖文件編號 2:封鎖名字/姓氏 3:封鎖文件編號和名字/姓氏。 |
|
|
自訂資料1
|
customdata1 | string |
5 個自定義字符串,可用於將自定義備忘錄添加到條目中。 |
|
|
自訂資料2
|
customdata2 | string |
5 個自定義字符串,可用於將自定義備忘錄添加到條目中。 |
|
|
自訂資料3
|
customdata3 | string |
5 個自定義字符串,可用於將自定義備忘錄添加到條目中。 |
|
|
自訂資料4
|
customdata4 | string |
5 個自定義字符串,可用於將自定義備忘錄添加到條目中。 |
|
|
自訂資料5
|
customdata5 | string |
5 個自定義字符串,可用於將自定義備忘錄添加到條目中。 |
|
|
出生日期
|
dob | string |
出生日期 (YYYY-MM-DD)。 |
|
|
documentName 文件名稱
|
documentName | string |
文件名稱。 |
|
|
文件編號
|
documentNumber | string |
文件的唯一識別碼(護照號碼/駕駛執照號碼等) |
|
|
文件類型
|
documentType | string |
P:護照 D:駕照 I:身分證 V:簽證 R:居留卡 O:其他 |
|
|
docupass_customid
|
docupass_customid | string |
customid 在建立 DocuPass 驗證時傳遞。 |
|
|
docupass_failedreason
|
docupass_failedreason | string |
如果DocuPass驗證失敗,則為失敗的原因。 |
|
|
docupass_reference
|
docupass_reference | string |
DocuPass 工作階段的參考程式碼。 |
|
|
docupass_success
|
docupass_success | string |
0 或 1,無論 DocuPass 驗證成功還是失敗。 |
|
|
電子郵件
|
string |
用戶電子郵件位址。 |
||
|
expiry
|
expiry | string |
有效期 (YYYY-MM-DD) |
|
|
眼睛顏色
|
eyeColor | string |
眼睛顏色。 |
|
|
名字
|
firstName | string |
名字/名字 |
|
|
firstName_local
|
firstName_local | string |
當地語言的名字。 |
|
|
全名
|
fullName | string |
全名 (更新其他名稱欄位不會更新 fullName) |
|
|
fullName_local
|
fullName_local | string |
當地語言的名字。 |
|
|
頭髮顏色
|
hairColor | string |
頭髮顏色。 |
|
|
height
|
height | string |
人的身高。 |
|
|
issueAuthority
|
issueAuthority | string |
簽發文件權限。 |
|
|
發行
|
issued | string |
發行日期 (YYYY-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
以 ISO2 格式簽發的國家代碼。 範例:美國 |
|
|
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 | string |
中間名。 |
|
|
middleName_local
|
middleName_local | string |
當地語言的中間名。 |
|
|
行動
|
mobile | string |
用戶手機號碼。 |
|
|
nationality_iso2
|
nationality_iso2 | string |
ISO2 中的文件持有人國籍。 範例:美國 |
|
|
選用資料
|
optionalData | string |
文件中包含的額外非特定資料。 |
|
|
可選資料2
|
optionalData2 | string |
文件中包含的額外非特定資料。 |
|
|
個人編號
|
personalNumber | string |
文件上的次要識別碼號碼。 |
|
|
出生地
|
placeOfBirth | string |
出生地。 |
|
|
郵遞區號
|
postcode | string |
地址郵遞區號。 |
|
|
限制
|
restrictions | string |
駕駛限制。 |
|
|
性
|
sex | string |
M:男 F:女 X:未指定 |
|
|
信任層級
|
trustlevel | string |
0:未確定 1:無效文件 2:可疑 3:有效 如果啟用身份驗證,則會自動計算此分數。 |
|
|
信任筆記
|
trustnote | string | ||
|
車輛類別
|
vehicleClass | string |
駕駛執照上的車輛類別。 |
|
|
weight
|
weight | string |
人的體重。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | integer |
核心 API 設定
多功能 ID 驗證 API,用於驗證遠程實體文檔、其真實性和面部匹配文檔與您的用戶照片。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
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 | 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 | boolean |
產生文件的裁切影像。 |
|
|
輸出臉
|
outputface | boolean |
在文件上產生臉部區域的裁切影像。 |
|
|
輸出模式
|
outputmode | string |
將裁剪的文件和臉部輸出為 URL 或 base64 編碼的內容。 |
|
|
雙側檢查
|
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 | string |
檢查文件是否是指定的類型之一,如果不是,則會拋出錯誤代碼 12。 例如,“PD”將接受護照和駕駛執照。 |
|
|
檢查阻止列表
|
checkblocklist | boolean |
檢查文件資料與保管庫中封鎖的項目。 如果文檔匹配被阻止的條目之一,則會拋出錯誤 15 |
|
|
vault_save
|
vault_save | boolean |
將文件影像和剖析資訊儲存在安全的保管庫中。 您可以透過 Vault API 或入口網站列出、搜尋和更新保管庫中的文件項目。 |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
將文件影像儲存在 Vault 中,即使無法辨識文件也是如此。 |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
防止儲存重複的影像。 |
|
|
vault_automerge
|
vault_automerge | boolean |
自動將具有相同文件編號的影像合併到 Vault 內的單一項目中。 |
|
|
vault_customdata1
|
vault_customdata1 | string |
新增最多 5 個與儲存庫項目相關聯的自訂字串,這對於篩選和搜尋項目非常有用。 |
|
|
vault_customdata2
|
vault_customdata2 | string |
新增最多 5 個與儲存庫項目相關聯的自訂字串,這對於篩選和搜尋項目非常有用。 |
|
|
vault_customdata3
|
vault_customdata3 | string |
新增最多 5 個與儲存庫項目相關聯的自訂字串,這對於篩選和搜尋項目非常有用。 |
|
|
vault_customdata4
|
vault_customdata4 | string |
新增最多 5 個與儲存庫項目相關聯的自訂字串,這對於篩選和搜尋項目非常有用。 |
|
|
vault_customdata5
|
vault_customdata5 | string |
新增最多 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 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文件編號
|
result.documentNumber | string |
與文件相關聯的唯一識別碼(例如護照號碼/駕駛執照號碼/卡號等) |
|
個人編號
|
result.personalNumber | string |
與國家/地區內人員相關聯的唯一個人識別碼(例如國民身分證號碼) |
|
名字
|
result.firstName | string |
名字/名字 |
|
lastName
|
result.lastName | string |
姓氏/姓氏 |
|
中間名
|
result.middleName | string |
中間名 |
|
全名
|
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=未指定 |
|
height
|
result.height | string |
人的身高 |
|
weight
|
result.weight | string |
人的體重 |
|
頭髮顏色
|
result.hairColor | string |
髮色 - ANSI D-20 髮色代碼(3 個字母) |
|
眼睛顏色
|
result.eyeColor | string |
眼睛顏色 - ANSI D-20 眼睛顏色代碼(3 個字母) |
|
年齡
|
result.age | integer |
文件持有人的年齡 |
|
出生日期
|
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 的出生日期年份 |
|
expiry
|
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 為單位的到期年份 |
|
天數到到期
|
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 為單位) |
|
天數從問題
|
result.daysFromIssue | integer |
自文件發出以來的天數 |
|
位址1
|
result.address1 | string |
地址行 1 |
|
位址2
|
result.address2 | string |
地址行 2 |
|
郵遞區號
|
result.postcode | string |
地址郵遞區號 |
|
出生地
|
result.placeOfBirth | string |
出生地 |
|
車輛類別
|
result.vehicleClass | string |
駕駛執照車輛類別 |
|
限制
|
result.restrictions | string |
駕駛執照限制 |
|
背書
|
result.endorsement | string |
駕駛執照背書 |
|
選用資料
|
result.optionalData | string |
文件中包含的額外非特定資料 |
|
可選資料2
|
result.optionalData2 | string |
文件中包含的額外非特定資料 |
|
文件類型
|
result.documentType | string |
證件類型:P=護照,D=駕照,I=身份證,V=簽證,R=居留卡,O=其他 |
|
文件側
|
result.documentSide | string |
文件側面:正面、背面或生物數據 |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
文件發行者次區域/州。 (例如加利福尼亞州) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
文件發行者次區域/州縮寫。 (例如加州) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
文件簽發國家。 (例如美國) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
以 ISO2 格式簽發的國家代碼。 (例如美國) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
文件簽發的國家代碼為 ISO3。 (例如美國) |
|
nationality_full
|
result.nationality_full | string |
文件持有人國籍。 (例如美國) |
|
nationality_iso2
|
result.nationality_iso2 | string |
ISO2 中的文件持有人國籍。 (例如美國) |
|
nationality_iso3
|
result.nationality_iso3 | string |
ISO3 中的文件持有人國籍。 (例如美國) |
|
內部標識
|
result.internalId | string |
用於識別ID Analyzer系統下的唯一文件ID,同一類型的文件應具有相同的ID。 |
|
文件編號
|
confidence.documentNumber | float |
documentNumber 的信賴層次 |
|
名字
|
confidence.firstName | float |
firstName 的信賴層級 |
|
lastName
|
confidence.lastName | float |
姓氏/姓氏的信賴等級 |
|
中間名
|
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 |
性愛的信心水平 |
|
height
|
confidence.height | float |
身高置信度 |
|
weight
|
confidence.weight | float |
權重的置信度 |
|
位址1
|
confidence.address1 | float |
地址的信賴等級1 |
|
位址2
|
confidence.address2 | float |
地址的信賴等級2 |
|
郵遞區號
|
confidence.postcode | float |
郵遞區號的置信度 |
|
車輛類別
|
confidence.vehicleClass | float |
vehicleClass 的信賴等級 |
|
限制
|
confidence.restrictions | float |
限制的信賴程度 |
|
背書
|
confidence.endorsement | float |
背書的置信度 |
|
眼睛顏色
|
confidence.eyeColor | float |
eyeColor 的置信度 |
|
年齡
|
confidence.age | float |
年齡的置信水平 |
|
出生日期
|
confidence.dob | float |
出生日期的置信水平 |
|
天數到到期
|
confidence.daysToExpiry | float |
天數的置信度ToExpiry |
|
expiry
|
confidence.expiry | float |
到期的置信度 |
|
發行
|
confidence.issued | float |
已發出的置信度 |
|
天數從問題
|
confidence.daysFromIssue | float |
DaysFromIssue 的信賴水準 |
|
全名
|
confidence.fullName | float |
fullName 的信賴層級 |
|
是相同的
|
face.isIdentical | boolean |
生物特徵驗證通過或失敗 |
|
信賴度
|
face.confidence | string |
值介於 0 到 1 之間,表示兩個面的相似程度,1 表示相同。 |
|
錯誤
|
face.error | integer |
錯誤碼 |
|
error_message
|
face.error_message | string |
錯誤訊息。 範例:無法在臉部影像中找到臉部資料 |
|
通過
|
verification.passed | boolean |
如果文件已通過所有驗證,將傳回 true。 如果文檔至少一種驗證類型失敗,將返回 false。 |
|
臉
|
verification.result.face | boolean |
如果啟用生物特徵驗證,相似性信賴度分數是否高於設定的閾值。 |
|
not已過期
|
verification.result.notexpired | boolean |
文件是否尚未過期。 |
|
名稱
|
verification.result.name | boolean |
提供的名稱是否與從 ID 剖析的名稱相符。 |
|
出生日期
|
verification.result.dob | boolean |
提供的生日是否與從 ID 剖析的生日相符。 |
|
文件編號
|
verification.result.documentNumber | boolean |
提供的文件編號是否與從 ID 剖析的文件編號相符。 |
|
郵遞區號
|
verification.result.postcode | boolean |
提供的郵遞區號是否與從 ID 解析的郵遞區號相符。 |
|
address
|
verification.result.address | boolean |
提供的位址是否與從 ID 剖析的位址相符。 |
|
校驗位
|
verification.result.checkdigit | boolean |
如果文件類型有校驗位/soundex演算法,則校驗位是否有效。 |
|
年齡
|
verification.result.age | boolean |
文件持有人是否在設定的年齡範圍內。 |
|
CC代碼
|
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 | |
|
字碼
|
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 | |
|
字碼
|
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 | |
|
字碼
|
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 | |
|
字碼
|
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 | array of object |
包含 AML 相符項目清單的陣列,如果找不到相符項目,則會傳回空陣列。 如需具體詳細資訊,請參閱 AML API 參考。 |
|
實體
|
aml.entity | string |
個人或法人實體 |
|
全名
|
aml.fullname | array of string |
個人或法人實體名稱 |
|
名字
|
aml.firstname | array of string |
人名 |
|
姓氏
|
aml.lastname | array of string |
人員姓氏 |
|
中間名
|
aml.middlename | array of string |
人員中間名 |
|
別名
|
aml.alias | array of string |
實體的替代名稱或外國名稱 |
|
出生日期
|
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 |
|
文件編號
|
aml.documentnumber | array of object |
與實體相關聯的文件清單。 |
|
識別碼
|
aml.documentnumber.id | string |
文件編號 |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
英數字元文件編號 |
|
country
|
aml.documentnumber.country | string |
ISO2 國家代碼 |
|
型別
|
aml.documentnumber.type | string |
P = 護照號碼,I = 身分證號碼,D = 駕駛執照號碼,O = 其他/未知文件類型 |
|
程式
|
aml.program | array of string |
制裁計劃 |
|
注意
|
aml.note | array of string |
實體的附加說明 |
|
time
|
aml.time | string |
將實體新增至來源清單或上次更新時的 UTC TZ 時間戳記 |
|
狀態
|
aml.status | string |
實體的職位/職稱或制裁的當前狀態 |
|
來源
|
aml.source | array of string |
官方來源 URL 清單 |
|
資料庫
|
aml.database | string |
ID Analyzer AML 資料庫程式碼 |
|
結構描述
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
產生文件的URL |
|
錯誤
|
contract.error | string |
如果合約無法產生,此欄位將包含原因,例如「合約範本 ID 無效」。 |
|
vaultid
|
vaultid | string |
儲存庫項目的唯一識別碼 (如果已啟用 vault_save)。 |
|
匹配率
|
matchrate | float |
API 成功識別的欄位比例,低比例表示文件影像太模糊。 |
|
輸出
|
output | string |
如果 outputimage 設定為 true,且 outputmode 為 url,則此欄位將包含指向裁剪文件影像的 URL (或用於雙面掃描的 URL 陣列)。 該連結僅保證存活 600 秒,之後將隨時刪除。 |
|
輸出臉
|
outputface | string |
如果 outputface 設定為 true,且 outputmode 為 url,則此欄位會包含指向裁剪臉部影像的 URL。 該連結僅保證存活 600 秒,之後將隨時刪除。 |
|
裁剪的
|
cropped | string |
如果 outputimage 設定為 true,且 outputmode 為 base64,則此欄位將包含 JPEG 格式裁切文件的 base64 編碼影像 (或用於雙面掃描的 base64 編碼影像陣列) |
|
裁剪臉
|
croppedface | string |
如果 outputface 設定為 true,且 outputmode 為 base64,則此欄位將包含 JPEG 格式文件裁切臉部區域的 base64 編碼影像 |
|
executionTime (執行時間)
|
executionTime | float |
API 作業所花費的時間 (以秒為單位)。 |
|
回應ID
|
responseID | string |
用於識別請求/回應的唯一識別碼。 |
|
配額
|
quota | integer |
剩餘的 API 配額會在免費或年度訂閱者的每個月初重設,或每月訂閱者的每個帳單週期開始時重設。 如果您有訂閱計劃,您的每月配額將在您的積分之前使用。 |
|
信用額度
|
credit | integer |
您帳戶的剩餘測試點數。 如果您有訂閱計劃,您的每月配額將在您的積分之前使用。 |
臉部搜尋
臉部搜尋可讓您使用人物影像搜尋整個保管庫。 若要使用臉部搜尋功能,您必須在入口網站下啟用臉部搜尋索引,並定期訓練您的保存庫資料集。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
圖片
|
image | string |
Base64 編碼的影像資料。 |
|
|
imageurl
|
imageurl | string |
遠端影像 URL。 |
|
|
maxentry
|
maxentry | integer |
要傳回的相符項目數目,介於 1 到 10 之間。 |
|
|
閾值
|
threshold | float |
設定所需的最低臉部相似度分數,範圍為 0 到 1。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
items
|
items | array of |
如果找到相符的項目,則會傳回具有完整內容的文件清單,類似於 list 指令。 |
訓練狀態
檢查跳馬訓練是否仍在進行中或已完成。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態
|
status | string |
nottrained:從未訓練,notstarted:訓練未執行,running:訓練目前正在執行,succeeded:訓練成功,failed:訓練失敗 |
|
startTime
|
startTime | string |
上次以 UTC 開始訓練的時間。 |
|
狀態變更時間
|
statusChangeTime | string |
最後一次狀態變更的時間(UTC)。 |
|
最後成功時間
|
lastSuccessTime | string |
最後一次在 UTC 中成功訓練的時間。 |
|
錯誤
|
error | string |
與失敗訓練狀態相關聯的錯誤訊息。 |
驗證回呼
確保數據是從我們的服務器發送的。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
APIKEY
|
apikey | True | string |
您的私人 API 金鑰可在入口網站下取得。 |
|
參考
|
reference | True | string |
在 POST BODY 中收到的參考代碼。 |
|
雜湊
|
hash | True | string |
在 POST BODY 中收到的雜湊。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
勝
|
success | boolean | |
|
參考
|
reference | string |
DocuPass 工作階段的參考代碼 |