申請流程
要使用 API,需要先到 身份證人像照片驗真 API 對應頁面申請對應的服務,進入頁面之後,點擊「Acquire」按鈕,如圖所示:
如果你尚未登錄或註冊,會自動跳轉到登錄頁面邀請您來註冊和登錄,登錄註冊之後會自動返回當前頁面。
在首次申請時會有免費額度贈送,可以免費使用該 API。
基本使用
首先先了解下基本的使用方式,就是輸入身份證圖片鏈接,便可獲得處理後驗證結果,首先需要簡單地傳遞一個image_url 字段,我們接下來就可以在界面上填寫對應的內容,如圖所示:

accept:想要接收怎樣格式的響應結果,這裡填寫為application/json,即 JSON 格式。authorization:調用 API 的密鑰,申請之後可以直接下拉選擇。
image_url:需要處理的身份證圖片鏈接。config:可選配置項,布爾值字段,默認都為 false,支持copy_warn、border_check_warn、reshoot_warn、detect_ps_warn、temp_id_warn、quality(閾值 0-100)。

sim,相似度,取值範圍 [0.00, 100.00]。推薦相似度大於等於70時可判斷為同一人,可根據具體場景自行調整閾值(閾值70的誤通過率為千分之一,閾值80的誤通過率是萬分之一)result,業務錯誤碼,成功情況返回Success, 錯誤情況請參考下方錯誤碼 列表中FailedOperation部分。description,此處姓名與身份證號碼驗證的結果。name,身份證中的姓名信息,如果沒有上傳身份證圖片則是空的。sex,身份證中的性別信息,如果沒有上傳身份證圖片則是空的。nation,身份證中的民族信息,如果沒有上傳身份證圖片則是空的。birth,身份證中的生日信息,如果沒有上傳身份證圖片則是空的。address,身份證中的家庭住址信息,如果沒有上傳身份證圖片則是空的。id_num,身份證中的身份證號碼信息,如果沒有上傳身份證圖片則是空的。portrait,身份證頭像照片的base64編碼,如果抠圖失敗會拿整張身份證做比對並返回空。warnings,告警信息,當在Config中配置了告警信息會停止人像比對,Result返回錯誤(FailedOperation.OcrWarningOccurred)並有此告警信息。quality,圖片質量分數,當請求Config中配置圖片模糊告警該參數才有意義,取值範圍(0~100),目前默認閾值是50分,低於50分會觸發模糊告警。encryption,敏感數據加密信息。
錯誤處理
在調用 API 時,如果遇到錯誤,API 會返回相應的錯誤代碼和信息。例如:400 token_mismatched:Bad request, possibly due to missing or invalid parameters.400 api_not_implemented:Bad request, possibly due to missing or invalid parameters.401 invalid_token:Unauthorized, invalid or missing authorization token.429 too_many_requests:Too many requests, you have exceeded the rate limit.500 api_error:Internal server error, something went wrong on the server.

