首页 > OCR > 身份证OCR API

身份证OCR API

身份证OCR（API）定义：身份证OCR实现用户信息的自动识别和录入，应用于金融场景用户远程的身份认证，识别速度快，准确率高，减少用户输入成本，有效提高用户的体验。

￥0.00 （100次）

价格：

更多价格，联系右下角“客服”

立即购买

请求信息
返回信息
示例代码

接口信息

请求URL：http(s)://ocr-api.shiliuai.com/api/id_card_ocr/v1

请求方式：POST

返回类型：JSON

接口参数

请求参数（Header）

方式一：简单认证

参数	类型	说明
Authorization	string	'APPCODE ' + 您的AppCode (注意英文空格)
Content-Type	string	application/json

方式二：签名认证

参数	类型	说明
Content-Type	string	application/json
x-ca-key	string	您的AppKey
x-ca-timestamp	string	时间戳（毫秒）
x-ca-signature	string	签名sign

注：签名方法

str = app_key×tamp&app_secret

sign = md5(str)

请求参数（Query）

请求参数（Body）

参数	是否必填	类型	说明
image_base64	必填	string	base64编码的图片文件
return_rectified_card	选填	bool	是否返回裁剪并矫正的身份证图片，默认为False
card_margin_ratio	选填	float	裁剪时的边距比例，等于边距/长边，默认为0
card_width	选填	int	裁剪后的证件图片的宽度
card_height	选填	int	裁剪后的证件图片的高度（如果card_width和card_height都不传，或者都传-1，那么用原图中证件大小如果其中一个>0, 另一个不传或传-1，那么表示该长度按比例缩放得到）
return_rectified_head	选填	bool	是否返回裁剪并矫正的头像图片，默认为False，头像图片里，头顶和上边会有一些距离( 长宽比是441:358 )
head_width	选填	int	裁剪后的头像图片的宽度，如果head_width和head_height都不传，或者都传-1，那么用原图中头像大小，如果其中一个>0, 另一个不传或传-1，那么表示该长度按比例缩放得到
head_height	选填	int	裁剪后的头像图片的高度

平台通过已登录用户信息获取当前账号临时 Access Keys、"发起请求" 可能对当前账号发起线上资源操作，请小心操作

简单认证

签名认证

Python

PHP

Java

