身份证识别


Step1: 制作签名

身份证识别API接口签名方法需遵循“AWS API 2.0 签名规范”。

需要将签名字段按照如下方法进行拼接,并按照指定Hash算法计算后,以base64编码方式进行编码。


签名地址字段


字段 格式要求 说明 可选值
POST\n 大写、以换行\n结束 HTTP请求方法 必选
mosapi.meituan.con\n 小写,以换行\n结束 API服务主机名 必选
/mcs/v1\n\n 小写,以换行\n结束 请求绝对路径 必选

注:将所有签名地址字段拼接成string类型的字符串

例如:

POST\nmosapi.meituan.com\n/mcs/v1\n


签名参数字段


字段 类型 说明 可选值
Action string IDCardOCR 必选
AWSAccessKeyId string

访问API请求的ACCESS KEY ID

(用户在美团云控制台"API秘钥"可找到该值)

必选
SignatureVersion string 2 必选
Timestamp string 请求时间戳,iso8601格式:YYYY-MM-DDTHH:MM:SS.MMMZ 必选
SignatureMethod string

数字签名的Hash算法,可能的值为"HmacSHA256"和"HmacSHA1",分别对应SHA256和SHA1算法

必选
Format string json 必选

注:所有签名参数按照参数名称的 字典顺序进行排序,并以 x-www-form-urlencoded 编码拼接在一起:

为了保证认证通过请务必对请求参数进行URI编码,参数中的空格务必编码为%20。将空格编码为+会导致认证不通过。

例如:

AWSAccessKeyId=8b5ad48388a347c185b6b7b0ba9e6225&Action=GetBalance&Format=json&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2016-11-14T03%3A10%3A55.000Z


签名内容拼接


将签名地址、签名参数(字典序排序后)以 拼接成string类型的字符串

例如:

POST\nmosapi.meituan.com/mcs/v1\nAWSAccessKeyId=8b5ad48388a347c185b6b7b0ba9e6225&Action=GetBalance&Format=json&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2016-11-14T03%3A10%3A55.000Z

生成签名


用SECRET KEY作为秘钥对拼接后的签名内容以HmacSHA256算法进行Hash加密,并进行base64编码,最终获得签名:

例如:

xOnd5MauvUn8Kx8225Nh7tSYnuIB0oi5H2Jb00UU788=

Step2: 接口调用

接口:https://mosapi.meituan.com/mcs/v1

方法:POST


请求参数


参数名 类型 说明 可选项
Action string IDCardOCR 必选
AWSAccessKeyId string

访问API请求的ACCESS KEY ID

(用户在美团云控制台"API秘钥"可找到该值)

必选
SignatureVersion string 数字签名算法版本,该值为2 必选
Timestamp string 请求时间戳,iso8601格式:YYYY-MM-DDTHH:MM:SS.MMMZ 必选
SignatureMethod string 数字签名的Hash算法,可能的值为"HmacSHA256"和&"HmacSHA1",分别对应SHA256和SHA1算法 必选
Signature string 请求内容的数字签名,具体签名生成算法见上文的数字签名生成方法 必选
Format string 返回内容的编码格式,值为json 必选
image_content string 经Base64编码的照片内容
照片要求为JPEG格式
照片大小不超过3MB
必选
注:以上为HTTP请求包body中对应值,需要以 x-www-form-urlencoded 编码拼接在一起后才可进行HTTP请求
为了保证认证通过请务必对请求参数进行URI编码,参数中的空格务必编码为%20。将空格编码为+会导致认证不通过。


返回参数


返回类型:json

参数名 类型 说明
name string 姓名信息
address string 地址信息
id_number string 身份证号码信息
validity string 身份证有效期
sex string 性别
people string 民族
birthday string 出生年月日
issue_authority string 签发机关
idcard_type string 图片正反面类型
code int 错误返回码
err string 错误信息

返回示例:

情况一:传的是身份证正面

返回结果结构如下:


{
  "code" : 200,

  "err" : "",

  "ret" : {

    "id_number" : "1102271990827XXXX",

    "name" : "杨XX",

    "sec" : "男",

    "idcard_type" : "positive",

    "pepole" : "汉",

    "birthday" : "1990.08.27",

    "address" : "北京市怀柔区翠竹园小区XXX号楼XXX单元XXX门"
    }
}

