全部產品
Search
文件中心

ID Verification:ID_OCR_MIN

更新時間:Sep 10, 2025

本文介紹調用DocOcr介面的純服務端接入流程。通過該介面實現對身份證件圖片的資訊自動提取,及相關防偽風險判斷。

介面說明

  • 介面名:DocOcr

  • 要求方法:HTTPS POST

  • 介面說明:調用DocOcr介面,通過OCR技術對各種身份證件(如護照、身份證等)進行自動資訊提取及相關防偽檢查。

  • 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程式碼範例

傳入圖片格式要求

為了確保模型效果穩定,請傳入滿足以下所有條件的圖片:

  • 圖片格式:JPG、JPEG、PNG。

  • 圖片大小:推薦50~100 KB,最大不超過1 MB。

    說明

    圖片轉base64格式後,通常會導致資料體積增加。如您需要使用base64格式傳參,請保證原始圖片的體積不超過0.6MB,以滿足1MB的最巨量資料傳輸限制。

  • 圖片解析度:圖片長寬需要大於 200像素,小於 8192 像素,推薦480*640(高*寬)。

  • 圖片品質建議:

    • 卡證圖片需要保持四個邊角完整,避免手持時遮擋影響檢測。

    • 卡證圖片內容清晰、無遮擋和無曝光光斑,卡證圖片角度正常,避免傾斜或者倒置。

    • 卡證圖片面積需要佔比圖片面積60%以上,避免卡面圖片面積過小影響識別。

    • 建議採用真實證件拍攝。

請求參數

照片傳入提供兩種方式,任選其一即可。

  • IdOcrPictureBase64

  • IdOcrPictureUrl

名稱

類型

是否必選

描述

樣本值

ProductCode

String

要接入的產品方案。取值ID_OCR_MIN:使用證件OCR識別API。

ID_OCR_MIN

SceneCode

String

您自訂的認證情境ID,用於後續控制台輸入此情境ID查詢相關記錄。支援長度為10位的字母、數字和底線的組合。

1234567890

MerchantBizId

String

您自訂的業務唯一標識,用於後續定位排查問題。支援長度為32位的字母和數位組合,請確保唯一。

說明

阿里雲伺服器不會對該欄位的值進行唯一性檢查。為了更好地跟蹤,強烈建議保證欄位唯一性。

e0c34a77f5ac40a5aa5e6ed20c35****

MerchantUserId

String

您自訂的使用者ID,或者其他可以識別特定使用者的標識,例如:手機號碼、郵箱地址等。強烈建議對該欄位的值進行預先脫敏,例如對值進行雜湊處理。

123456789

IdOcrPictureBase64

String

證件頭像面圖片Base64編碼。如果您選擇IdOcrPictureBase64(照片Base64編碼)方式傳入證件照片,請注意檢查照片大小,不要傳入過大的照片。

base64

IdOcrPictureUrl

String

證件頭像面圖片地址,公網可訪問的HTTP、HTTPS連結。

https://***

DocType

String

證件類型,以8位元字組合作為唯一標識,詳見證件類型列表

F

Ocr

String

是否開啟OCR功能進行證件資訊自動提取。

  • T:開啟OCR功能

  • F:不開啟OCR功能

T

IdFaceQuality

String

是否返回證件人臉的品質分,預設不開啟。

說明

僅證件人像面照片有效。

  • T:返回人臉品質分

  • F:不返回

F

Spoof

String

是否開啟證件防偽功能,預設不開啟。

說明

僅證件人像面照片有效。

  • T:開啟證件防偽功能

  • F:不開啟

F

IdThreshold

String

自訂OCR品質檢測閾值模式:

  • 0:標準模式

  • 1:strict 模式

  • 2:寬鬆模式

  • 3(預設):關閉品質檢測

3

CardSide

String

區分證件國徽面和人像面 ,不傳預設人像面 。

  • OCR_ID_FACE (預設):人像面

  • OCR_ID_NATIONAL_EMBLEM :國徽面

重要

僅適用中華人民共和國居民身份證

OCR_ID_NATIONAL_EMBLEM

證件類型列表

DocType

對應證件

01000000

全球護照

00000006

中國香港居民身份證(2003版)

00000008

中國香港居民身份證(2018版)

00000007

往來港澳通行證

00000009

港澳居民來往內地通行證

000000011

中國澳門身份證

000000012

台灣居民來往大陸通行證

00000001

中國內地第二代居民身份證

返回資料

名稱

類型

描述

樣本值

HTTP Status Code

Integer

HTTP狀態代碼。

200

HTTP Body

RequestId

String

請求ID。

130A2C10-B9EE-4D84-88E3-5384FF039****

Result.TransactionId

String

整個認證流程的唯一標識。

hksb7ba1b28130d24e015d694361b****

Code

String

返回Code

Success

Message

String

返回Code的詳細描述。

success

Result.Passed

String

認證結果,取值:

  • Y:通過

  • N:不通過

Y

Result.SubCode

String

認證結果描述。更多資訊,請參見ResultObject.SubCode錯誤碼說明

200

Result.ExtIdInfo

String

證件識別相關結果資訊。關於JSON格式,請參見右側樣本。更多資訊,請參見ExtIdInfo

{
  "idFaceQualityScore": 98.0,
  "ocrIdInfo": {
    "expiryDate": "",
    "originOfIssue": "公安部出入境管理局",
    "englishName": "LI SI",
    "sex": "男",
    "name": "李四",
    "idNumber": "H11111112",
    "issueDate": "2013-01-02",
    "birthDate": "1990-02-21"
  },
  "spoofInfo": {
    "spoofResult": "Y",
    "spoofType": [
      "SCREEN_REMARK"
    ]
  }
}

ExtIdInfo

名稱

