This document is primarily aimed at API developers and explains the various technical aspects of the interfaces provided by FlyOCR. If you have any questions or need clarification while reading this document, we offer multiple contact methods for consultation and feedback:
- Cellphone: +86 17310630901
- E-Mail: lijj@sinosecu.com.cn
- Online Consultant: +86 17310630901
1. Copyright Notice
Without authorization from the FlyOCR website, usage is not permitted.
2. Client Runtime Environment
When the client’s programming language is Java, please use JRE version 1.5 or above.
3. Main Functions of the Service
（1）Text Recognition Services API
- Upload various color image files of documents (passport, text, bank card, driver's license, receipts, license plates, etc.) via HTTPS POST method for recognition.
- Return the recognition results in XML or JSON format to the user.
（2）Verification Services API
- Upload specified parameters and images via HTTPS using the POST method, and verify through the HTTPS interface;
- Return the verification results to the user in JSON format.
（3）Interface Supported Service Types and Overview
| Product Name | Description |
|---|---|
| Bank Card Recognition | Recognition of card numbers, expiration dates, etc., from bank cards of various countries; supports JPG, BMP, TIF, PNG, and other formats. |
| Passport Recognition | Structured output of text information from the personal data page of passports. |
| TD-1 Machine Readable Travel Document | Structured output of personal data information from TD-1 type machine-readable travel documents. |
| Chinese ID Card-Front Page | Structured output of text information from the portrait page and the national emblem page of China's second-generation ID cards. |
| Chinese ID Card-Back Page | Automatic classification of the front and back of China's ID cards, with structured text output. |
| Automatic Classification of Chinese ID Card | Structured output of text information from China's driver's licenses. |
| Chinese Driver's License | Structured output of text information from the original and duplicate copies of China's electronic driver's licenses. |
| Electronic Driver's License-Front Page | Structured output of text information from the main page of China's vehicle registration certificates. |
| Chinese Electronic Driver's License-Back Page | Structured output of text information from China's visas. |
| Chinese Vehicle License | Structured output of text information from China's birth certificates. |
| Chinese Visa | Structured output of text information from the main page of China's driver's licenses. |
| Chinese Birth Certificate | Structured output of text information from China's birth medical certificates. |
| Chinese Driver's License-Back Page | Structured output of text information from the main page of China's driver's licenses. |
| Chinese Vehicle License-Back Page | Structured output of text information from the back page of China's driver's licenses. |
| Foreign Permanent Resident ID Card | Structured output of text information from China's permanent residence permits for foreigners. |
| China Exit and Entry Permit-Portrait Page | Structured output of text information from Border Resident Permits (A) (Photo Page). |
| China Exit and Entry Permit-Information Page | Structured output of text information from Border Resident Permits (B) (Personal Information Page). |
| Automatic Classification of Chinese Driver's License | Automatic classification and structured output of text information from the front and back pages of China's driver's licenses. |
| Automatic Classification of Chinese Vehicle License | Automatic classification and structured output of text information from the front and back pages of China's vehicle registration certificates. |
| Automatic Classification of Chinese Indentity Card, Vehicle License,Driver's License | Automatic classification and structured output of text information from the front and back pages of China's ID cards, vehicle registration certificates, and driver's licenses. |
| China Travel Permit for Hong Kong and Macao Residents-Portrait Page | Structured output of text information from the photo page of the China Travel Permit for Hong Kong and Macao Residents. |
| China Travel Permit for Hong Kong and Macao Residents-MRZ Page | Structured output of text information from the machine-readable code page of the China Travel Permit for Hong Kong and Macao Residents. |
| Exit-Entry Permit for Travelling to and from Hong Kong and Macau 2014 Version-Portrait Page | Structured output of text information from the photo page of the 2014 version of the China Travel Permit for Hong Kong and Macao Residents. |
| China Travel Permit for Taiwan Residents 2015 Version-Portrait Page | Structured output of text information from the photo page of the 2015 version of the China Travel Permit for Taiwan Residents. |
| China Travel Permit for Taiwan Residents 2015 Version-MRZ Page | Structured output of text information from the machine-readable code page of the 2015 version of the China Travel Permit for Taiwan Residents. |
| Residence Permit for Hong Kong, Macao, and Taiwan Residents-Front Page | Structured output of text information from the front side of the Residence Permit for Residents of Hong Kong, Macao, and Taiwan. |
| Residence Permit for Hong Kong, Macao, and Taiwan Residents-Back Page | Structured output of text information from the back side of the Residence Permit for Residents of Hong Kong, Macao, and Taiwan. |
| Exit-Entry Permit for Taiwan 2017 Version-Portrait Page | Structured output of text information from the photo page of the 2017 version of the Taiwan Travel Permit. |
| Algerian ID Card-Portrait Page | Structured output of text information from the photo page of Algerian ID cards. |
| Egyptian ID Card-Portrait Page | Structured output of text information from the photo page of Egyptian ID cards. |
| Egyptian ID Card-Back Page | Structured output of text information from the back side of Egyptian ID cards. |
| Hongkong Identity Card-Portrait Page | Structured output of text information from the photo page of Hong Kong Resident ID cards. |
| Hong Kong Arrival Card | Structured output of text information from entry receipts for Hong Kong. |
| Indonesian ID Card | Structured output of text information from Indonesian resident ID cards. |
| Indonesian Driver's License | Structured output of text information from Indonesian driver's licenses. |
| Japanese Driver's License | Structured output of text information from Japanese driver's licenses. |
| Jordanian ID Card-Portrait Page | Structured output of text information from the photo page of Jordanian ID cards. |
| Kuwaiti ID Card | Structured output of text information from Kuwaiti ID cards. |
| Lebanese ID Card-Portrait Page | Structured output of text information from the photo page of Lebanese ID cards. |
| Macao Identity Card-Portrait Page | Structured output of text information from Macau Resident ID cards. |
| Macao Non-resident worker's identification Card | Structured output of text information from Macau Blue Cards. |
| Malaysian ID Card | Structured output of text information from Malaysian ID cards. |
| Malaysian Driver's License | Structured output of text information from Malaysian driver's licenses. |
| Mexican Voter ID Card （ABC） | Structured output of text information from Mexican voter ID cards (ABC). |
| Mexican Voter ID Card （ABC）-Back Page | Structured output of text information from the back side of Mexican voter ID cards (ABC). |
| New Zealand Driver's License | Structured output of text information from New Zealand driver's licenses. |
| Oman ID Card-Portrait Page | Structured output of text information from the photo page of Omani ID cards. |
| Oman Residency Permit-Portrait Page | Structured output of text information from the photo page of Omani residence permits. |
| Pakistan ID Card | Structured output of text information from Pakistani ID cards. |
| Philippine ID Card | Structured output of text information from Philippine ID cards. |
| Saudi Arabian Residency Permit | Structured output of text information from Saudi residence permits. |
| Saudi Arabian ID Card-Portrait Page | Structured output of text information from the photo page of Saudi ID cards. |
| Singaporean ID Card 2004 Version | Structured output of text information from Singaporean ID cards (2004 version). |
| Singaporean Driver's License | Structured output of text information from Singaporean driver's licenses. |
| Swedish Driver's License | Structured output of text information from Swedish driver's licenses. |
| Taiwan Identity Card-Front Page | Structured output of text information from the front side of Taiwanese ID cards. |
| Taiwan Identity Card-Back Page | Structured output of text information from the back side of Taiwanese ID cards. |
| Thai ID Card-Back Page (Not Supported on Windows 32-bit) | Structured output of text information from the back side of Thai ID cards (not supported on Windows 32-bit systems). |
| Thai ID Card | Structured output of text information from Thai national ID cards. |
| Thai Driver's License(Auto) | Structured output of text information from Thai driver's licenses (automatic). |
| Emirates ID Card-Portrait Page | Structured output of text information from the photo page of UAE ID cards. |
| Emirates ID Card-MRZ Page | Structured output of text information from the machine-readable code page of UAE ID cards. |
| Djiboutian ID Card-Portrait Page | Structured output of text information from the photo page of Djiboutian ID cards. |
| All types of China invoices | Automatic classification and structured output of text information from all types of invoices in China. |
| China | Structured output of color, license plate number, etc., information from Chinese license plates. |
| Hongkong | Structured output of color, license plate number, etc., information from Hong Kong license plates. |
| Macau | Structured output of color, license plate number, etc., information from Macau license plates. |
| Thailand | Structured output of color, license plate number, etc., information from Thai license plates. |
| General documents (Simplified Chinese printed) | Automatically recognize printed Simplified Chinese text information from images and return the recognition results line by line. |
| General documents (Simplified Chinese handwritten) | Automatically recognize handwritten Simplified Chinese text information from images and return the recognition results line by line. |
| General documents (Traditional Chinese printed) | Automatically recognize printed Traditional Chinese text information from images and return the recognition results line by line. |
| General documents (English) | Automatically recognize English text information from images and return the recognition results line by line. |
| General documents (Arabic) | Automatically recognize handwritten Traditional Chinese text information from images and return the recognition results line by line. |
| General documents (Traditional Chinese handwritten) | Automatically recognize Arabic text information from images and return the recognition results line by line. |
| Face comparison | Compare the similarity of faces between two images and output the similarity value. |
| Image liveness detection | Identify whether uploaded images are obtained from real human photographs and output judgment values. |
| Video liveness detection | Determine whether the individuals in uploaded videos are captured from real living subjects and output judgment values. |
| China invoice verification | Verify the authenticity of China-issued invoices based on invoice element information, and if genuine, return the full invoice details. |
4. Service Call Constraints
Before calling the text recognition and verification interfaces, ensure that the client program or device is connected to the network.
（1）HTTP/HTTPS Selection
To ensure the security and stability of data during transmission, we recommend using HTTPS protocol for interface calls.
（2）Image Requirements for Recognition
- The text in the image must be clear and readable.
- Contrast and brightness should be moderate.
- Avoid backgrounds; if unavoidable, use a pure black background, ensuring the document fills the image as much as possible.
（3）Requirements for Scanned Images
Choose a resolution of 300 dpi during scanning, with a minimum of 150 dpi. Avoid excessively high resolutions.
（4）Requirements for Captured Images/Videos
Pay attention to lighting to avoid glare and shadows, especially when documents are covered with a film.
Ensure proper focus to avoid blurry images.
Keep the document, text, or face straight during shooting.
Avoid excessive tilt to prevent image distortion.
Do not use overly high resolution, which can make the image too large and hinder transmission. For shooting, you can choose a resolution of 1280*960. Ensure the text in the image is clear.