情况二:传的是身份证反面

返回结果结构如下:


{
  "code" : 200,

  "err" : "",

  "ret" : {

    "validty" : "20060105-20110105",

    "issue_authority" : "泉河派出所",

    "idcard_type" : "back"
  }
}


示例代码

Python示例代码


  • 示例代码采用Python3版本
  • action字段内容对应Action内容
  • access_key、secret_key对应控制台中的Access Key ID、Access Key Secret

#! /usr/bin/env python3
#-*- coding:utf-8 -*-

import base64
import datetime
import hmac
import hashlib
import urllib
import urllib.parse
import requests
import json

access_key = ''  # Access Key ID
secret_key = ''  # Secret Key
image = '' #图片路径

action = 'IDCardOCR'
url = 'https://mosapi.meituan.com/mcs/v1'

def get_utf8_value(value):
    if not isinstance(value, str): #and not isinstance(value, unicodedata):#(python2版本需要此句)
        value = str(value)
    if isinstance(value, str): #unicode):#(python2版本需要此句)
        return value.encode('utf-8')
    else:
        return value

def sign(params):
    pairs = []
    for key in params.keys():
        val = get_utf8_value(params[key])
        val = urllib.parse.quote(val, safe='-_~')
        pairs.append(urllib.parse.quote(key, safe='') + '=' + val)
    query = '&'.join(sorted(pairs))
    msg = ('POST\nmosapi.meituan.com\n/mcs/v1\n%s' % query)
    content = hmac.new(secret_key.encode('utf-8'), msg.encode('utf-8'), hashlib.sha256).digest()
    ret = base64.b64encode(content).decode()
    return ret

def get_image():
    with open(image,'rb') as image1:
        pic = base64.b64encode(image1.read())
    return pic

def pack_data():
    data = {
        'AWSAccessKeyId':access_key,
        'Action': action,
        'Format': 'json',
        'SignatureMethod': 'HmacSHA256',
        'SignatureVersion': '2',
        'Timestamp': datetime.datetime.now().isoformat()[0:-3]+'Z',
    }
    data.update({'Signature' : sign(data)})
    data.update({'image_content' : get_image()})
    return data

def request():
    data = urllib.parse.urlencode(pack_data())
    headers = {
        'Content-type': 'application/x-www-form-urlencoded',
        'Accept': 'text/plain'
    }
    response = requests.post(
        url = url, data = data, headers = headers, verify = True
    )
    resp_format = json.loads(response.content.decode('utf-8'))
    return resp_format

if __name__ == '__main__':
    print(request())

PHP示例代码



$key_id = '您自己的 key_id';
$key_secret = '您自己的 key_secret';
$url = 'https://mosapi.meituan.com/mcs/v1';
$image_location = '您自己的本地图片路径';

function signature($post_array){
    $string_to_sign = "POST\n";
    $string_to_sign .= "mosapi.meituan.com\n";
    $string_to_sign .= "/mcs/v1\n";
    $string_to_sign .= array2xform($post_array);
    global $key_secret;
    $signature = base64_encode(hash_hmac('sha256', $string_to_sign, $key_secret, true));
    return $signature;
}
function array2xform($post_array){
    $string='';
    foreach ($post_array as $k => $v) {
        $string .= "&$k=".rawurlencode($v);
    }
    $string = substr($string, 1);
    return $string;
}
$file = fopen($image_location, 'rb');
$data = fread($file,filesize($image_location));
fclose($file);
$image_content = base64_encode($data);

$ch = curl_init();  
curl_setopt($ch, CURLOPT_URL, $url);
$post_array = array(
    'AWSAccessKeyId' => $key_id,
    'Action' => 'IDCardOCR',
    'Format' => 'json',
    'SignatureMethod' => 'HmacSHA256',
    'SignatureVersion' => 2,
    'Timestamp' => date('Y-m-d\TH:i:s.0000\Z', time())
);
$post_array['Signature'] = signature($post_array);
$post_array['image_content'] = $image_content;
$post_string = array2xform($post_array);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_string);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);
curl_close($ch);
echo $out;