服務(wù)端集成
本文中含有需要您注意的重要提示信息,忽略該信息可能對您的業(yè)務(wù)造成影響,請務(wù)必仔細(xì)閱讀。
在PC或移動端H5網(wǎng)面接入金融級活體人臉驗(yàn)證方案時(shí),開發(fā)者需要在后端服務(wù)器集成SDK,以便調(diào)用InitFaceVerify接口獲取用于瀏覽器進(jìn)行實(shí)人認(rèn)證的認(rèn)證鏈接CertifyUrl。本文介紹發(fā)起實(shí)人認(rèn)證請求和查詢實(shí)人認(rèn)證結(jié)果的服務(wù)端接口說明。
InitFaceVerify-發(fā)起認(rèn)證請求
每次開始認(rèn)證前通過調(diào)用本接口獲取用于瀏覽器進(jìn)行實(shí)人認(rèn)證的認(rèn)證鏈接CertifyUrl。您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
接口說明
接口名:InitFaceVerify。
全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)
請求方法:POST和GET。
傳輸協(xié)議:HTTPS。
接口說明:每次開始認(rèn)證前通過調(diào)用本接口獲取用于PC或移動端網(wǎng)頁進(jìn)行實(shí)人認(rèn)證的認(rèn)證鏈接CertifyUrl。
QPS限量:API獨(dú)享QPS限量,詳情請參見服務(wù)端接口QPS限量說明。
請求參數(shù)
名稱 | 類型 | 是否必選 | 描述 | 示例值 |
SceneId | Long | 是 | 要接入的認(rèn)證場景ID。該ID在控制臺創(chuàng)建認(rèn)證場景后自動生成。關(guān)于如何創(chuàng)建認(rèn)證場景,請參見添加認(rèn)證場景。 | 10000****** |
OuterOrderNo | String | 是 | 您自定義的業(yè)務(wù)唯一標(biāo)識,用于后續(xù)定位和排查問題。 支持長度為32位的字母和數(shù)字組合,請確保唯一。 | e0c34a77f5ac40a5aa5e6ed2****** |
ProductCode | String | 是 | 要接入的認(rèn)證方案。 唯一取值:PV_FV。 | PV_FV |
Model | String | 是 | 要進(jìn)行活體檢測的類型。
| PHOTINUS_LIVENESS |
CertType | String | 是 | 用戶證件類型。 不同證件類型,取值均為IDENTITY_CARD。 | IDENTITY_CARD |
CertName | String | 否 | 您的終端用戶的真實(shí)姓名。 | 張三 |
CertNo | String | 否 | 您的終端用戶的證件號碼。 | 330103xxxxxxxxxxxx |
ReturnUrl | String | 是 | 您的業(yè)務(wù)頁面回跳的目標(biāo)地址。 | https://www.aliyun.com |
MetaInfo | String | 是 | MetaInfo環(huán)境參數(shù)。實(shí)際環(huán)境需要通過JS文件,調(diào)用函數(shù) |
說明 該示例僅供參考,實(shí)際集成中不能直接應(yīng)用,否則會導(dǎo)致無法正常獲取認(rèn)證URL。 |
FaceContrastPicture | String | 是 說明 您需要在下述四種傳入人臉照片方式中,選擇其中一種:
如果您選擇OSS方式傳入人臉照片,您必須傳入OssBucketName和OssObjectName參數(shù)。OSS請求參數(shù)格式僅支持開通實(shí)人認(rèn)證服務(wù)時(shí)授權(quán)的OSS生成的URL、Bucket和Object。 | 照片Base64編碼。如果您選擇FaceContrastPicture(照片Base64編碼)方式傳入人臉照片,請注意檢查照片大小,不要傳入過大的照片;您可以通過OSS方式上傳較大的人臉照片。 | /9j/4AAQSkZJRgABAQAASxxxxxxx |
FaceContrastPictureUrl | String | 人像地址,公網(wǎng)可訪問的HTTP、HTTPS鏈接。 | https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg | |
CertifyId | String | 之前實(shí)人認(rèn)證通過的CertifyId,認(rèn)證時(shí)的照片作為比對照片。您需要確保傳入CertifyId關(guān)聯(lián)的圖片正常存儲在授權(quán)的OSS Bucket中。 | 0bfa7c493f850e5178b9f8613634**** | |
OssBucketName | String | 已授權(quán)OSS空間的Bucket名稱。 | cn-shanghai-aliyun-cloudauth-xxxxx | |
OssObjectName | String | 已授權(quán)OSS空間的Object名稱。 | verify/xxxxx/xxxxxx.jpeg | |
UserId | String | 是 | 您自定義的用戶ID,請保持唯一。 | 123456789 |
Mobile | String | 否 | 您終端用戶的手機(jī)號碼。 | 130xxxxxxxx |
Ip | String | 否 | 您終端用戶的IP。 | 47.100.XX.XX |
CallbackUrl | String | 否 | 認(rèn)證結(jié)果的回調(diào)通知地址,回調(diào)請求方式默認(rèn)為GET,回調(diào)地址必須以 說明 僅當(dāng)認(rèn)證完成(包含認(rèn)證通過和認(rèn)證未通過)時(shí)才會觸發(fā)回調(diào),若認(rèn)證中放棄、異常中斷或未進(jìn)行認(rèn)證均不會通知。建議您收到回調(diào)通知時(shí),若有需要可通過查詢接口獲取認(rèn)證詳情信息。 | https://www.aliyun.com |
CallbackToken | CallbackToken | 否 | 安全Token,由您自行生成,用于防重復(fù)、防篡改校驗(yàn)。 如果設(shè)置了該值,會在回調(diào)地址中顯示CallbackToken字段。 | NMjvQanQgplBSaEI0sL86WnQplB |
CertifyUrlType | String | 否 | Web SDK設(shè)備類型。取值WEB或者H5。 說明 只支持Web SDK設(shè)備類型。 | WEB |
CertifyUrlStyle | String | 否 | 返回CertifyUrl類型,包括:
| L |
Crop | String | 否 | 是否允許裁剪人臉圖片,默認(rèn)不允許。
說明
| T |
AuthId | String | 否 | 用戶授權(quán)ID,最大長度為64位字符。 | 92d46b9e9e2d703f2897f350d5bd4149 |
EncryptType | String | 否 | 加密類型。為空表示不加密。 如開啟加密傳輸,需傳入加密算法。目前僅支持SM2國密算法。 如需傳入加密算法,需對CertName和CertNo進(jìn)行加密,并傳入加密后的密文。有關(guān)參數(shù)加密的更多信息,請參見參數(shù)加密說明。 | SM2 |
FaceGuardOutput | String | 否 | 人臉保鏢標(biāo)簽種類。 DeviceRisk:設(shè)備風(fēng)險(xiǎn)標(biāo)簽。
說明 | DeviceRisk |
uiCustomUrl | String | 否 | UI配置文件URL。關(guān)于Web SDK自定義UI說明,請參見Web SDK UI自定義配置說明。 | www.aliyundoc.com |
VideoEvidence | String | 否 | 是否開啟視頻存證。
說明 因?yàn)橐曨l文件較大,當(dāng)網(wǎng)絡(luò)不穩(wěn)定時(shí)系統(tǒng)會丟棄視頻文件優(yōu)先保障認(rèn)證必要圖片傳輸,建議您業(yè)務(wù)上設(shè)置為弱依賴視頻。 | false |
返回參數(shù)
名稱 | 類型 | 描述 | 示例值 |
RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Message | String | 返回信息。 | success |
Code | String | 返回碼:200為成功,其他為失敗。 | 200 |
ResultObject.CertifyId | String | 實(shí)人認(rèn)證唯一標(biāo)識。 重要 CertifyId字段為計(jì)費(fèi)統(tǒng)計(jì)字段,為了方便后續(xù)核對賬單,請您在本地留存該字段信息。 初始化接口返回的認(rèn)證CertifyId在30分鐘有效且僅能認(rèn)證提交一次,請您在有效期內(nèi)應(yīng)用,避免重復(fù)使用。 | 91707dc296d469ad38e4c5efa6a0f24b |
ResultObject.CertifyUrl | String | Web瀏覽器進(jìn)行實(shí)人認(rèn)證的URL,認(rèn)證結(jié)束后根據(jù)入?yún)?span data-tag="parmname" id="parmname-e4v-nuu-ne6" class="parmname">ReturnUrl進(jìn)行跳轉(zhuǎn)。 警告
| https://t.aliyun.com/**** |
返回Code和Message說明
Code | Message | 描述 |
200 | success | 成功。 |
400 | 參數(shù)不能為空 | 參數(shù)不能為空。 |
401 | 參數(shù)非法 | 非法參數(shù)。傳入的姓名、身份證號碼長度必須符合國家標(biāo)準(zhǔn)且不得包含英文字母等特殊字符。 |
402 | 應(yīng)用配置不存在 | 應(yīng)用配置不存在。 |
404 | 認(rèn)證場景配置不存在 | 認(rèn)證場景配置不存在,請先在控制臺上創(chuàng)建認(rèn)證場景。 |
410 | 未開通服務(wù) | 未開通OSS產(chǎn)品或未完成OSS讀寫授權(quán),請登錄控制臺完成授權(quán)。 |
411 | RAM無權(quán)限 | 需要給RAM用戶授予AliyunAntCloudAuthFullAccess的操作權(quán)限。 |
412 | 欠費(fèi)中 | 金融級實(shí)人認(rèn)證或OSS存在欠費(fèi),請充值后操作。 |
414 | 設(shè)備類型不支持 | 當(dāng)前移動設(shè)備不支持刷臉認(rèn)證,請更換設(shè)備后操作。 |
415 | SDK版本不支持 | 當(dāng)前認(rèn)證SDK版本不支持刷臉認(rèn)證,請升級SDK后操作。 |
416 | 系統(tǒng)版本不支持 | 當(dāng)前操作系統(tǒng)版本不支持刷臉認(rèn)證,請升級系統(tǒng)或更換設(shè)備操作。 |
417 | 無法使用刷臉服務(wù) | 自定義比對源的圖片人臉特征提取失敗,建議更換圖片上傳。 |
418 | 刷臉失敗次數(shù)過多 | 當(dāng)天刷臉認(rèn)證次數(shù)過多,請T+1日再試。 |
419 | 傳入圖片不可用 | 圖片無法下載、圖片內(nèi)容為空或圖片分辨率不符合要求。 |
420 | 數(shù)據(jù)重復(fù) | 圖片傳入方式超過了一種。 支持以下四種傳入人臉照片的方式,必須且只能使用其中一種:
|
421 | 傳入圖片過大 | 圖片超過了1 MB,建議壓縮圖片或更換圖片上傳方式。 |
422 | 下載圖片超時(shí) | 圖片下載超過了3秒,請排查網(wǎng)絡(luò)后重新操作。 |
423 | 狀態(tài)錯(cuò)誤 | 傳入的CertifyId認(rèn)證狀態(tài)需要為T(認(rèn)證通過),您也可以更換其他方式傳入圖片。 |
500 | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)內(nèi)部錯(cuò)誤,請反饋工程師進(jìn)行排查。 |
DescribeFaceVerify-獲取認(rèn)證結(jié)果
當(dāng)您收到回調(diào)通知之后,可以在服務(wù)端通過該接口獲取相應(yīng)的認(rèn)證狀態(tài)和認(rèn)證資料。
請求參數(shù)
名稱 | 類型 | 是否必選 | 描述 | 示例值 |
SceneId | Long | 是 | 認(rèn)證場景ID。 | 100000****** |
CertifyId | String | 是 | 實(shí)人認(rèn)證唯一標(biāo)識。 | 91707dc296d469ad38e4c5ef****** |
返回參數(shù)
名稱 | 類型 | 描述 | 示例值 |
Passed | String | 認(rèn)證結(jié)果。取值:
判斷認(rèn)證結(jié)果請以ResultObject.Passed字段為準(zhǔn)。 | T |
SubCode | String | 認(rèn)證結(jié)果描述。更多信息,請參見ResultObject.SubCode錯(cuò)誤碼說明。 說明 判斷認(rèn)證結(jié)果請以Passed字段為準(zhǔn)。 | 200 |
IdentityInfo | String | 認(rèn)證的主體信息,一般的認(rèn)證場景返回為空。 | 無。 |
DeviceToken | String | 設(shè)備Token。 | McozS1ZWRcRZStlERcZZo_QOytx5jcgZoZJEoRLOABBF**** |
ResultObject.DeviceRisk | String | 設(shè)備風(fēng)險(xiǎn)標(biāo)簽。 | ROOT,VPN,HOOK 說明 多個(gè)設(shè)備風(fēng)險(xiǎn)標(biāo)簽以半角逗號(,)分隔。如需了解更多設(shè)備風(fēng)險(xiǎn)標(biāo)簽及其含義,請參見人臉保鏢標(biāo)簽說明。 |
MaterialInfo | String | 認(rèn)證主體附件信息,主要為圖片類材料。JSON格式。 | 無。 |