身份证识别
旷视 官方文档
检测和识别中华人民共和国第二代身份证的关键字段内容,并支持返回身份证正反面信息、身份证照片分类判断结果。
基本说明:
接口地址:https://api-cn.faceplusplus.com/cardpp/v1/ocridcard
返回格式:json
请求方式:post
请求示例:https://api-cn.faceplusplus.com/cardpp/v1/ocridcard?api_key=1&api_secret=2&image_url=3
请求参数说明:
名称 类型 必填 说明
api_key string 必填 Face++的 API Key
api_secret string 必填 Face++的 API Secret
image_url string 必填 图片的 URL
legality int 选填 是否返回身份证照片合法性检查结果
返回参数说明:
名称 类型 说明
request_id string 用于区分每一次请求的唯一的字符串。
cards array 检测出证件的数组
image_id string 被检测的图片在系统中的标识
time_used int 整个请求所花费的时间,单位为毫秒。
error_message string 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。
JSON返回示例:
{
	"cards": [{
		"gender": "女",
		"name": "牛XX",
		"id_card_number": "XXXXXX19841013XXXX",
		"birthday": "1984-10-13",
		"race": "汉",
		"address": "广东省深圳市XXXXXXXX",
		"legality": {
			"Edited": 0.001,
			"Photocopy": 0,
			"ID Photo": 0.502,
			"Screen": 0.496,
			"Temporary ID Photo": 0
		},
		"type": 1,
		"side": "front"
	}],
	"time_used": 2151,
	"request_id": "1473759244,40dfde25-6d1a-4c90-a994-813556c81e30"
}
服务级错误码参照
错误码 说明
401 api_key 和 api_secret 不匹配。
403 api_key 没有调用本 API 的权限,具体原因为:用户自己禁止该 api_key 调用、管理员禁止api_key 调用、由于账户余额不足禁止调用。
403 并发数超过限制。
400 缺少某个必选参数。
400 某个参数解析出错(比如必须是数字,但是输入的是非数字字符串; 或者长度过长,etc.)
400 同时传入了要求是二选一或多选一的参数。如有特殊说明则不返回此错误。
413 客户发送的请求大小超过了 2MB 限制。该错误的返回格式为纯文本,不是 json 格式。
404 所调用的 API 不存在。
500 服务器内部错误,当此类错误发生时请再次请求,如果持续出现此类错误,请及时联系技术支持团队。
完整教学代码示例
<?php
/**
 * Created by PhpStorm.
 * User: FZS
 * Time: 2020/11/02 21:53
 */
//----------------------------------
// 身份证识别 调用类
//----------------------------------
class freeApi
{
    private $apiKey = false;
    private $apiSecret = false;
    private $apiUrl = 'https://api-cn.faceplusplus.com/cardpp/v1/ocridcard';
    public function __construct($apikey,$apiSecret){
        $this->apiKey = $apikey;
        $this->apiSecret = $apiSecret;
    }
    /**
     * 将JSON内容转为数据,并返回
     * @param string $content [内容]
     * @return array
     */
    public function returnArray($content){
        return json_decode($content,true);
    }
    /**
     * 获取结果
     * @return array
     */
    public function getResult(){
        $params = [
            "api_key" => $this->apiKey,
            "api_secret" => $this->apiSecret,
            "image_url" => "",
        ];
        $params = http_build_query($params);
        return $this->returnArray($this->freeApiCurl($this->apiUrl,$params,1));
    }
    /**
     * 请求接口返回内容
     * @param  string $url [请求的URL地址]
     * @param  string $params [请求的参数]
     * @param  int $ipost [是否采用POST形式]
     * @return  string
     */
    public function freeApiCurl($url,$params=false,$ispost=0){
        $ch = curl_init();
        curl_setopt( $ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1 );
        curl_setopt( $ch , CURLOPT_SSL_VERIFYHOST , false );
        curl_setopt( $ch , CURLOPT_SSL_VERIFYPEER , false );
        curl_setopt( $ch, CURLOPT_USERAGENT , 'free-api' );
        curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT , 60 );
        curl_setopt( $ch, CURLOPT_TIMEOUT , 60);
        curl_setopt( $ch, CURLOPT_RETURNTRANSFER , true );
        if( $ispost )
        {
            curl_setopt( $ch , CURLOPT_POST , true );
            curl_setopt( $ch , CURLOPT_POSTFIELDS , $params );
            curl_setopt( $ch , CURLOPT_URL , $url );
        }
        else
        {
            if($params){
                curl_setopt( $ch , CURLOPT_URL , $url.'?'.$params );
            }else{
                curl_setopt( $ch , CURLOPT_URL , $url);
            }
        }
        $response = curl_exec( $ch );
        if ($response === FALSE) {
            return false;
        }
        curl_close( $ch );
        return $response;
    }
}