可結構化識別戶口常住人口登記卡頁面及戶主頁的內容，可有效識別戶口本上的相關戶籍證明信息。
接口說明
本接口適用場景
- 阿里云戶口本識別，是阿里云官方自研 OCR 文字識別產品，可用于識別戶口本戶主頁的戶主姓名、住址、戶號等字段。也適用于識別戶口本常住人口頁的出生日期、出生地、姓名、民族等信息的場景。
- 阿里云 OCR 產品基于阿里巴巴達摩院強大的 AI 技術及海量數據，歷經多年沉淀打磨，具有服務穩定、操作簡易、實時性高、能力全面等幾大優勢。
- 本接口圖片示例
本接口核心能力
| 分類 | 概述 |
|---|---|
| 圖像增強 | 默認支持圖像增強，包括圖像自動旋轉、畸變自動矯正、模糊圖片自動增強等能力。 |
| 多類型覆蓋 | 支持模糊、光照不均、透視畸變、任意背景等低質量圖像識別。 |
| 高精度識別 | 總體識別準確率可達 98%。 |
如何使用本接口
| 步驟 | 概述 |
|---|---|
| 1 | 開通 個人證照識別 服務。開通服務前后，您可以通過體驗館免費體驗本功能識別效果。 |
| 2 | 購買 個人證照識別資源包。本 API 會贈送免費額度，可使用免費額度測試。您也可以不購買資源包，系統會通過“按量付費”方式按實際調用量自動扣款。 |
| 3 | 可以參照調試頁面提供的代碼示例完成 API 接入開發。接入完成后，調用 API 獲取識別結果。如果使用子賬號調用接口，需要阿里云賬號（主賬號）對 RAM 賬號進行授權。創建 RAM 用戶的具體操作，請參考：創建 RAM 用戶。文字識別服務提供一種系統授權策略，即 AliyunOCRFullAccess。具體授權操作，請參見在用戶頁面為 RAM 用戶授權。 |
重要提示
| 類型 | 概述 |
|---|---|
| 圖片格式 |
|
| 圖片尺寸 |
|
| 圖片大小 |
|
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ocr:RecognizeHousehold | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Url | string | 否 |
| https://img.alicdn.com/tfs/TB11ZxTMxD1gK0jSZFsXXbldVXa-920-606.png |
| body | byte | 否 |
| 圖片二進制文件 |
| IsResidentPage | boolean | 否 |
| false |
返回參數
返回參數說明
| 字段 | 類型 | 說明 |
|---|---|---|
| data | object | 結構化信息。 |
| sliceRect | list | 檢測出的子圖坐標信息。 |
| prism_keyValueInfo | list | 結構化信息的坐標信息。 |
| ftype | int | 是否為復印件（1：是，0：否）。 |
| height | int | 算法矯正圖片后的高度。 |
| width | int | 算法矯正圖片后的寬度。 |
| orgHeight | int | 原圖的高度。 |
| orgWidth | int | 原圖的寬度。 |
結構化信息（戶主頁data字段，當 IsResidentPage 不傳或傳 false。）
| 字段 | 類型 | 說明 |
|---|---|---|
| Registrar | string | 承辦人簽章。 |
| address | string | 住址。 |
| householdNumber | string | 戶號。 |
| householdType | string | 戶別。 |
| householderCommunity | string | 戶主社區。 |
| householderName | string | 戶主姓名。 |
| issueDate | string | 簽發日期。 |
| sectionNo | string | 地段號。 |
結構化信息（常住人口頁data字段，當IsResidentPage=true。）
| 字段 | 類型 | 說明 |
|---|---|---|
| birthDate | string | 出生日期。 |
| birthPlace | string | 出生地。 |
| bloodGroup | string | 血型。 |
| educationalDegree | string | 文化程度。 |
| employer | string | 服務處所。 |
| ethnicity | string | 民族。 |
| formerName | string | 曾用名。 |
| householdNumber | string | 戶號。 |
| idCardNumber | string | 身份證編號。 |
| immigratedToCityInfo | string | 何時何地遷來本市。 |
| immigratedToResidenceInfo | string | 何時由何地遷來本址。 |
| maritalStatus | string | 婚姻狀況。 |
| militaryServiceStatus | string | 兵役狀況。 |
| name | string | 姓名。 |
| nativePlace | string | 籍貫。 |
| occupation | string | 職業。 |
| otherResidence | string | 本市其他住址。 |
| registrar | string | 承辦人簽章。 |
| registrationDate | string | 登記日期。 |
| relation | string | 與戶主關系。 |
| religious | string | 宗教信仰。 |
| sex | string | 性別。 |
| stature | string | 身高。 |
結構化坐標信息（prism_keyValueInfo 字段）
| 字段 | 類型 | 說明 |
|---|---|---|
| key | string | 識別出的字段名稱。 |
| keyProb | int | 字段名稱置信度。 |
| value | string | 識別出的字段名稱對應的值。 |
| valueProb | int | 字段名稱對應值的置信度。 |
| valuePos | list | 字段在原圖中的四個點坐標（左上、右上、右下、左下）。 |
示例
正常返回示例
JSON格式
{
"RequestId": "43A29C77-405E-4CC0-BC55-EE694AD00655",
"Data": "{\"angle\": 0, \"data\": {\"sectionNo\": \"4401030023005\", \"householdType\": \"居民戶口家庭戶\", \"householderName\": \"張無忌\", \"householderCommunity\": \"\", \"householdNumber\": \"000028901\", \"address\": \"廣東省廣州市荔灣區芳村大道中350號\", \"Registrar\": \"羅敏\", \"issueDate\": \"2012年04月17日\"}, \"ftype\": 0, \"height\": 606, \"orgHeight\": 606, \"orgWidth\": 920, \"prism_keyValueInfo\": [{\"key\": \"sectionNo\", \"keyProb\": 100, \"value\": \"4401030023005\", \"valuePos\": [{\"x\": 106, \"y\": 5}, {\"x\": 289, \"y\": 4}, {\"x\": 289, \"y\": 28}, {\"x\": 107, \"y\": 30}], \"valueProb\": 100}, {\"key\": \"householdType\", \"keyProb\": 100, \"value\": \"居民戶口家庭戶\", \"valuePos\": [{\"x\": 137, \"y\": 46}, {\"x\": 317, \"y\": 43}, {\"x\": 317, \"y\": 73}, {\"x\": 138, \"y\": 76}], \"valueProb\": 100}, {\"key\": \"householderName\", \"keyProb\": 100, \"value\": \"張無忌\", \"valuePos\": [{\"x\": 523, \"y\": 48}, {\"x\": 523, \"y\": 74}, {\"x\": 457, \"y\": 74}, {\"x\": 457, \"y\": 48}], \"valueProb\": 100}, {\"key\": \"householderCommunity\", \"keyProb\": 100, \"value\": \"\", \"valueProb\": 100}, {\"key\": \"householdNumber\", \"keyProb\": 100, \"value\": \"000028901\", \"valuePos\": [{\"x\": 225, \"y\": 108}, {\"x\": 225, \"y\": 126}, {\"x\": 145, \"y\": 126}, {\"x\": 145, \"y\": 108}], \"valueProb\": 100}, {\"key\": \"address\", \"keyProb\": 100, \"value\": \"廣東省廣州市荔灣區芳村大道中350號\", \"valuePos\": [{\"x\": 379, \"y\": 88}, {\"x\": 807, \"y\": 84}, {\"x\": 807, \"y\": 114}, {\"x\": 379, \"y\": 119}], \"valueProb\": 100}, {\"key\": \"Registrar\", \"keyProb\": 100, \"value\": \"羅敏\", \"valuePos\": [{\"x\": 332, \"y\": 499}, {\"x\": 332, \"y\": 529}, {\"x\": 279, \"y\": 529}, {\"x\": 279, \"y\": 499}], \"valueProb\": 100}, {\"key\": \"issueDate\", \"keyProb\": 100, \"value\": \"2012年04月17日\", \"valuePos\": [{\"x\": 738, \"y\": 497}, {\"x\": 738, \"y\": 538}, {\"x\": 462, \"y\": 538}, {\"x\": 462, \"y\": 497}], \"valueProb\": 100}], \"sliceRect\": {\"x0\": 1, \"y0\": 7, \"x1\": 918, \"y1\": 4, \"x2\": 920, \"y2\": 600, \"x3\": 5, \"y3\": 606}, \"width\": 920}",
"Code": "200",
"Message": "message"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2021-08-17 | OpenAPI 入參發生變更 | 查看變更詳情 |
SDK 調用 通過 SDK 調用此接口的示例請參考開發者中心