证件照抠图

描述

本接口用于证件照抠图

接口鉴权

见:开放API对接文档

接口地址

【POST】https://open-api.gaoding.com/api/call/passport


请求头(request header)

字段

类型

是否必填

字段描述

app_id

string

应用ID,获取方式:应用列表 -> 应用详情 -> APP ID


请求体(request body)

字段

类型

是否必填

字段描述

url

string

二个必填一个

优先级:url>file_base64

原图url,支持JPG、PNG格式

仅保留1个月,请及时转储

(无文件大小限制)

file_base64

string

原图的base64码

(最大支持3M文件)

result_type

string

结果返回类型:

枚举值:url,base64

默认url

background

string

背景颜色 RGB , 当为 transparent 时背景透明

width

number

裁剪图片宽

height

number

裁剪图片高

file_type

string

获得图片类型 jpg , png,默认jpg

quality

number

最大值: 1 最小值: 0

gradient

number

1:背景色渐变,0:背景色不渐变,默认0

background_stop

string

gradient=1时必填

背景渐变结束颜色 RGB

portrait_check

number

是否进行人像检查,1:是,0:否,默认0。准确度不够高,建议制作证件照前先使用人像属性检测接口进行检测

is_skip_crop

number

是否跳过裁剪功能,1:跳过裁剪,0:进行裁剪(默认值)

请求体示例(url):

{
  "url":"https://matting-batch.dancf.com/cloths/20220825_143743_gaoding_imagematting_human.jpg",
  "width":295,
  "height":413,
  "background":"#ffcc66"
}

请求体示例(base64):

{
  "file_base64":"图片的base64编码",
  "width":1500,
  "height":1500,
  "background":"#ffcc66"
}


尺寸参考(仅供参考,width和height可自定义):

证件类型尺寸

尺寸(毫米)

尺寸(像素)

一寸

25x35

295x413

小一寸

22×32

260×378

大一寸

33×48

390×567

二寸

35x49

413×579

小二寸

35×45

413×531

大二寸

35x53

413x626

类型

尺寸(毫米)

尺寸(像素)

学籍照片

26×32

307×378

学信网

41×54

480×640

全国计算机等级考试

12×16

144×192

护士执业资格考试

14×18

160×210

教师资格证

30×41

360×480

泰国签证

40×60

472×708

日本签证

45×45

531×531

美国签证

51×51

600×600

越南签证

40×60

472×708

居民身份证制证用数字相片技术标准(GA461-2004)

26 x 32

358x441(DPI 350)

响应体(response body)

字段

类型

是否必存在

字段描述

result

string

结果图url,返回PNG格式,仅保留1个月,请及时转储

width

number

图片宽

height

number

图片高

响应示例1(模拟正常请求):

http_status:200

response body:

{
  "width": 1500,
  "height": 1500,
  "result": "https://gd-filems.dancf.com/gaoding/matting/passport/732084946fd944af656c0696379bb9a51661503022684.png"
}


响应示例2(模拟参数非法请求):

http_status:400

response body:

{
    "code": -10003,
    "message": "InvalidArgsError"
}



错误码

HTTP状态码

业务错误码

含义

400

-10003

参数非法

400

-10024

通过指定的upload_address 上传的的时候失败

400

-10001

下载失败,可能是用户传的url非法,或者网络异常等原因导致下载失败

400

-10002

解码图片失败,可能是某些格式比较特殊的图片暂时还不支持,或者图片url下载下来根本不是图像数据

400

-10007

图片数据过大,无法处理

422

-11001

未识别到人脸

422

-11002

人脸不完整

422

-11003

检测到多个人脸

422

-11004

佩戴眼镜,

portrait_check=1时有效

422

-11005

佩戴帽子,

portrait_check=1时有效

422

-11006

佩戴首饰,

portrait_check=1时有效

422

-11007

人脸左右倾斜,

portrait_check=1时有效

422

-11008

左右侧脸,

portrait_check=1时有效

422

-11009

上下抬脸,

portrait_check=1时有效

422

-11010

肩膀不齐平,

portrait_check=1时有效

422

-11011

照片模糊,

portrait_check=1时有效

422

-11012

阴阳脸,

portrait_check=1时有效

422

-11013

黑白照,

portrait_check=1时有效

500

服务器错误

422

接口入参错误