類型

描述

樣本值

ocrIdInfo

String

證件OCR欄位資訊。更多資訊,請參見OCR識別返回欄位

說明

如果證件OCR流程失敗,則該欄位值為空白。

{
  "expiryDate": "",
  "originOfIssue": "公安部出入境管理局",
  "englishName": "LI SI",
  "sex": "男",
  "name": "李四",
  "idNumber": "H11111112",
  "issueDate": "2013-01-02",
  "birthDate": "1990-02-21"
}

idFaceQualityScore

Double

上傳證件圖片中人臉的品質分,取值範圍0~100。

99.95

spoofInfo

String

證件防偽檢測結果,包括風險判定結果和風險類型:

說明

僅當Initialize介面中 IdSpoof = Y 時,才會開啟卡證檢測。

否則 spoofResult 預設返回NspoofType 為空白。

  • spoofResult:

    • Y存在風險

    • N正常

  • spoofType:

    • SCREEN_REMARK翻拍

    • PHOTO_COPY複印件

    • TAMPER:PS篡改

{
 "spoofResult": "Y",
 "spoofType": ["SCREEN_REMARK"]
}

返回Code

HTTP狀態代碼

Code

Message說明

200

Success

請求成功。

400

MissingParameter

參數不可為空。

InvalidParameter

非法參數。

401

UnqualifiedPhoto

傳入的圖片不可讀,或圖片解析度不符合要求,建議更換圖片。

需確保照片清晰、曝光正常,完整無遮擋,角度無太大偏差。

DataDuplication

同時傳入Base64編碼的圖片和Url圖片地址,此二參數任選其一即可。

ToolargeImage

圖片尺寸過大,建議壓縮圖片或更換圖片上傳方式。

DownloadTimeout

URL圖片下載逾時。

403

Forbidden.RAMUserAccessDenied

需要給RAM使用者授予 AliyunAntCloudAuthFullAccess 操作許可權。更多資訊,請參見授權RAM使用者訪問服務

Forbidden.AccountAccessDenied

確保您開通了ID verifycation,並且保證賬戶未欠費。

Throttling.Api

API限流攔截。

500

InternalError

系統內部錯誤,請反饋給工程師排查。

ResultObject.SubCode錯誤碼說明

說明

Subcode基於不同產品方案或整合方式返回,詳情可參考下表。

適用方案

錯誤碼

認證記錄是否計費

描述和原因建議

通用

200

認證通過。

  • ID_OCR 純服務端接入(DocOcr)

  • ID_OCR_MAX

211

證件圖片品質或解析度不符合要求,或者圖片本身不完整。請確保證件人像面照片清晰、曝光正常,完整無遮擋,角度無太大偏差。

  • ID_OCR App(SDK)接入

  • ID_OCR Web(SDK)接入

  • ID_OCR_MAX

212

證件防偽檢測存在風險。可能存在翻拍、篡改、複印等高風險操作。

  • ID_OCR 純服務端接入(DocOcr)

  • ID_OCR_MAX

213

未檢測到指定對應證件類型(識別模式)或無法識別證件類型(分類模式)。

建議傳入清晰完整且角度正常的證件圖片。

OCR識別返回欄位

中國香港居民身份證

說明

智能身份證2003和2018版本均支援。

欄位

類型

描述

name

String

姓名

englishName

String

姓名(英文)

nameCode

String

中文姓名電碼

sex

String

性別,取值:

  • M:男

  • F:女

birthDate

String

出生日期

idNumber

String

社會安全號碼碼

currentIssueDate

String

登記日期

firstIssueDate

String

首次登記的月份和年份

isPermanent

String

是否屬於永久性居民身份證,取值:

  • Y:屬於

  • N:不屬於

symbols

String

符號標記。例如:"***AZ"。

往來港澳通行證

欄位

類型

描述

name

String

姓名

englishName

String

姓名(拼音)

sex

String

性別

birthDate

String

出生日期

idNumber

String

證件號碼

issueDate

String

簽發日期

expiryDate

String

失效日期

placeOfIssue

String

簽發地點

originOfIssue

String

簽發機關

港澳居民來往內地通行證

欄位

類型

描述

name

String

姓名

englishName

String

姓名(英文)

sex

String

性別

birthDate

String

出生日期

idNumber

String

證件號碼

issueDate

String

簽發日期

expiryDate

String

失效日期

originOfIssue

String

簽發機關

台灣居民來往大陸通行證

欄位

類型

描述

name

String

姓名

englishName

String

姓名(拼音)

sex

String

性別

birthDate

String

出生日期

idNumber

String

證件號碼

issueDate

String

簽發日期

expiryDate

String

失效日期

originOfIssue

String

簽發機關

placeOfIssue

String

簽發地點

全球護照

欄位

類型

描述

surname

String

givenname

String

sex

String

性別

birthDate

String

出生日期

passportNo

String

護照號

nationality

String

國籍

expiryDate

String

失效日期

countryCode

String

國家代碼

中國澳門居民身份證

欄位

類型

描述

surnameCN

String

姓(中文)

givennameCN

String

名(中文)

surname

String

姓(英文)

givenname

String

名(英文)

sex

String

性別

birthDate

String

出生日期

idNumber

String

證件號碼

expiryDate

String

失效日期

placeOfBirth

String

出生地代碼。例如:"AS"。

中華人民共和國居民身份證

欄位

類型

描述

name

String

姓名

sex

String

性別

ethnicity

String

民族

birthDate

String

出生日期

idNumber

String

社會安全號碼

address

String

地址

province

String

說明

預留欄位,預設返回為空白。

city

String

說明

預留欄位,預設返回為空白。

originOfIssue

String

簽發機關

issueDate

String

簽發日期

expiryDate

String

失效日期