67 lines

                                                            import com.alibaba.fastjson.JSON;
        import com.alibaba.fastjson.JSONObject;
        import org.apache.http.HttpResponse;
        import org.apache.http.util.EntityUtils;
        import java.io.File;
        import java.io.FileInputStream;
        import java.io.IOException;
        import java.util.HashMap;
        import java.util.Map;
        import org.apache.commons.codec.binary.Base64;
        
        
        public class Demo {
        
            public static String get_base64(String path) {
                String b64="";
                try {
                    File file = new File(path);
                    byte[] content = new byte[(int) file.length()];
                    FileInputStream finputstream = new FileInputStream(file);
                    finputstream.read(content);
                    finputstream.close();
                    b64 = new String(Base64.encodeBase64(content));
                } catch (IOException e) {
                    e.printStackTrace();
                    return b64;
                }
                
                return b64;
            }
        
            public static void main(String[] args) {
                String url = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1"; // 请求接口
                String appcode = "你的APPCODE";
                String imgFile = "本地图片路径";
                String method = "POST";
                
                Map headers = new HashMap();
                headers.put("Authorization", "APPCODE " + appcode);  # 注意英文空格
                headers.put("Content-Type", "application/json");
                
                // base64
                Map querys = new HashMap();
                String imgBase64 = get_base64(imgFile);  
                
                // 请求体
                JSONObject requestObj = new JSONObject();
                requestObj.put("image_base64", imgBase64);
                String bodys = requestObj.toString();
                
                try {
                    HttpResponse response = HttpUtils.doPost(host, path, method, headers, querys, bodys);
                    int stat = response.getStatusLine().getStatusCode();
                    if(stat != 200){
                        System.out.println("Http code: " + stat);
                        return;
                    }
        
                    String res = EntityUtils.toString(response.getEntity());
                    JSONObject res_obj = JSON.parseObject(res);
            
                    System.out.println(res_obj.toJSONString());
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
                                                    
                                                
44 lines

                                                            //图片转base64
        function get_base64($path){
            if($fp = fopen($path, "rb", 0)) {
                $binary = fread($fp, filesize($path)); // 文件读取
                fclose($fp);
                $b64 = base64_encode($binary); // 转base64
            }else{
                $b64="";
                printf("%s 文件不存在", $path);
            }
            return $b64;
        }
    
        $url = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1";
        $appcode = "你的appcode";
        $img_path = "图片路径";
        $method = "POST";
    
        //请求头
        $headers = array();
        array_push($headers, "Authorization:APPCODE " . $appcode);
        array_push($headers, "Content-Type:application/json");
    
        //请求体
        $b64 = get_base64($img_path);
        $data = array(
            "image_base64" => $b64
        );
        $post_data = json_encode($data);
    
        //请求
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($curl, CURLOPT_FAILONERROR, false);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_HEADER, true);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
    
        $result = curl_exec($curl);
        var_dump($result);
                                                    
                                                    
                                                
36 lines

                                                            # -*- coding: utf-8 -*-
        import requests
        import base64
        import json
        
        # 请求接口
        URL = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1"
        
        # 图片转base64
        def get_base64(file_path):
            with open(file_path, 'rb') as f:
                data = f.read()
            b64 = base64.b64encode(data).decode('utf8')
            return b64
        
        
        def demo(appcode, file_path):
            # 请求头
            headers = {
                'Authorization': 'APPCODE %s' % appcode,
                'Content-Type': 'application/json'
            }
        
            # 请求体
            b64 = get_base64(file_path)
            data = {"image_base64": b64}
        
            # 请求
            response = requests.post(url=URL, headers=headers, json=data)
            content = json.loads(response.content)
            print(content)
        
        if __name__=="__main__":
            appcode = "你的APPCODE"
            file_path = "本地图片路径"
            demo(appcode, file_path)         
                                                    
                                                
48 lines

                                                            import requests
        import base64
        import json
        import hashlib
        import time
        
        # 请求接口
        URL = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1"
        
        # 图片转base64
        def get_base64(file_path):
            with open(file_path, 'rb') as f:
                data = f.read()
            b64 = base64.b64encode(data).decode('utf8')
            return b64
        
        # md5
        def md5(s):
            return hashlib.md5(s.encode("utf8")).hexdigest()
        
        
        def demo(app_key, app_secret, file_path):
            # 请求头
            t = int(time.time() * 1000)
            s = "%s%d%s" % (app_key, t, app_secret)
            sign = md5(s)
            headers = {'x-ca-key': app_key,
                    'x-ca-timestamp': t,
                    'x-ca-signature': sign,
                    "Content-Type": "application/json"}
        
        
            # 请求体
            b64 = get_base64(file_path)
            data = {"image_base64": b64}
        
        
            # 请求
            response = requests.post(url=URL, headers=headers, json=data)
            content = json.loads(response.content)
            print(content)
        
        if __name__=="__main__":
            app_key = "你的APP_KEY"
            app_secret = "你的APP_SECRET"
            file_path = "本地图片路径"
        
            demo(app_key, app_secret, file_path)
                                                        
                                                    
                                                
53 lines

                                                            function get_base64($path){
            if($fp = fopen($path, "rb", 0)) {
                $binary = fread($fp, filesize($path)); // 文件读取
                fclose($fp);
                $b64 = base64_encode($binary); // 转base64
            }else{
                $b64="";
                printf("%s 文件不存在", $path);
            }
            return $b64;
        }
    
        $url = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1";
        $img_path = "图片路径";
        $method = "POST";
    
    
        //请求头
        $app_key = "你的app_key";
        $app_secret = "你的app_secret";
        $sign_string = $app_key . "&" . $timestamp . "&" . $app_secret;
        $sign = md5($sign_string);
    
        $headers = array();
        array_push($headers, "Content-Type:application/json");
        array_push($headers, "x-ca-key:" . $app_key);
        array_push($headers, "x-ca-timestamp:" . $timestamp);
        array_push($headers, "x-ca-signature:" . $sign);
    
    
        //请求体
        $b64 = get_base64($img_path);
        $data = array(
            "image_base64" => $b64
        );
        $post_data = json_encode($data);
    
    
        //请求
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($curl, CURLOPT_FAILONERROR, false);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_HEADER, true);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
    
    
        $result = curl_exec($curl);
        var_dump($result);
                                                    
                                                    
                                                
100 lines

                                                            import com.alibaba.fastjson.JSON;
        import com.alibaba.fastjson.JSONObject;
        import org.apache.http.HttpResponse;
        import org.apache.http.util.EntityUtils;
        import java.io.File;
        import java.io.FileInputStream;
        import java.io.IOException;
        import java.util.HashMap;
        import java.util.Map;
        import org.apache.commons.codec.binary.Base64;
        import java.security.MessageDigest;
        import java.security.NoSuchAlgorithmException;
        
        
        public class Demo {
        
            public static String get_base64(String path) {
                String b64="";
                try {
                    File file = new File(path);
                    byte[] content = new byte[(int) file.length()];
                    FileInputStream finputstream = new FileInputStream(file);
                    finputstream.read(content);
                    finputstream.close();
                    b64 = new String(Base64.encodeBase64(content));
                } catch (IOException e) {
                    e.printStackTrace();
                    return b64;
                }
                
                return b64;
            }
        
            public static String MD5(String input) {
                String result = "";
                try {
                    MessageDigest md = MessageDigest.getInstance("MD5");
                    byte[] messageDigest = md.digest(sourceStr.getBytes());
        
                    StringBuilder hexString = new StringBuilder();
                    for (byte b : messageDigest) {
                        String hex = Integer.toHexString(0xff & b);
                        if (hex.length() == 1) 
                            hexString.append('0');
                        hexString.append(hex);
                    }
        
                    return hexString.toString();
        
                } catch (NoSuchAlgorithmException e) {
                    e.printStackTrace();
                }
            
                return null;
            }
        
        
            public static void main(String[] args) {
                String url = "https://ocr-api.shiliuai.com/api/id_card_ocr/v1"; // 请求接口
        
                String imgFile = "本地图片路径";
                String method = "POST";
                
                String app_key = "你的APPKEY";
                String app_secret = "你的APPSECRET";
                String timestamp = System.currentTimeMillis() + "";
                String sign = MD5(app_key + "&" + timestamp + "&" + app_secret));
        
                Map headers = new HashMap();
                headers.put("Content-Type", "application/json");
                headers.put("x-ca-key", app_key);
                headers.put("x-ca-timestamp", timestamp);
                headers.put("x-ca-signature", sign);
                
                // base64
                Map querys = new HashMap();
                String imgBase64 = get_base64(imgFile);  
                
                // 请求体
                JSONObject requestObj = new JSONObject();
                requestObj.put("image_base64", imgBase64);
                String bodys = requestObj.toString();
                
                try {
                    HttpResponse response = HttpUtils.doPost(host, path, method, headers, querys, bodys);
                    int stat = response.getStatusLine().getStatusCode();
                    if(stat != 200){
                        System.out.println("Http code: " + stat);
                        return;
                    }
        
                    String res = EntityUtils.toString(response.getEntity());
                    JSONObject res_obj = JSON.parseObject(res);
            
                    System.out.println(res_obj.toJSONString());
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
                                                    
                                                

返回信息

错误码说明

参数	参数类型	说明
code	int	错误码
msg	string	错误信息（英文）
msg_cn	string	错误信息（中文）
success	bool	识别是否成功
image_id	string	图片ID
request_id	string	唯一请求ID
data	data	具体看下面

data 信息

参数	参数类型	说明	举例
is_front	bool	是否正面
complete_score	float	完整度[0, 1]	0.8
is_complete	bool	是否完整，当complete_score==1时，为True	True
unoccluded_score	float	无遮挡程度[0, 1]
is_unoccluded	bool	是否无遮挡，当unoccluded_score>0.99时，为True
clear_score	float	[0, 1]，清晰度，用文字可识别度计算	0.9
is_clear	bool	是否清晰，当clear_score>0.5时，为True
rectified_card_base64	string	裁剪并矫正的身份证图片, 当return_rectified_card=True时有该项
rectified_head_base64	string	裁剪并矫正的头像图片, 当return_rectified_head=True且是正面时有该项

data 正面示例

参数	参数类型	说明	举例
name	string	姓名
sex	string	性别	男 / 女
ethnicity	string	民族	汉
birthDate	string	出生日期	1999年1月10日
address	string	地址
idNumber	string	身份证号

data 反面示例

参数	参数类型	说明
authority	string	签发机关
validPeriod	string	有效期限

错误码	说明
200	成功
400	错误请求，比如参数错误
401	未经授权
403	禁止访问
429	请求过多
500	内部错误
604	接口停用
1001	服务异常，返回具体的错误原因

商品介绍

简介

接入场景

支持各种程序和设备接入，包括小程序、APP、采集设备等，灵活适用于不同应用场景。

主要功能

身份证OCR接口能够准确识别照片文字信息并返回。其主要功能包括：

1.多类型覆盖：支持模糊、光照不均、透视畸变、复杂背景等低质量图像识别。

2.证件风险检测：智能判断图片完整度、支持复印件检测、翻拍检测。

3.服务稳定：提供弹性服务，扩展性好，算法持续的迭代优化对用户稳定性无影响。

4.超高精度及性能：识别准确率高，识别速度快，响应及时。

5.智能人像检测：支持自动定位身份证人像图片。

商品价格

API类型	价格说明
身份证OCR API	每次调用消耗一积分
如有问题联系右侧“客服”