1. Personal Documents
(1) Passport Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:13 |
{
message: {
status: 13,
value: "Recognition Completed"
},
cardsinfo: [{
type: "13",
items: [{
nID: null,
index: null,
desc: "Passport Type",
content: "***"
},{
nID: null,
index: null,
desc: "Passport Number MRZ",
content: "***"
},{
nID: null,
index: null,
desc: "English Name",
content: "***"
},{
nID: null,
index: null,
desc: "Gender",
content: "***"
},{
nID: null,
index: null,
desc: "Date of Birth",
content: "***"
},{
nID: null,
index: null,
desc: "Expiration Date",
content: "***"
},{
nID: null,
index: null,
desc: "Issuing Country Code",
content: "***"
},{
nID: null,
index: null,
desc: "English Surname",
content: "***"
},{
nID: null,
index: null,
desc: "English Given Name",
content: "***"
},{
nID: null,
index: null,
desc: "MRZ1",
content: "***"
},{
nID: null,
index: null,
desc: "MRZ2",
content: "***"
},{
nID: null,
index: null,
desc: "Portrait",
content: "***"
},{
nID: null,
index: null,
desc: "Processed Image",
content: "***"
}]
}]
}
(2) Travel Document Recognition(TD-1)
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:12009 |
{
message: {
status: 2064,
value: "Recognition Completed"
},
cardsinfo: [{
type: "2064",
items: [{
nID: null,
index: null,
desc: "Document type",
content: "***"
},{
nID: null,
index: null,
desc: "Document Number",
content: "***"
},{
nID: null,
index: null,
desc: "Issuing Country Code",
content: "***"
},{
nID: null,
index: null,
desc: "English Given Name",
content: "***"
},{
nID: null,
index: null,
desc: "Gender",
content: "***"
},{
nID: null,
index: null,
desc: "Date of Birth",
content: "***"
},{
nID: null,
index: null,
desc: "Date of Expiry",
content: "***"
},{
nID: null,
index: null,
desc: "English Surname",
content: "***"
},{
nID: null,
index: null,
desc: "English Given Name",
content: "***"
},{
nID: null,
index: null,
desc: "MRZ1",
content: "***"
},{
nID: null,
index: null,
desc: "MRZ2",
content: "***"
},{
nID: null,
index: null,
desc: "MRZ3",
content: "***"
},{
nID: null,
index: null,
desc: "Country Code",
content: "***"
},{
nID: null,
index: null,
desc: "ID Number",
content: "***"
}]
}]
}
(3) Bank Card Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:17 |
{
message: {
status: 0,
value: "Recognition Completed"
},
cardsinfo: [{
type: "17",
items: [{
nID: null,
index: null,
desc: "Card number",
content: "***"
},{
nID: null,
index: null,
desc: "Bank card type",
content: "***"
},{
nID: null,
index: null,
desc: "Bank card name",
content: "***"
},{
nID: null,
index: null,
desc: "Bank name",
content: "***"
},{
nID: null,
index: null,
desc: "Bank code",
content: "***"
},{
nID: null,
index: null,
desc: "Cardholder's name",
content: "*** "
}]
}]
}
(4) Identity Document Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
see the form below |
Serial Number |
Product Name |
Type MAINID |
1 |
Chinese ID Card-Front Page |
2 |
2 |
Chinese ID Card-Back Page |
3 |
3 |
Automatic Classification of Chinese ID Card |
101 |
4 |
Chinese Driver's License |
5 |
5 |
Chinese Electronic Driver's License-Front Page |
lg20 |
6 |
Chinese Electronic Driver's License-Back Page |
lg21 |
7 |
Chinese Vehicle License |
6 |
8 |
Chinese Visa |
12 |
9 |
Chinese Birth Certificate |
lg8 |
10 |
Chinese Driver's License-Back Page |
28 |
11 |
Chinese Vehicle License-Back Page |
30 |
12 |
Foreign Permanent Resident ID Card |
33 |
13 |
China Exit and Entry Permit-Portrait Page |
1003 |
14 |
China Exit and Entry Permit-Information Page |
1004 |
15 |
Automatic Classification of Chinese Driver's License |
102 |
16 |
Automatic Classification of Chinese Vehicle License |
103 |
17 |
Automatic Classification of Chinese Indentity Card, Vehicle License,Driver's License |
104 |
18 |
China Travel Permit for Hong Kong and Macao Residents-Portrait Page |
14 |
19 |
China Travel Permit for Hong Kong and Macao Residents-MRZ Page |
15 |
20 |
Exit-Entry Permit for Travelling to and from Hong Kong and Macau 2014 Version-Portrait Page |
22 |
21 |
China Travel Permit for Taiwan Residents 2015 Version-Portrait Page |
25 |
22 |
China Travel Permit for Taiwan Residents 2015 Version-MRZ Page |
26 |
23 |
Residence Permit for Hong Kong, Macao, and Taiwan Residents-Front Page |
31 |
24 |
Residence Permit for Hong Kong, Macao, and Taiwan Residents-Back Page |
32 |
25 |
Exit-Entry Permit for Taiwan 2017 Version-Portrait Page |
29 |
26 |
Algerian ID Card-Portrait Page |
2097 |
27 |
Egyptian ID Card-Portrait Page |
2081 |
28 |
Egyptian ID Card-Back Page |
2082 |
29 |
Hongkong Identity Card-Portrait Page |
1001 |
30 |
Hong Kong Arrival Card |
1015 |
31 |
Indonesian ID Card |
2010 |
32 |
Indonesian Driver's License |
2041 |
33 |
Japanese Driver's License |
2051 |
34 |
Jordanian ID Card-Portrait Page |
2065 |
35 |
Kuwaiti ID Card |
2094 |
36 |
Lebanese ID Card-Portrait Page |
2087 |
37 |
Macao Identity Card-Portrait Page |
1005 |
38 |
Macao Non-resident worker's identification Card |
1014 |
39 |
Malaysian ID Card |
2001 |
40 |
Malaysian Driver's License |
2021 |
41 |
Mexican Voter ID Card (ABC) |
2013 |
42 |
Mexican Voter ID Card (ABC)-Back Page |
2014 |
43 |
New Zealand Driver's License |
2003 |
44 |
Oman ID Card-Portrait Page |
2095 |
45 |
Oman Residency Permit-Portrait Page |
2096 |
46 |
Pakistan ID Card |
2098 |
47 |
Philippine ID Card |
2022 |
48 |
Saudi Arabian Residency Permit |
2086 |
49 |
Saudi Arabian ID Card-Portrait Page |
2110 |
50 |
2004版Singaporean ID Card 2004 Version |
2004 |
51 |
Singaporean Driver's License |
2031 |
52 |
Swedish Driver's License |
2020 |
53 |
Taiwan Identity Card-Front Page |
1031 |
54 |
Taiwan Identity Card-Back Page |
1032 |
55 |
Thai ID Card-Back Page (Not Supported on Windows 32-bit) |
2016 |
56 |
Thai ID Card |
2011 |
57 |
Thai Driver's License(Auto) |
2012 |
58 |
Emirates ID Card-Portrait Page |
2063 |
59 |
Emirates ID Card-MRZ Page |
2064 |
60 |
Djiboutian ID Card-Portrait Page |
2093 |
61 |
EU Driver's License |
- |
62 |
Kenyan ID Card |
- |
Example of results:
- ARE Emirates ID Card-Portrait Page
- ARE Emirates ID Card-MSRZ Page
- CHN ID Card-Front Page
- CHN ID Card-Back Page
- CHN Automatic Classification of ID Card
- CHN Driver's License
- CHN Driver's License-Back Page
- CHN Automatic Classification of Driver's License
- CHN Electronic Driver's License-Front Page
- CHN Electronic Driver's License Back Page
- CHN Vehicle License
- CHN Vehicle License-Back Page
- CHN Automatic Classification of Vehicle License
- CHN Automatic Classification of Chinese Indentity Card, Vehicle License,Driver's License
- CHN Visa
- CHN Birth Certificate
- CHN Foreign Permanent Resident ID Card
- CHN China Exit and Entry Permit-Portrait Page
- CHN China Exit and Entry Permit-Information Page
- DJI Djiboutian ID Card-Portrait Page
- EGY Egyptian ID Card-Portrait Page
- EGY Egyptian ID Card-Back Page
- EU Driver's License
- HKG Hongkong Identity Card-Portrait Page
- HKG Hong Kong Arrival Card
- HKG China Travel Permit for Hong Kong and Macao Residents-Portrait Page
- China Travel Permit for Hong Kong and Macao Residents-MRZ Page
- Exit-Entry Permit for Travelling to and from Hong Kong and Macau 2014 Version-Portrait Page
- Residence Permit for Hong Kong, Macao, and Taiwan Residents-Front Page
- Residence Permit for Hong Kong, Macao, and Taiwan Residents-Back Page
- IDN Indonesian ID Card
- IDN Indonesian Driver's License
- JOR Jordanian ID Card-Portrait Page
- JPN Japanese Driver's License
- KEN Kenyan ID Card
- KWT Kuwaiti ID Card
- LBN Lebanese ID Card-Portrait Page
- MAC Macao Identity Card-Portrait Page
- MAC Macao Non-resident worker's identification Card
- MAC China Travel Permit for Hong Kong and Macao Residents-Portrait Page
- MAC China Travel Permit for Hong Kong and Macao Residents-MRZ Page
- MAC Exit-Entry Permit for Travelling to and from Hong Kong and Macau 2014 Version-Portrait Page
- MAC Residence Permit for Hong Kong, Macao, and Taiwan Residents-Front Page
- MAC Residence Permit for Hong Kong, Macao, and Taiwan Residents-Back Page
- MEX Mexican Voter ID Card (ABC)
- MEX Mexican Voter ID Card (ABC)-Back Page
- MYS Malaysian ID Card
- MYS Malaysian Driver's License
- NZL New Zealand Driver's License
- OMN Oman ID Card-Portrait Page
- PAK Pakistan ID Card
- PHL Philippine ID Card
- SAU Saudi Arabian Residency Permit
- SAU Saudi Arabian ID Card-Portrait Page
- SGP Singaporean ID Card 2004 Version
- SGP Singaporean Driver's License
- SWE Swedish Driver's License
- THA Thai ID Card
- THA Thai ID Card-Back Page (Not Supported on Windows 32-bit)
- THA Thai Driver's License(Auto)
- TWN Taiwan Identity Card-Front Page
- TWN Taiwan Identity Card-Back Page
- TWN China Travel Permit for Taiwan Residents 2015 Version-Portrait Page
- TWN China Travel Permit for Taiwan Residents 2015 Version-MRZ Page
- TWN Exit-Entry Permit for Taiwan 2017 Version-Portrait Page
- TWN Residence Permit for Hong Kong, Macao, and Taiwan Residents-Front Page
- TWN Residence Permit for Hong Kong, Macao, and Taiwan Residents-Back Page
2. Business Document
(1) Invoice Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:20090 |
7 |
cutImage |
Integer |
No |
Default to 0 does not return cropping image 1 returns |
Serial Number |
Invoice Type |
Description |
1 |
1 |
Value added tax special invoice |
2 |
3 |
Unified sales invoice for motor vehicles |
3 |
4 |
Value added tax ordinary invoice |
4 |
8 |
Value added tax electronic special invoice |
5 |
9 |
electronic invoices (value-added tax special invoices) |
6 |
10 |
Value added tax ordinary invoice (electronic) |
7 |
11 |
Value added tax ordinary invoice (roll format) |
8 |
14 |
Value added tax ordinary invoice (toll) |
9 |
15 |
Unified Sales Invoice for Used Cars |
10 |
20 |
train tickets |
11 |
21 |
Blockchain Invoices |
12 |
22 |
Shipping Tickets |
13 |
23 |
Fixed Invoice |
14 |
24 |
Universal Machine Printed Invoices |
15 |
25 |
Taxi Invoice |
16 |
26 |
Passenger Bus Tickets |
17 |
27 |
Electronic Air Transport Ticket itinerary |
18 |
28 |
toll fees |
19 |
31 |
Didi Travel itinerary |
20 |
33 |
Sales List |
21 |
34 |
Financial electronic bills |
22 |
35 |
Customs Special Payment Certificate |
23 |
36 |
General Electronic Invoice |
24 |
37 |
Tax Payment Certificate |
25 |
38 |
Medical Tickets |
26 |
39 |
train refund ticket |
27 |
61 |
Electronic Invoice (Air Transport Electronic Ticket itinerary) |
28 |
62 |
Electronic Invoice (Railway Electronic Ticket) |
29 |
83 |
Electronic Invoice (Regular Invoice) |
30 |
91 |
full electronic paper invoice (value-added tax special invoice) |
31 |
92 |
full electronic paper invoice (value-added tax ordinary invoice) |
32 |
40 |
General Payment Certificate for Non Tax Income (Electronic) |
33 |
41 |
Vehicle Toll General (Electronic) Invoice |
34 |
93 |
All Electric Paper Ticket (Unified Invoice for Motor Vehicle Sales) |
35 |
94 |
All Electric Paper Ticket (Unified Invoice for Used Car Sales) |
36 |
42 |
Bank Receipt |
37 |
99 |
Other bills |
3. License Plate Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:19 |
Example of results:
{
message: {
status: 0,
value: "Recognition completion"
},
cardsinfo: [{
type: "19",
items: [{
nID: null,
index: null,
desc: "License plate number",
content: "***"
},{
nID: null,
index: null,
desc: "License plate color",
content: "***"
},{
nID: null,
index: null,
desc: "License plate type",
content: "***"
},{
nID: null,
index: null,
desc: "Overall plate confidenc",
content: "***"
},{
nID: null,
index: null,
desc: "Brightness evaluation",
content: "***"
},{
nID: null,
index: null,
desc: "License plate motion direction",
content: "0"
},{
nID: null,
index: null,
desc: "License plate position (left_top_right_bottom)",
content: "***_***_***_***"
}]
}]
}
4. General Document Recognition
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
file |
MultipartFile |
Yes |
Uploaded file (The field name of the uploaded file must be "file") |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:1997 |
Example of results:
{
message: {
status: 0,
value: "Recognition completion"
},
cardsinfo: {
card: {
type: "1996",
rowitem: [{
rowdesc: "row0",
pagedesc: "1",
rowInfo: {
left_top_right_bottom: "46-7-731-8-731-24-46-24"
},
rowContext: {
charitem: [{
charInfo: {
left_top_right_bottom: "46-7-731-8-731-24-46-24"
},
chardesc: "char0",
charValue: "Zena Qiao is one of my friends. She is a beautiful, outgoingand good-tempered gir. She"
}]
}
},
......
]
}
}
}
5. Verification
(1) Face Comparison
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img1 |
String |
Yes |
Uploaded file (base64 stream of pictures) Supported image formats: BMP/JPG/TIF/PNG/WSQ/JP2 / states JPC/J2K/TFF The size is about 200KB |
2 |
img2 |
String |
Yes |
Uploaded file (base64 stream of pictures) Supported image formats: BMP/JPG/TIF/PNG/WSQ/JP2 / states JPC/J2K/TFF The size is about 200KB |
3 |
key |
String |
Yes |
User ocrKey |
4 |
token |
String |
Yes |
Authorization token |
5 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
6 |
typeId |
Integer |
Yes |
Recognition type:21 |
Example of results:
{
infoList: [{
veritem: [{
desc: "Decision result:yes",
name: null,
content: ""
},
{
desc: "Decision value:99",
name: null,
content: ""
}]
}],
messageString: {
status: "2000",
value: "success"
}
}
(2) Silent Liveness Detection
- Interface receiving parameter:
Serial |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
Yes |
Uploaded file (base64 stream of pictures) |
2 |
key |
String |
Yes |
User ocrKey |
3 |
token |
String |
Yes |
Authorization token |
4 |
timestamp |
String |
Yes |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
5 |
typeId |
Integer |
Yes |
Recognition type:3035 |
Example of results:
{
infoList: [{
veritem: [{
desc: "Living body",
name: null,
content: ""
},{
desc: "Decision value:99",
name: null,
content: ""
}]
}],
messageString: {
status: "2000",
value: "success"
}
}
(3) Video Liveness Detection
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
img |
String |
is |
Uploaded file (base64 stream of pictures) |
2 |
key |
String |
is |
User ocrKey |
3 |
token |
String |
is |
Authorization token |
4 |
timestamp |
String |
is |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
5 |
typeId |
Integer |
is |
Recognition type:3035 |
Example of results:
{
infoList: [{
veritem: [{
desc: "Decision value",
name: null,
content: "100.0"
},{
desc: "Live or not",
name: null,
content: "Non-living body"
},{
desc: "Whether there is a replacement",
name: null,
content: "no"
},{
desc: "Whether there is blinking",
name: null,
content: "no"
},{
desc: "Whether there is a mouth",
name: null,
content: "no"
}]
}],
messageString: {
status: "2000",
value: "success"
}
}
(4) Invoice Verification
- Interface receiving parameter:
Serial Number |
Name |
Type |
Required |
Instructions |
1 |
key |
String |
is |
User ocrKey |
2 |
token |
String |
is |
Authorization token |
3 |
timestamp |
String |
is |
Yes The number of seconds with timestamp January 1 1970 00:00:00 GMT until now |
4 |
typeId |
Integer |
is |
Recognition type:3007 |
5 |
invoiceCode |
String |
no |
Invoice code |
6 |
invoiceNumber |
String |
is |
Invoice number |
7 |
billingDate |
String |
is |
Invoicing date: YYYY-MM-DD (Required for non-blockchain invoices) |
8 |
totalAmount |
String |
is |
Total amount (excluding tax) |
9 |
checkCode |
String |
no |
The last 6 digits of the check code |
10 |
salesTaxNo |
String |
no |
Seller's tax ID (required for blockchain) |
11 |
orderNo |
String |
no |
Order number (required for general electronic invoice) |
Invoice Type |
Type |
Interface Receiving Parameter |
Special Invoice |
Value Added Tax Special Invoice |
1 |
invoiceCode,invoiceNumber, billingDate,totalAmount(excluding tax) |
Value Added Tax Electronic Special Invoice |
8 |
Unified Sales Invoice for Motor Vehicles |
3 |
Unified Sales Invoice for Used Cars |
15 |
Full Electronic Paper Invoice (Value-Added Tax Special Invoice) |
91 |
Ordinary Invoice |
Value Added Tax Ordinary Invoice |
4 |
invoiceCode,invoiceNumber,billingDate, checkCode(The last 6 digits) |
Value Added Tax Ordinary Invoice (Electronic) |
10 |
Value Added Tax Ordinary Invoice (Roll format) |
11 |
Value Added Tax Ordinary Invoice (Toll) |
14 |
Blockchain |
Blockchain Invoice |
21 |
invoiceCode,invoiceNumber, checkCode,salesTaxNo |
Full Electronic Invoice |
Electronic Invoice (Value-Added Tax Special Invoice) |
9 |
invoiceNumber, checkCode,totalAmount(Amount + tax) |
Electronic Invoice (Regular Invoice) |
83 |
Electronic Invoice (Electronic Passenger Itinerary Receipt for Air Transport) |
61 |
Electronic Invoice (Electronic Railway Ticket) |
62 |
Full Electronic Paper Ticket (Unified Invoice for Motor Vehicle Sales) |
93 |
invoiceCode,invoiceNumber, billingDate,totalAmount(excluding tax) |
Full Electronic Paper Ticket (Unified Invoice for Used Car Sales) |
94 |
Full Electronic Paper Invoice(Ordinary Invoice) |
Full Electronic Paper Invoice (Value-Added Tax Ordinary Invoice) |
92 |
invoiceCode,invoiceNumber,billingDate, checkCode(The last 6 digits of the full electronic invoice number ) |
Zhejiang General Electronic Invoice |
General Electronic Invoice |
36 |
invoiceCode,invoiceNumber,orderNo |
Financial electronic bills |
Financial electronic bills |
34 |
invoiceCode,invoiceNumber,billingDate, totalAmount(Amount tax),checkCode |
Medical Receipt |
38 |