本文介紹如何通過調用InitFaceVerify接口發起金融級實人認證請求。
發起認證請求
接口名:InitFaceVerify。
全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)
請求方法:POST和GET。
傳輸協議:HTTPS。
接口說明:每次開始認證前通過本接口獲取CertifyId,用來串聯認證請求中的各個接口。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 示例值 |
SceneId | Long | 是 | 要接入的認證場景ID。該ID在控制臺創建認證場景后自動生成。關于如何創建認證場景,請參見添加認證場景。 | 100000**** |
OuterOrderNo | String | 是 | 您自定義的業務唯一標識,用于后續定位排查問題使用。 支持長度為32位的字母和數字的組合,請確保唯一。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
ProductCode | String | 是 | 要接入的認證方案。取值:
| ID_PRO |
Model | String | 否 | 要進行活體檢測的類型。取值:
說明 活體檢測模式僅支持運行在Android SDK 1.2.6及以上版本和iOS SDK 1.2.4及以上版本;多動作活體檢測模式僅支持運行在Android SDK 1.6.4及以上版本和iOS SDK 1.5.1及以上版本。 | LIVENESS |
CertType | String | 是 | 用戶證件類型。支持的證件類型,請參見方案概述。 不同證件類型,取值均為IDENTITY_CARD。 說明 當ProductCode為ID_PLUS時,CertType為非必填字段。 | IDENTITY_CARD |
CertName | String | 是 | 終端用戶的真實姓名。 說明 當ProductCode為ID_PLUS時,CertName為非必填字段。 | 張XX |
CertNo | String | 是 | 終端用戶的證件號碼。 說明 當ProductCode為ID_PLUS時,CertNo為非必填字段。 | 330103************ |
MetaInfo | String | 是 | MetaInfo環境參數,需要通過客戶端SDK獲取,詳情請參見App(SDK)接入。 | {"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"} 說明 該示例僅供參考,實際集成中不能直接應用,具體參考SDK集成說明獲取。 |
Mobile | String | 否 | 終端用戶的手機號碼。 | 130******** |
Ip | String | 否 | 終端用戶的IP。 | 114.100.XX.XX |
UserId | String | 否 | 您自定義的用戶ID(最長100個字符),請保持唯一。 | 123456789 |
CallbackUrl | String | 否 | 認證結果的回調通知地址,回調請求方式默認為GET,回調地址必須以 說明 僅當認證完成(包含認證通過和認證未通過)時才會觸發回調,若認證中放棄、異常中斷或未進行認證均不會通知。建議您收到回調通知時,若有需要可通過查詢接口獲取認證詳情信息。 | https://www.aliyun.com |
CallbackToken | String | 否 | 安全Token,由您自行生成,用于防重復、防篡改校驗。 如果設置了該值會在回調地址顯示CallbackToken字段。 | NMjvQanQgplBSaEI0sL86WnQplB |
AuthId | String | 否 | 用戶授權ID,最大長度為64位字符。 | 92d46b9e9e2d703f2897f350d5bd4149 |
EncryptType | String | 否 | 傳入加密算法,目前僅支持SM2國密算法。 開啟加密傳輸后,需傳入加密后的CertName和CertNo。如何加密,請參見參數加密說明。 | SM2 |
SuitableType | String | 否 | 適老化配置參數,針對每筆認證請求生效,您可以根據自有App的業務屬性、客群分布、操作特性等條件對于每筆認證請求選擇不同的參數,包括以下選項,默認為0。
說明
| 0 |
FaceGuardOutput | String | 否 | 人臉保鏢標簽種類。 DeviceRisk:設備風險標簽。
說明 | DeviceRisk |
RarelyCharacters | String | 否 | 是否開啟生僻字模式。
說明 生僻字模式僅金融級實人認證方案下App接入場景和PC/H5接入場景支持,其他方案暫不支持。 | Y |
AppQualityCheck | String | 否 | SDK是否開啟人臉嚴格質量檢測。
說明
| N |
返回數據
名稱 | 類型 | 描述 | 示例值 |
RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Message | String | 請求消息的響應信息。 | success |
Code | String | 返回碼。關于返回碼的具體信息,請參見下文返回Code和Message說明。 | 200 |
ResultObject.CertifyId | String | 實人認證唯一標識??蛻舳送ㄟ^verify()函數發起實人認證的時候需傳入該參數。 重要
| 91707dc296d469ad38e4c5efa6a0**** |
返回Code和Message說明
Code | Message | 描述 |
200 | success | 成功。 |
400 | 參數不能為空 | 參數不能為空。 |
401 | 參數非法 | 非法參數。傳入的姓名、身份證號碼長度必須符合國家標準且不得包含英文字母等特殊字符。 |
402 | 應用配置不存在 | 應用配置不存在。 |
404 | 認證場景配置不存在 | 認證場景配置不存在,請先在控制臺上創建認證場景。 |
410 | 未開通服務 | 未開通OSS產品或未完成OSS讀寫授權,請登錄控制臺完成授權。具體操作,請參見授權金融級實人認證訪問OSS存儲空間。 |
411 | RAM無權限 | 需要給RAM用戶授予AliyunAntCloudAuthFullAccess的操作權限。 |
412 | 欠費中 | 金融級實人認證或OSS存在欠費,請充值后操作。 |
414 | 設備類型不支持 | 當前移動設備不支持刷臉認證,請更換設備后操作。 |
415 | SDK版本不支持 | 當前認證SDK版本不支持刷臉認證,請升級SDK后操作。 |
416 | 系統版本不支持 | 當前操作系統版本不支持刷臉認證,請升級系統或更換設備操作。 |
417 | 無法使用刷臉服務 | 當前身份信息無可用比對源,導致此錯誤的原因請參考DescribeFaceVerify認證結果錯誤碼(ResultObject.SubCode)201、202和203的描述說明。 |
418 | 刷臉失敗次數過多 | 當天刷臉認證失敗次數過多,請明天再試。 說明 一個身份信息在一天內最多可以認證失敗20次,無法調整更多的認證失敗次數。 |
500 | 系統錯誤 | 系統內部錯誤,請通過智能在線聯系阿里云工程師協助排查。 |