V兔API开放平台

参数	类型	必选	描述
image	和 url 二选一	string	图像数据，base64 编码后进行 urlencode，要求 base64 编码和 urlencode 后大小不超过 4M，最短边至少 15px，最长边最大 4096px,支持 jpg/jpeg/png/bmp 格式
url	和 image 二选一	string	图片完整 URL，URL 长度不超过 1024 字节，URL 对应的图片 base64 编码后大小不超过 4M，最短边至少 15px，最长边最大 4096px,支持 jpg/jpeg/png/bmp 格式，当 image 字段存在时 url 字段失效请注意关闭 URL 防盗链
id_card_side	是	string	-front：身份证含照片的一面 -back：身份证带国徽的一面自动检测身份证正反面，如果传参指定方向与图片相反，支持正常识别，返回参数 image_status 字段为"reversed_side"
detect_risk	否	string	是否开启身份证风险类型(身份证复印件、临时身份证、身份证翻拍、修改过的身份证)功能，默认不开启，即：false。 - true：开启，请查看返回参数 risk_type； - false：不开启
detect_photo	否	string	是否检测头像内容，默认不检测。可选值：true-检测头像并返回头像的 base64 编码及位置信息
detect_card	否	string	是否检测身份证进行裁剪，默认不检测。可选值：true-检测身份证并返回证照的 base64 编码及位置信息

请求示例

{
  "image": "https://apisown-test.bj.bcebos.com/idcard.jpg",
  "imageType": "1"
}

请求代码示例

cURL请求代码示例

PHP请求代码示例

JAVA请求代码示例

响应参数

名称	类型	描述
code	int	返回状态码
msg	string	返回码描述
msec	int	接口执行时间
time	int	接口返回时间
data	object	数据信息
--imageStatus	String	身份证状态： normal-识别正常 reversed_side-身份证正反面颠倒 non_idcard-上传的图片中不包含身份证 blurred-身份证模糊 other_type_card-其他类型证照 over_exposure-身份证关键字段反光或过曝 over_dark-身份证欠曝（亮度过低） unknown-未知状态
--riskType	String	识别身份证类型： normal-正常身份证 copy-复印件 temporary-临时身份证 screen-翻拍 unknown-其他未知情况
--editTool	String	如果身份证被编辑过，则返回指定编辑软件名称；否则返回值无此参数
--result	List	识别结果列表，单个识别结果只包含人像面/国徽面识别字段二者之一
----name	String	人像面-姓名
----sex	String	人像面-性别
----birthDate	String	人像面-出生日期
----nationality	String	人像面-民族
----address	String	人像面-住址
----idNumber	String	人像面-身份证号码
----issuingAuthority	String	国徽面-签发机关
----issueDate	String	国徽面-签发日期
----expiryDate	String	国徽面-失效日期

|--withholding_money | int | 该接口扣费金额（点券） |

返回数据

{
  "code": 0,
  "mag": "",
  "msec": "",
  "time": 1656564848,
  "data": {
  "imageStatus": "normal",
  "riskType": "normal",
  "editTool": "Google",
  "result": [
    {
      "name": "冯花",
      "sex": "女",
      "birthDate": "19791019",
      "nationality": "汉",
      "address": "海南省东方市广坝农场胶",
      "idNumber": "460032197910193621"
    }
  ]
}
}

响应代码

代码	代码描述	解决方案
0	成功
100	请求参数错误	检查您的请求参数是否正确
101	请求超时，请重试	检查您的网络情况或者联系客服解决
200	系统错误，请联系客服	检查您的接口地址填写是否正确，其他问题联系客服解决
203	暂不支持当前接口
204	请求异常：无该接口权限，请前往官网开通正式接口。	前往官网开通该接口权限

身份证识别

请求头参数

请使用新的生成 token 接口 点击查看详情

请求参数

请求示例

请求代码示例

响应参数

返回数据

响应代码

请使用新的生成 token 接口点击查看详情