本文中含有需要您注意的重要提示信息,忽略該信息可能對您的業務造成影響,請務必仔細閱讀。
本文介紹了如何調用InitFaceVerify接口在服務端接入流程中發起認證請求。
接入方式說明
如果采用服務端接入方式,您可以配合SDK調用InitFaceVerify接口發起認證請求,獲取CertifyId,喚起客戶端上傳人臉信息。用戶上傳人臉信息后,您可以調用DescribeFaceVerify接口查詢認證結果。
發起認證請求
接口名:InitFaceVerify。
全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)
請求方法:POST和GET。
傳輸協議:HTTPS。
接口說明:每次開始認證前通過本接口獲取CertifyId,用來串聯認證請求中的各個接口。
QPS限量:API獨享QPS限量,詳情請參見服務端接口QPS限量說明。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 示例值 |
SceneId | Long | 是 | 認證場景ID。該ID在控制臺創建認證場景后自動生成。關于如何創建認證場景,請參見添加認證場景。 | 100000**** |
OuterOrderNo | String | 是 | 客戶服務端自定義的業務唯一標識,用于后續定位排查問題使用。值最長為32位長度的字母數字組合,請確保唯一。 | e0c34a77f5ac40a5aa5e6ed20c353888 |
ProductCode | String | 是 | 認證方案。 唯一取值:LR_FR。 | LR_FR |
Model | String | 否 | 活體檢測類型。取值:
說明
| MOVE_ACTION |
UserId | String | 是 | 您自定義的用戶ID(最長100個字符),請保持唯一。 | 123456789 |
CertType | String | 否 | 證件類型。 當前僅支持身份證,必須傳入IDENTITY_CARD。 說明 該方案中,不驗證姓名和證件號碼的真實性、一致性。如需驗證,請選擇實人認證方案。 | IDENTITY_CARD |
CertName | String | 否 | 真實姓名。 | 張三 |
CertNo | String | 否 | 證件號碼。 | 330103xxxxxxxxxxxx |
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 | 否 | 用戶手機號碼。 | 130xxxxxxxx |
Ip | String | 否 | 用戶網絡IP。 | 114.xxx.xxx.xxx |
CallbackUrl | String | 否 | 認證結果的回調通知地址,回調請求方式默認為GET,回調地址必須以 說明 僅當認證完成(包含認證通過和認證未通過)時才會觸發回調,若認證中放棄、異常中斷或未進行認證均不會通知。建議您收到回調通知時,若有需要可通過查詢接口獲取認證詳情信息。 | https://www.aliyun.com |
CallbackToken | String | 否 | 安全Token,由您自行生成,用于防重復、防篡改校驗。 如果設置了該值會在回調地址顯示CallbackToken字段。 | NMjvQanQgplBSaEI0sL86WnQplB |
AuthId | String | 否 | 用戶授權ID,最大長度為64位字符。 | 92d46b9e9e2d703f2897f350d5bd4149 |
SuitableType | String | 否 | 適老化配置參數,針對每筆認證請求生效,您可以根據自有App的業務屬性、客群分布、操作特性等條件對于每筆認證請求選擇不同的參數,包括以下選項,默認為0。
說明
| 0 |
FaceGuardOutput | String | 否 | 人臉保鏢標簽種類。 DeviceRisk:設備風險標簽。
說明 | DeviceRisk |
AppQualityCheck | String | 否 | SDK是否開啟人臉嚴格質量檢測。
說明
| N |
返回數據
名稱 | 類型 | 描述 | 示例值 |
RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Message | String | 返回信息。 | success |
Code | String | 返回碼。200表示成功,其他表示失敗。關于返回碼的具體信息,請參見返回Code和Message說明。 | 200 |
ResultObject.CertifyId | String | 實人認證唯一標識。 警告 CertifyId字段為計費統計字段,為了方便后續核對賬單,請您在本地留存該字段信息。 初始化接口返回的認證CertifyId在30分鐘有效且僅能認證提交一次,請您在有效期內應用,避免重復使用。 | 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 | 系統版本不支持 | 當前操作系統版本不支持刷臉認證,請升級系統或更換設備操作。 |
418 | 刷臉失敗次數過多 | 當天刷臉認證次數過多,請明天再試。 |
500 | 系統錯誤 | 系統內部錯誤,請反饋工程師排查。 |