一、3201-小文件批量上传
1. 接口功能
批量上传小文件，单个文件大小不超过2M，文件数量不超过5个。图片支持 jpg 、png格式（不支持手动修改图片后缀） 。文件存储ID（FileID）对应需调用3201的其他接口中的上传照片ID（UploadFileID）。
2. 报文结构
请求报文：
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 | |
| TxCode | R | NOT NULL | N1..4 | 交易类型 | |
| InstitutionID | R | NOT NULL | ANS1..8 | 机构编号 | |
| TxSN | R | NOT NULL | ANS1..32 | 交易流水号 | |
| Files | FileName | R | NOT NULL | ANS1..256 | 文件名称 例如： img_best.jpg |
| FileContent | R | NOT NULL | ANS1.. | 文件内容 Base64 | |
| Remark | O | ANS0..256 | 备注 | ||
响应报文：
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 | |
| Code | R | NOT NULL | N1..6 | 响应代码 | |
| Message | R | NOT NULL | ANS1..256 | 响应消息 | |
| TxCode | C | ANS1..4 | 交易类型 | ||
| InstitutionID | C | ANS1..8 | 机构号 | ||
| TxSN | C | ANS1..32 | 交易流水号 | ||
| TraceNo | C | ANS1..32 | 系统跟踪号 | ||
| Files | FileName | C | ANS1..256 | 文件名称 | |
| FileID | C | ANS1..32 | 文件存储ID | ||
二、4013-外国人永久居留身份证ocr
1. 接口功能
解析身份证照片信息。需要将图片先通过3201接口上传到服务器，然后再发送4013验证请求。上传照片ID（UploadFileID）对应3201接口响应的FileID。（接口时序图：ocr接口介绍）
2. 报文结构
请求报文：
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 |
| TxCode | R | NOT NULL | N1..4 | 交易类型 |
| InstitutionID | R | NOT NULL | ANS1..8 | 机构编号 |
| TxSN | R | NOT NULL | ANS1..32 | 交易流水号 |
| R | NOT NULL | ANS1..32 | 上传照片ID | |
| Side | R | NOT NULL | N1 | 身份证面： 0-反面[人像面] 1-正面[国徽面] |
| C | NOT NULL | N1 | 是否返头像照片[身份证反面时可选] 0-不返 1-返 |
|
| Remark | O | ANS0..256 | 备注 |
响应报文：
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 | |
| Code | R | NOT NULL | N1..6 | 响应代码 | |
| Message | R | NOT NULL | ANS1..256 | 响应消息 | |
| TxCode | C | NOT NULL | ANS1..4 | 交易类型 | |
| InstitutionID | C | NOT NULL | ANS1..8 | 机构编号 | |
| TxSN | C | NOT NULL | ANS1..32 | 交易流水号 | |
| TraceNo | C | NOT NULL | ANS1..32 | 交易跟踪号 | |
| ResponseCode | C | NOT NULL | N0..4 | 通道响应代码 | |
| ResponseMessage | C | NOT NULL | ANS0..256 | 通道响应消息 | |
| Name | C | NOT NULL | ANS0..100 | 姓名 | 身份证反面返回 |
| ChineseName | C | NOT NULL | ANS0..100 | 中文姓名 | |
| Birthday | C | NOT NULL | ANS0..32 | 出生日期，格式:"2012年10月21日" | |
| Gender | C | NOT NULL | ANS0..64 | 性别:"男"|"女" | |
| ValidPeriod | C | NOT NULL | ANS0..32 | 证件有效期，格式:"2014.04.16-2024.04.16" | |
| IssueAuthority | C | NOT NULL | ANS0..300 | 签发机关 | |
| PreviousNumber | C | NOT NULL | ANS0..80 | 曾持有号码 | |
| CertificateNumber | C | NOT NULL | ANS0..80 | 证件号码 | |
| Nationality | C | NOT NULL | ANS0..100 | 国籍 | |
| Image | C | NOT NULL | ANS0.. | Base64编码的身份证头像照片[返照时返回] | |
| IssueAuthority | C | NOT NULL | ANS0..300 | 签发机关 | 身份证正面返回 |
三、报文样例
[!TIP] （测试数据不校验数据真实性，默认为验证结果为匹配，若验证其他结果，可查看“总体规范-6.1.2.4 Remark 备注”）
3201-文件上传接口请求地址与ocr接口不同，需注意接口地址，具体可查看ocr交易地址
1.3201报文样例
请求报文(InstitutionID由中金分配)：
{
"TxCode":"3201",
"InstitutionID":"XXXXXX",
"TxSN":"202402291442120698276252672",
"Files":[
{
"FileContent":"iVBORw0KGg......5ErkJggg==",
"FileName":"XXX.png"
}
],
"Remark":""
}
响应报文：
{
"TxCode":"3201",
"Message":"SUCCESS",
"InstitutionID":"XXXXXX",
"TxSN":"202402291442120698276252672",
"Files":[
{
"FileName":"XXX.png",
"FileID":"2402291448065547976607147"
}
],
"Code":"2000",
"TraceNo":"2402291448065161312017836"
}
2.4013报文样例
请求报文(InstitutionID由中金分配)：
{
"Side":"0",
"ReturnImage":"0",
"TxCode":"4013",
"InstitutionID":"XXXXXX",
"TxSN":"202403011015059652442247566",
"UploadFileID":"2402291448065547976607147",
"Remark":""
}
响应报文：
{
"ResponseCode":"1000",
"TxCode":"4013",
"Message":"SUCCESS",
"ValidPeriod":"2015.10.25-2025.10.24",
"InstitutionID":"XXXXXX",
"IssueAuthority":"中华人民共和国国家移民管理局",
"PreviousNumber":"CAN000000000000",
"Birthday":"1981年08月03日",
"Gender":"女",
"ResponseMessage":"查询成功",
"Code":"2000",
"Nationality":"加拿大",
"Name":"XIAOHE,HE",
"ChineseName":"合小合",
"TxSN":"202403011015059652442247566",
"CertificateNumber":"CAN110081080319",
"TraceNo":"2403011030042011112016759"
}
该文档未解决您的疑问？
查看常见问题