本文介紹通過純服務端(API)單獨接入ID Verification 中 Id2MetaPeriodVerifyIntl 介面的流程。
介面說明
介面名:Id2MetaPeriodVerifyIntl
要求方法:HTTPS POST
介面說明:傳入姓名、社會安全號碼、身份證有效期間開始日期和到期日,通過權威源驗證其真實性和一致性。
重要僅支援中國內地第二代居民身份證。
QPS限量:API獨享QPS限量,詳情請參見ID Verification服務端API QPS限量說明。
服務地址:
說明內網指的是阿里雲同地區產品之間的內部通訊網路,如果您的商務服務器部署在阿里雲的對應地區,可以通過內網網域名稱訪問 ID Verification 服務,以獲得更安全、穩定的網路通訊品質。
中國香港
公網:
cloudauth-intl.cn-hongkong.aliyuncs.com內網:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
線上調試和整合
在調試和整合前,請確保您已完整閱讀使用OpenAPI調試和整合服務端API文檔,充分瞭解API介面在OpenAPI平台的調用方式和SDK及其代碼的擷取方式。
您可以在OpenAPI Explorer中直接運行本介面進行調試,並產生本介面的SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 樣本值 |
ProductCode | String | 是 | 要接入的產品方案。取值eKYC_Date_MIN。 | eKYC_Date_MIN |
SceneCode | String | 否 | 您自訂的認證情境ID,用於後續控制台輸入此情境ID查詢相關記錄。支援長度為10位的字母、數字或底線的組合。 | 1234567890 |
MerchantBizId | String | 是 | 自訂的業務唯一標識,用於後續定位排查問題。支援長度為32位的字母和數位組合,請確保唯一。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | 否 | 您自訂的使用者ID,或者其他可以識別特定使用者的標識,例如手機號碼、郵箱地址等。強烈建議對該欄位的值進行預先脫敏,例如對值進行雜湊處理。 | a1b2c3d4e5f64g7h8i9j0k1l2m3n4**** |
DocType | String | 是 | 證件類型,以8位元字組合作為唯一標識。 當前支援中國內地第二代居民身份證,請傳入固定值:00000001。 更多說明,請參見證件類型列表。 | 00000001 |
DocName | String | 是 | 使用者的姓名。 | 張三 |
DocNo | String | 是 | 使用者的證件號碼。 | 411xxxxxxxxxxx0001 |
ValidityStartDate | String | 是 | 有效期間開始日期,格式:YYYYMMDD。 | 20201001 |
ValidityEndDate | String | 是 | 身份證有效期間到期日,格式:YYYYMMDD。 說明 如果身份證有效期間是長期,此參數輸入:長期 。 | 20301001 |
返回資料
名稱 | 類型 | 描述 | 樣本值 | |
HTTP Status Code | Integer | HTTP狀態代碼。 | 200 | |
HTTP Body | RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | success | ||
Message | String | 返回Code的詳細描述。 | success | |
Result.Passed | String | 認證最終結果。取值:
| Y | |
Result.SubCode | String | 認證結果描述。更多資訊,請參見ResultObject.SubCode錯誤碼說明。 | 200 | |
返回Code
HTTP狀態代碼 | Code | Message描述 |
200 | Success | 請求成功。 |
400 | MissingParameter | 參數不可為空。 |
InvalidParameter | 非法參數。 | |
403 | Forbidden.RAMUserAccessDenied | 需要給RAM使用者授予AliyunAntCloudAuthFullAccess操作許可權。更多資訊,請參見授權RAM使用者訪問服務。 |
Forbidden.AccountAccessDenied | 確保您開通了ID verifycation,並且保證賬戶未欠費。 | |
Throttling.Api | API限流攔截。 | |
500 | InternalError | 系統內部錯誤,請反饋工程師排查。 |
ResultObject.SubCode錯誤碼說明
錯誤碼 | 是否計費 | 描述和原因建議 |
200 | Yes | 資訊核驗一致,建議認證通過。 |
202 | Yes | 官方資料庫查詢不到身份資訊。 可能是使用者的資訊有誤或使用者的資訊為虛假資訊,建議使用者確認後重新操作。 若使用者資訊確認正確,建議預留人工審核入口,進行人工審核。 |
223 | Yes | 官方資料庫中姓名和身份證不一致或身份證有效期間起止時間不一致。 可能是使用者的資訊有誤或使用者的資訊為虛假資訊,建議使用者確認後重新操作。 |