RecognizeAllText-阿里云帮助中心

The OCR Unified Recognition API recognizes multiple image types, such as general text, ID cards, and invoices. Specify the image type using the Type parameter. You do not need to switch APIs.

Operation description

How to use this API

Step	Overview
1	Activate OCR Unified Recognition. After activation, you receive a free quota for testing.
2	Purchase an OCR Shared Resource Plan. If you do not purchase a resource plan, the system charges you on a pay-as-you-go basis based on your actual usage.
3	Use the code examples in the API Explorer to integrate the API. After integration, call the API to get recognition results. If you use a RAM user, the Alibaba Cloud account (root account) must grant permissions to the RAM user. For instructions on creating a RAM user, see Create a RAM user. The OCR service provides a system authorization policy named AliyunOCRFullAccess. For instructions on granting permissions, see Grant permissions to a RAM user

Important notes

Type	Overview
Image format	This API supports PNG, JPG, JPEG, BMP, GIF, TIFF, WebP, and PDF.
Image dimensions	The image height and width must be greater than 15 pixels and less than 8192 pixels. The aspect ratio must be less than 50. For better recognition results, use images with both dimensions greater than 500 pixels.
Image size	The binary file size must not exceed 10 MB. Large images slow down the API response. Use images smaller than 1.5 MB and pass the image URL instead of the binary data.
Other notes	Ensure the entire image and its edges are fully visible within the frame. This feature automatically handles glare and distortion, but accuracy may decrease. Use high-definition images without glare or distortion.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ocr:RecognizeAllText

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Url	string	No	Specify either Url or body. Do not specify both or leave both empty. The image URL. Maximum length is 2048 bytes. Base64 encoding is not supported.	https://example.png
body	string	No	Specify either Url or body. Do not specify both or leave both empty. The binary image file. Maximum size is 10 MB. When calling via HTTP, upload the binary file in the HTTP request body. When calling via SDK, place the image in the SDK body.	图片二进制文件
Type	string	Yes	The image type. This is a required and single-select parameter. Supported image types are listed in Additional information about request parameters. Note: For ID card or invoice images, if the actual image type does not match the specified Type, recognition fails.	Advanced
OutputFigure	boolean	No	Enable pattern detection. If enabled, the response includes the FigureInfo field (see Response parameters). true: enable; false: disable. Default value: varies by Type. See Additional information about request parameters. Supported patterns: blicense_title: business license title national_emblem: national emblem face: face finger_print: fingerprint signature: signature area Note: Enabling this increases response time. Enable only when needed.	false
OutputQrcode	boolean	No	Enable QR code detection. If enabled, the response includes the QrCodeInfo field (see Response parameters). true: enable; false: disable. Default value: false. Note: Enabling this increases response time. Enable only when needed.	false
OutputBarCode	boolean	No	Enable barcode detection. If enabled, the response includes the BarCodeInfo field (see Response parameters). true: enable; false: disable. Default value: false. Note: Enabling this increases response time. Enable only when needed.	false
OutputStamp	boolean	No	Enable seal detection. If enabled, the response includes the StampInfo field (see Response parameters). true: enable; false: disable. Default value: false. Note: Enabling this increases response time. Enable only when needed.	false
OutputCoordinate	string	No	The coordinate format: points or rectangle. points: four-point coordinates; rectangle: rotated rectangle. By default, no coordinates are returned.	""
OutputOricoord	boolean	No	Return original image coordinates. The system processes the image (for example, auto-rotation or correction). Set this to return coordinates relative to the original image or the processed image. true: enable; false: disable. Default value: varies by Type. See Additional information about request parameters. Note: This setting only applies when OutputCoordinate is not empty.	false
OutputKVExcel	boolean	No	Convert structured information into an Excel file link. Disabled by default. true: enable; false: disable. The link expires after one hour. Note: Enabling this increases response time. Enable only when needed.	false
PageNo	integer	No	Set this parameter for mixed invoices, VAT invoices, fixed-amount invoices, air itineraries, train tickets, roll tickets, or common printed invoices (that is, when Type=MixedInvoice/Invoice/QuotaInvoice/AirItinerary/TrainTicket/RollTicket/CommonPrintedInvoice). Specify the page number for PDF or OFD files. For example, PageNo=6 processes page six. If omitted or set to a value larger than the total pages, the first page is processed. Default: first page.	1
AdvancedConfig	object	No	Set optional features for advanced general text recognition (Type=Advanced).
OutputRow	boolean	No	Enable line-by-line output. If enabled, the response includes the RowInfo field (see Response parameters). true: enable; false: disable. Default value: false.	false
OutputParagraph	boolean	No	Enable paragraph segmentation. If enabled, the response includes the ParagraphInfo field (see Response parameters). true: enable; false: disable. Default value: false.	false
OutputTable	boolean	No	Output table recognition results, including cell information. If enabled, the response includes the TableInfo field (see Response parameters). true: enable; false: disable. Default value: false. Note: Enabling this increases response time. Enable only when needed.	false
OutputCharInfo	boolean	No	Output character-level recognition results. If enabled, the BlockInfo field includes the CharInfos field (see Response parameters). true: enable; false: disable. Default value: false.	false
IsLineLessTable	boolean	No	Indicates whether the table has no lines or only horizontal lines (no vertical lines). true: lineless table; false: lined table. Default value: false. Note: This setting only applies when OutputTable=true.	false
IsHandWritingTable	boolean	No	Indicates whether the table contains handwritten content. true: handwritten table; false: not handwritten. Default value: false. Note: This setting only applies when OutputTable=true.	false
OutputTableExcel	boolean	No	Export table recognition results as an Excel file and return the file link. true: enable; false: disable. Default value: false. The link expires after one hour. Note: Enabling this increases response time. Enable only when needed.	false
OutputTableHtml	boolean	No	Export table recognition results as an HTML file and return the file link. true: enable; false: disable. Default value: false. The link expires after one hour. Note: Enabling this increases response time. Enable only when needed.	false
IdCardConfig	object	No	Set optional features for ID card images (Type=IdCard).
OutputIdCardQuality	boolean	No	Enable ID card quality detection. Detection includes whether the image is a photo of a document, a photocopy, completeness score, and overall quality score. true: enable; false: disable. Default value: false. Note: Enabling this increases response time. Enable only when needed.	false
Llm_rec	boolean	No
InternationalIdCardConfig	object	No	Set optional features for international ID card images (Type=InternationalIdCard).
Country	string	No	The country name. Supported countries: India, Vietnam, Korea, Bangladesh. By default, the algorithm detects the country automatically. Note: Specifying the country name reduces response time.	India
InternationalBusinessLicenseConfig	object	No	Set optional features for international business license images (Type=InternationalBusinessLicense).
Country	string	No	The country name. Supported countries: India, Korea. By default, the algorithm detects the country automatically. Note: Specifying the country name reduces response time. Valid values: India : India Korea : Korea	India
MultiLanConfig	object	No	Set optional features for multilingual text images (Type=MultiLang).
Languages	string	No	The list of supported languages. chn: Chinese, eng: English, ja: Japanese, lading: Latin, kor: Korean, sx: handwriting, tai: Thai, rus: Russian, mys: Malay, idn: Indonesian, viet: Vietnamese, ukr: Ukrainian. Note: Separate multiple languages with commas. For example: Languages="eng,chn,lading". If you know the language, specify only one for better accuracy.	eng,chn
TableConfig	object	No	Set optional features for table images (Type=Table).
IsHandWritingTable	boolean	No	Indicates whether the table contains handwritten content. true: handwritten table; false: not handwritten. Default value: false.	false
IsLineLessTable	boolean	No	Indicates whether the table has no lines or only horizontal lines (no vertical lines). true: lineless table; false: lined table. Default value: false.	false
OutputTableExcel	boolean	No	Export table recognition results as an Excel file and return the file link. true: enable; false: disable. Default value: false. The link expires after one hour. Note: Enabling this increases response time. Enable only when needed.	false
OutputTableHtml	boolean	No	Export table recognition results as an HTML file and return the file link. true: enable; false: disable. Default value: false. The link expires after one hour. Note: Enabling this increases response time. Enable only when needed.	false

Request parameters have three levels. Level-one parameters are required basic parameters, such as the image URL and image type. Level-two parameters control output content, such as returning coordinates. Level-three parameters apply to specific image types and control output of specific information, such as ID card quality scores. Only Type is required. Other parameters are optional.

Additional information about request parameters for each image type (Type)

Type	Description	Supported parameters
Advanced	Advanced general text recognition	OutputFigure (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) AdvancedConfig (dedicated to advanced general text recognition, default: empty)
General	Basic general text recognition	OutputStamp (default: false)
Commerce	E-commerce image text	OutputStamp (default: false)
HandWriting	Handwritten text	OutputFigure (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
MultiLang	Multilingual text	OutputFigure (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) MultiLanConfig (dedicated to multilingual text, default: empty)
Table	Table	OutputFigure (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) TableConfig (dedicated to tables, default: empty)
IdCard	ID card	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: true) IdCardConfig (dedicated to ID cards, default: empty)
BankCard	Bank card	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
InternationalPassport	International passport	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: true)
ChinesePassport	Chinese passport	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
SocialSecurityCard	Social security card	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
PermitToHK_MO_TW	Hong Kong, Macao, and Taiwan travel permit	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
PermitToMainland	Mainland China travel permit	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
HouseholdHead	Household registration book cover	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
HouseholdResident	Household registration book resident page	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
EstateCertification	Real estate ownership certificate	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
BirthCertification	Birth certificate	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false)
HKIdCard	Hong Kong ID card	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: true)
InternationalIdCard	International ID card	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) InternationalIdCardConfig (dedicated to international ID cards, default: empty)
Stamp	Official seal	OutputCoordinate (default: empty) OutputOricoord (default: false)
MixedInvoice	Mixed invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
Invoice	VAT invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
CarInvoice	Motor vehicle sales unified invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
QuotaInvoice	Fixed-amount invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
AirItinerary	Air itinerary	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
TrainTicket	Train ticket	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
TollInvoice	Toll road invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
RollTicket	VAT invoice roll ticket	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
BankAcceptance	Bank acceptance bill	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
BusShipTicket	Passenger bus or ship ticket	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
NonTaxInvoice	Non-tax revenue invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
CommonPrintedInvoice	Common printed invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) PageNo (default: 1) OutputKVExcel (default: false)
HotelConsume	Hotel transaction record	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
PaymentRecord	Payment details page	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
PurchaseRecord	E-commerce order page	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
RideHailingItinerary	Ride-hailing itinerary	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
ShoppingReceipt	Shopping receipt	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
TaxClearanceCertificate	Tax clearance certificate	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
UsedCarInvoice	Used car sales unified invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
VehicleLicense	Vehicle license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
DrivingLicense	Driver's license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
VehicleRegistration	Motor vehicle registration certificate	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
VehicleCertification	Vehicle qualification certificate	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
LicensePlateNumber	License plate number	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
CarVinCode	Vehicle VIN code	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
BusinessLicense	Business license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
InternationalBusinessLicense	International business license	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false) OutputKVExcel (default: false) InternationalBusinessLicenseConfig (dedicated to international business licenses, default: empty)
MedicalDeviceManageLicense	Medical device operating license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
MedicalDeviceProduceLicense	Medical device production license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
CosmeticProduceLicense	Cosmetic production license	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
QrCode	QR code
BarCode	Barcode
TaxiInvoice	Taxi invoice	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
TrademarkCertificate	Trademark registration certificate	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
FoodProduceLicense	Food production license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
FoodManagementLicense	Food operation license	OutputFigure (default: false) OutputQrCode (default: true) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
ClassIIMedicalDeviceManageLicense	Class II medical device operating filing certificate	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
WayBill	Electronic waybill	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)
BankAccountPermit	Bank account permit	OutputFigure (default: false) OutputQrCode (default: false) OutputBarCode (default: false) OutputStamp (default: false) OutputCoordinate (default: empty) OutputOricoord (default: false) OutputKVExcel (default: false)

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The unique request ID.	E2A98925-DC2C-18FB-995F-BAF507XXXXXX
Data	object	The recognition result.
Height	integer	The original image height.	2000
Width	integer	The original image width.	1000
Content	string	All text in the image.	"合同编号..."
SubImageCount	integer	The number of sub-images in the image.	2
SubImages	array<object>	Information about sub-images in the image.
	array<object>
SubImageId	integer	The sub-image ID (starts from 0).	0
Type	string	The sub-image type (for example, ID card front or VAT invoice).	身份证正面
Angle	integer	The clockwise rotation angle of the sub-image (range: 0–359 degrees).	0
SubImagePoints	array<object>	The four-point coordinates of the sub-image (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
SubImageRect	object	The rotated rectangle coordinates of the sub-image (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The sub-image width.	1000
Height	integer	The sub-image height.	2000
KvInfo	object	Structured information for the sub-image. This field returns structured information for ID cards, invoices, and other similar documents. For example, for an ID card, this field includes fields like Name and Gender.
KvCount	integer	The number of key-value pairs in the structured information.	6
Data	any	The text content of the structured information. This is a dictionary where the key is the field name and the value is the recognized result. The structured fields vary by Type. See Additional information about response fields for all Type values.	{ "address": "XX省XX市XX街道XX号", "ethnicity": "汉", "sex": "男", "name": "王XX", "idNumber": "XXX", "birthDate": "2000年1月1日" }
KvDetails	object	Detailed structured information. This is a dictionary where the Key is the field name and the Value is the recognized result (including the field value, coordinates, and confidence level).
	object	Description of the structured information detail Value.
KeyName	string	The field name.	"address"
KeyConfidence	integer	The confidence level of the field (range: 0–100).	100
Value	string	The text content of the field value (KeyName).	"XX省XX市XX街道"
ValueConfidence	integer	The confidence level of the field value (range: 0–100).	98
ValuePoints	array<object>	The four-point coordinates of the field value (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
ValueRect	object	The rotated rectangle coordinates of the field value (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	50
Height	integer	The rectangle height.	50
ValueAngle	integer	The clockwise rotation angle of the field value (range: 0–359).	0
BlockInfo	object	Text block information for the sub-image. This field is returned when Type is Advanced, General, MultiLang, Commerce, or HandWriting.
BlockCount	integer	The number of text blocks in the sub-image.	12
BlockDetails	array<object>	Detailed text block information for the sub-image.
	array<object>
BlockId	integer	The text block ID (starts from 0).	0
BlockAngle	integer	The clockwise rotation angle of the text block (range: 0–359).	0
BlockContent	string	The text content of the block.	“合同编号...”
BlockConfidence	integer	The confidence level of the text block (range: 0–100).	98
BlockPoints	array<object>	The four-point coordinates of the text block (returned when OutputCoordinate="points").
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
BlockRect	object	The rotated rectangle coordinates of the text block (returned when OutputCoordinate="rectangle").
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	50
Height	integer	The rectangle height.	10
CharInfos	array<object>	Character-level information (returned when AdvancedConfig.OutputCharInfo=true).
	array<object>
CharId	integer	The character ID (starts from 0).	0
CharContent	string	The character content.	“合”
CharConfidence	integer	The confidence level of the character (range: 0–100).	95
CharPoints	array<object>	The four-point coordinates of the character (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
CharRect	object	The rotated rectangle coordinates of the character (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	10
Height	integer	The rectangle height.	10
TableInfo	object	Table information (returned when AdvancedConfig.OutputTable=true).
TableCount	integer	The number of tables.	2
TableDetails	array<object>	Detailed table information.
	array<object>
TableId	integer	The table ID (starts from 0).	0
RowCount	integer	The number of rows in the table.	10
ColumnCount	integer	The number of columns in the table.	3
CellCount	integer	The number of cells in the table.	29
Header	object	Header information.
Contents	array	The header text content.
	string	The content of a single-line header.	"12.1本合同当事人"
BlockId	integer	The text block ID (starts from 0).	0
Footer	object	Footer information.
Contents	array	The footer text content.
	string	The content of a single-line footer.	"贷款人/抵押权人（盖章/电子签章）："
BlockId	integer	The text block ID (starts from 0).	0
CellDetails	array<object>	Detailed cell information.
	array<object>
CellId	integer	The cell ID (starts from 0).	0
CellContent	string	The cell text content.	"借款人/抵押人："
RowStart	integer	The starting row number of the cell. The first position is 0.	0
RowEnd	integer	The ending row number of the cell. The first position is 0. RowStart=0 and RowEnd=0 means the cell occupies only the first row.	0
ColumnStart	integer	The starting column number of the cell. The first position is 0.	2
ColumnEnd	integer	The ending column number of the cell. The first position is 0. ColumnStart=0 and ColumnEnd=0 means the cell occupies only the first column.	5
BlockList	array	The list of text block IDs in this cell.
	integer	A single text block ID.	0
CellPoints	array<object>	The four-point coordinates of the cell (returned when OutputCoordinate="points").
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
CellRect	object	The rotated rectangle coordinates of the cell (returned when OutputCoordinate="rectangle").
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	20
Height	integer	The rectangle height.	20
CellAngle	integer	The clockwise rotation angle of the cell (range: 0–359).	0
TablePoints	array<object>	The four-point coordinates of the table (returned when OutputCoordinate=“points").
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
TableRect	object	The rotated rectangle coordinates of the table (returned when OutputCoordinate=“rectangle").
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	100
Height	integer	The rectangle height.	100
TableExcel	string	The file link for the Excel export of table recognition results. Expires after one hour.	https://example.xlsx
TableHtml	string	The file link for the HTML export of table recognition results. Expires after one hour.	https://example.html
RowInfo	object	Row information for the sub-image (returned when AdvancedConfig.OutputRow=true).
RowCount	integer	The number of rows in the sub-image.	9
RowDetails	array<object>	Detailed row information for the sub-image.
	object
RowId	integer	The row ID (starts from 0).	0
RowContent	string	The row text content.	“合同编号..."
BlockList	array	The list of text block IDs in this row.
	integer	A single text block ID.	0
ParagraphInfo	object	Paragraph information for the sub-image (returned when AdvancedConfig.OutputParagraph=true).
ParagraphCount	integer	The number of paragraphs in the sub-image.	11
ParagraphDetails	array<object>	Detailed paragraph information for the sub-image.
	object
ParagraphId	integer	The paragraph ID (starts from 0).	0
ParagraphContent	string	The paragraph text content.	“合同编号...”
BlockList	array	The list of text block IDs in this paragraph.
	integer	A single text block ID.	0
QrCodeInfo	object	QR code information for the sub-image (returned when OutputQrcode=true).
QrCodeCount	integer	The number of QR codes in the sub-image.	1
QrCodeDetails	array<object>	Detailed QR code information for the sub-image.
	array<object>
Data	any	The QR code content.	“http://www.gsxt.gov.cn/indeXXX”
QrCodePoints	array<object>	The four-point coordinates of the QR code (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
QrCodeRect	object	The rotated rectangle coordinates of the QR code (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	100
Height	integer	The rectangle height.	100
QrCodeAngle	integer	The rotation angle of the QR code (range: 0–359).	0
BarCodeInfo	object	Barcode information for the sub-image (returned when OutputBarCode=true).
BarCodeCount	integer	The number of barcodes in the sub-image.	2
BarCodeDetails	array<object>	Detailed barcode information.
	array<object>
Type	string	The barcode type. Supported types: Codabar Code39 Code93 Code128	Code128
Data	any	The barcode content.	"1100011XXXXXX"
BarCodePoints	array<object>	The four-point coordinates of the barcode (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
BarCodeRect	object	The rotated rectangle coordinates of the barcode (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	100
Height	integer	The rectangle height.	10
BarCodeAngle	integer	The clockwise rotation angle of the barcode (range: 0–359).	0
FigureInfo	object	Pattern information for the sub-image (returned when OutputFigure=true). This is a dictionary where the key is the pattern type and the value is the information for that pattern type. Supported pattern types: blicense_title: business license title national_emblem: national emblem face: face finger_print: fingerprint signature: signature area
	object	Detailed pattern information.
FigureCount	integer	The number of patterns in the sub-image.	3
FigureDetails	array<object>	Detailed pattern information.
	array<object>
Type	string	The pattern type. One of blicense_title, national_emblem, face, finger_print, or signature.	face
Data	any	Pattern data (returned only if data exists).	“”
FigurePoints	array<object>	The four-point coordinates of the pattern (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
FigureRect	object	The rotated rectangle coordinates of the pattern (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	50
Height	integer	The rectangle height.	50
FigureAngle	integer	The clockwise rotation angle of the pattern (range: 0–359).	0
StampInfo	object	Stamp information for the sub-image (returned when OutputStamp=true).
StampCount	integer	The number of seals in the sub-image.	2
StampDetails	array<object>	The details of the stamp.
	array<object>
Data	object	The seal recognition result for the sub-image. This is a dictionary where the key is the field name and the value is the recognized result for the corresponding field.
CompanyId	string	The import and export enterprise code.	"XXX"
OrganizationName	string	The organization name.	"XXX贸易有限公司"
AntiFakeCode	string	The anti-counterfeiting code.	"3205823XXXXXX"
OtherText	string	Other text.	"3205823XXXXXX"
TopText	string	Text that appears on the outer ring of the stamp.	"XXX贸易有限公司"
OrganizationNameEng	string	The English organization name.	""
TaxpayerId	string	The taxpayer identification number.	""
StampPoints	array<object>	The four-point coordinates of the seal (returned when OutputCoordinate=“points”).
	object
X	integer	The x-coordinate of the vertex.	100
Y	integer	The y-coordinate of the vertex.	200
StampRect	object	The rotated rectangle coordinates of the seal (returned when OutputCoordinate=“rectangle”).
CenterX	integer	The x-coordinate of the rectangle center.	100
CenterY	integer	The y-coordinate of the rectangle center.	200
Width	integer	The rectangle width.	50
Height	integer	The rectangle height.	50
StampAngle	integer	The clockwise rotation angle of the rectangle (range: 0–359).	0
QualityInfo	object	Quality detection information for the sub-image.
IsCopy	boolean	Indicates whether it is a photocopy.	false
IsReshoot	boolean	Indicates whether it is a photo of a document. Only supported for ID card images (Type=IdCard).	false
CompletenessScore	number	The completeness score. Only supported for ID card images (Type=IdCard).	90.5
QualityScore	number	The overall quality score. Only supported for ID card images (Type=IdCard).	80.5
TamperScore	number	The tamper score. Only supported for ID card images (Type=IdCard).	10.5
XmlResult	string	The result in XML format.	""
AlgoVersion	string	The algorithm version number.	""
DebugInfo	any	Debug information (returned only if not empty).	""
AlgoServer	array	The list of algorithm server information (returned only if not empty).
	string	Algorithm server information.	""
IsMixedMode	boolean	Indicates whether it is a mixed type.	false
PageNo	integer	The PDF/OFD page number (starts from 1).	1
KvExcelUrl	string	The file link for the Excel export of structured information for cards and invoices. Expires after one hour.	https://example.xlsx
Code	string	The error code (not returned if recognition is successful).	400
Message	string	The error message (not returned if recognition is successful).	illegalImageUrl

KV information fields for each image type (Type). All KV fields are of String type.

Type	Type description	Returned KV information fields
IdCard	ID card	Front fields: name: Name sex: Gender ethnicity: Ethnicity birthDate: Date of birth address: Address idNumber: ID card number Back fields: issueAuthority: Issuing authority validPeriod: Period of validity
BankCard	Bank card	cardType: Card type bankName: Bank name cardNumber: Bank card number validToDate: Valid until
InternationalPassport	International passport	passportType: Document type surname: Surname givenName: Given name passportNumber: Passport number nationality: Country code nameEn: English name name: Non-English name sex: Gender birthPlaceEn: Place of birth birthPlace: Non-English place of birth country: Nationality validToDate: Valid until birthDate: Date of birth birthDateYmd: Date of birth (YYYY-MM-DD) issueDateYmd: Date of issue issuePlaceEn: Place of issue issuePlace: Non-English place of issue issueAuthorityEn: Issuing authority issueAuthority: Non-English issuing authority idNumber: ID number mrzLine1: Machine Readable Zone (MRZ) line 1 mrzLine2: MRZ line 2
ChinesePassport	Chinese passport	passportType: Document type countryCode: Country code passportNumber: Passport number nameEn: English name name: Chinese name sex: Gender birthPlace: Place of birth nationality: Nationality issuePlace: Place of issue issueAuthority: Issuing authority mrzLine1: MRZ line 1 mrzLine2: MRZ line 2 validToDate: Valid until birthDate: Date of birth issueDate: Date of issue
SocialSecurityCard	Social security card	bankAccount: Bank account number cardNumber: Social security card number idNumber: Social security number issueDate: Date of issue name: Name title: Title validPeriod: Period of validity
PermitToHK_MO_TW	Hong Kong, Macao, and Taiwan travel permit	permitType: Document category nameCn: Chinese name nameEn: English name birthDate: Date of birth sex: Gender validPeriod: Period of validity issueAuthority: Issuing authority issuePlace: Place of issue permitNumber: Document number mrzCode: MRZ code
PermitToMainland	Mainland China travel permit	birthDate: Date of birth issueAuthority: Issuing authority issueCount: Number of issues issuePlace: Place of issue nameCn: Chinese name nameEn: English name permitNumber: Document number permitType: Document category sex: Gender validPeriod: Period of validity
HouseholdHead	Household registration book cover	Registrar: Registrar's signature/seal address: Address householdNumber: Household number householdType: Household type householderCommunity: Householder's community householderName: Householder's name issueDate: Date of issue sectionNo: Section number
HouseholdResident	Household registration book resident page	birthDate: Date of birth birthPlace: Place of birth bloodGroup: Blood group educationalDegree: Education level employer: Employer ethnicity: Ethnicity formerName: Former name householdNumber: Household number idCardNumber: ID card number immigratedToCityInfo: Date and place of immigration to this city immigratedToResidenceInfo: Date and place of immigration to this address maritalStatus: Marital status militaryServiceStatus: Military service status name: Name nativePlace: Ancestral home occupation: Occupation otherResidence: Other addresses in this city registrar: Registrar's signature/seal registrationDate: Date of registration relation: Relationship to householder religious: Religious belief sex: Gender stature: Height
EstateCertification	Real estate ownership certificate	area: Area certificateNumber: Certificate number mutualOwnershipState: Co-ownership status obligee: Obligee location: Location address unitNumber: Real estate unit number rightType: Right type rightProperty: Right nature usage: Usage serviceLife: Period of use otherState: Other conditions of rights buildingArea: Building area
BirthCertification	Birth certificate	neonatalName: Neonate's name sex: Gender birthTime: Time of birth gestationalAge: Gestational age at birth birthWeight: Birth weight birthLength: Birth length birthPlace: Place of birth medicalInstitutions: Name of medical institution motherName: Mother's name motherAge: Mother's age motherNationality: Mother's nationality motherEthnicity: Mother's ethnicity motherAddress: Mother's address motherIdCardNumber: Mother's valid ID number fatherName: Father's name fatherAge: Father's age fatherNationality: Father's nationality fatherEthnicity: Father's ethnicity fatherAddress: Father's address fatherIdCardNumber: Father's valid ID number issueAuthority: Issuing authority issueDate: Date of issue certificateNumber: Number
HKIdCard	Hong Kong ID card	birthDate: Date of birth firstIssuedDate: Date of first issue idNumber: ID card number issuedCode: Issue flag issuedDate: Date of issue nameCn: Chinese name nameCode: Name telegraph code nameEn: English name sex: Gender
InternationalIdCard	International ID card	Indian ID card front fields: name: Local name nameEn: English name birthDate: Date of birth sex: Gender cardNumber: Document number virtualNumber: Virtual number Indian ID card back fields: address: Local address addressEn: English address cardNumber: Document number virtualNumber: Virtual number Indian taxpayer document fields: birthDate: Date of birth fatherName: Father's name name: Name taxId: Tax ID Vietnamese ID card front fields: birthDate: Date of birth validToDate: Valid until residence: Place of residence cardType: Document type placeOfAncestry: Place of ancestry cardNumber: Document number name: Name sex: Gender nationality: Nationality Vietnamese ID card back fields: issuer: Issuer mrzLine1: MRZ line 1 mrzLine2: MRZ line 2 mrzLine3: MRZ line 3 personalCharacteristics: Personal identification features issueDate: Date of issue Korean ID card fields: name: Local name nameChn: Chinese name cardNumber: Document number address: Address issueDate: Date of issue issuer: Issuer Bangladeshi ID card fields: name: Local name nameEn: English name fatherName: Father's name motherName: Mother's name birthDate: Date of birth cardNumber: ID card number
Stamp	Official seal	companyId: Import and export enterprise code organizationName: Organization name antiFakeCode: Anti-counterfeiting code otherText: Other text topText: Top ring text organizationNameEng: English organization name taxpayerId: Taxpayer identification number
Invoice	VAT invoice	invoiceCode: Invoice code invoiceNumber: Invoice number invoiceDate: Date of issue machineCode: Machine code checkCode: Check code purchaserName: Purchaser name passwordArea: Password area invoiceAmountPreTax: Amount before tax invoiceTax: Invoice tax amount totalAmountInWords: Total amount (uppercase) totalAmount: Invoice amount sellerName: Seller name sellerTaxNumber: Seller tax number sellerContactInfo: Seller address, phone number sellerBankAccountInfo: Seller bank name, account number drawer: Drawer title: Title invoiceType: Invoice type (electronic general invoice, electronic special invoice, special invoice, general invoice, universal invoice) formType: Copy number printedInvoiceCode: Machine-printed invoice code printedInvoiceNumber: Machine-printed invoice number purchaserBankAccountInfo: Purchaser bank name, account number purchaserContactInfo: Purchaser address, phone number purchaserTaxNumber: Purchaser tax number recipient: Recipient remarks: Remarks reviewer: Reviewer specialTag: Special identification information invoiceDetails: Invoice details
CarInvoice	Motor vehicle sales unified invoice	taxCode: Tax control code invoiceDate: Date of issue invoiceCode: Invoice code invoiceNumber: Invoice number machineCode: Machine number purchaserName: Purchaser name purchaseCode: Purchaser ID number/organization code vehicleType: Vehicle type brandMode: Brand model origin: Origin certificateNumber: Certificate number importCertificateNumber: Import certificate number commodityInspectionNumber: Commodity inspection number engineNumber: Engine number vinCode: Vehicle identification number/frame number invoiceAmountCn: Total price and tax (uppercase) invoiceAmount: Total price and tax (lowercase) sellerName: Seller name sellerContact: Seller phone number sellerTaxNumber: Seller taxpayer identification number sellerBankAccount: Seller account number sellerAddress: Seller address sellerDepositaryBank: Seller bank of deposit taxRate: VAT rate or levy rate tax: VAT amount taxAuthoritiesInfo: Competent tax authority and code taxAuthoritiesName: Competent tax authority taxAuthoritiesCode: Competent tax code preTaxAmount: Price before tax passengerLimitNumber: Seating capacity issuer: Issuer tonnage: Tonnage purchaserTaxNumber: Purchaser taxpayer identification number taxPaymentNumber: Tax payment certificate number
QuotaInvoice	Fixed-amount invoice	invoiceCode: Invoice code invoiceNumber: Invoice number AmountInWords: Total amount (uppercase) Amount: Total amount (lowercase) title: Invoice title formType: Copy number
AirItinerary	Air itinerary	agentCode: Sales unit code caacDevelopmentFund: CAAC development fund endorsement: Endorsement fare: Fare flights: Flight details fuelSurcharge: Fuel surcharge idCardNumber: Valid ID number insurance: Insurance premium internationalFlightSign: Domestic/international flight tag issueCompany: Issuing company issueDate: Date of issue otherTaxes: Other taxes and fees passengerName: Passenger name pnrCode: PNR code promptMessage: Prompt message serialNumber: Printed serial number ticketNumber: Electronic ticket number totalAmount: Total amount validationCode: Validation code
TrainTicket	Train ticket	departureStation: Departure station arrivalStation: Arrival station trainNumber: Train number departureTime: Departure time seatNumber: Seat number fare: Fare ticketGate: Ticket gate seatType: Seat type passengerInfo: Passenger information passengerName: Passenger name ticketNumber: Ticket number ticketCode: Ticket sales code saleInfo: Ticket sales station information
TollInvoice	Toll road invoice	title: Title formType: Copy number invoiceCode: Invoice code invoiceNumber: Invoice number date: Date time: Time vehicleType: Vehicle type entranceName: Entrance exitName: Exit totalAmount: Total amount ftype: Is it a photocopy (1: yes, 0: no)
RollTicket	VAT invoice roll ticket	invoiceCode: Invoice code invoiceNumber: Invoice number invoiceDate: Date of issue checkCode: Check code sellerName: Seller name sellerTaxNumber: Seller tax number purchaserName: Purchaser name purchaserTaxCode: Purchaser tax number title: Title IGNORE: Machine-printed number machineCode: Machine number cashier: Cashier totalAmountInWords: Total amount (uppercase) totalAmount: Total amount (lowercase) invoiceDetails: Invoice details itemName: Item name quantity: Quantity unitPrice: Unit price amount: Amount
BankAcceptance	Bank acceptance bill	issueDate: Date of issue validToDate: Due date draftStatus: Bill status draftNumber: Bill number issuerName: Full name of issuer issuerAccountNumber: Issuer account number issuerAccountBank: Issuer bank of deposit payeeName: Full name of payee payeeAccountNumber: Payee account number payeeAccountBank: Payee bank of deposit totalAmountInWords: Bill amount (uppercase) totalAmount: Bill amount (lowercase) acceptorName: Full name of acceptor acceptorAccountNumber: Acceptor account number acceptorBankNumber: Acceptor bank code acceptorAccountBank: Acceptor bank name agreementNumber: Transaction contract number assignability: Transferability acceptanceDate: Acceptance date
BusShipTicket	Passenger bus or ship ticket	title: Title formType: Invoice copy number invoiceCode: Invoice code invoiceNumber: Invoice number date: Date time: Time departureStation: Departure station arrivalStation: Arrival station totalAmount: Total amount passengerName: Name idcardNo: ID card number
NonTaxInvoice	Non-tax revenue invoice	additionalInfo: Additional information invoiceCode: Document code invoiceDate: Date of issue invoiceDetails: Itemized details invoiceNumber: Document number payeeName: Payee unit payerCreditCode: Payer Unified Social Credit Code payerName: Payer recipient: Recipient reviewer: Reviewer title: Title totalAmount: Total amount (lowercase) totalAmountInWords: Total amount (uppercase) validationCode: Validation code
CommonPrintedInvoice	Common printed invoice	title: Title formType: Invoice copy number invoiceCode: Invoice code invoiceNumber: Invoice number printedInvoiceCode: Invoice code - machine-printed printedInvoiceNumber: Invoice number - machine-printed invoiceDate: Date of issue totalAmount: Total amount sellerName: Seller name sellerTaxNumber: Seller taxpayer identification number purchaserName: Purchaser name purchaserTaxNumber: Purchaser taxpayer identification number drawer: Drawer recipient: Recipient remarks: Remarks invoiceDetails: Invoice details itemName: Item name unit: Unit quantity: Quantity unitPrice: Unit price amount: Total value ftype: Is it a photocopy (1: yes, 0: no)
HotelConsume	Hotel transaction record	fax: Fax phone: Phone number postCode: Postal code roomNo: Room number checkInDate: Check-in date departureDate: Departure date memberNumber: Membership number totalConsumption: Total consumption name: Name roomType: Room type numberOfGuests: Number of guests roomRate: Room rate address: Address consumptionDetails: Consumption details Consumption details fields: date: Date item: Item consumption: Consumption payment: Payment
PaymentRecord	Payment details page	description: Product description orderNumber: Order number paymentMethod: Payment method paymentTime: Payment time recipientName: Recipient name totalAmount: Total amount
PurchaseRecord	E-commerce order page	orderNumber: Order number transactionTime: Transaction time deliveryInfo: Shipping information totalAmount: Transaction amount shopName: Store name ftype: Is it a photocopy (1: yes, 0: no) shoppingDetails: Product details Product details fields: name: Product name specification: Product specification price: Unit price quantity: Quantity
RideHailingItinerary	Ride-hailing itinerary	serviceProvider: Service provider applicationDate: Application date startTime: Trip start time endTime: Trip end time phoneNumber: Passenger phone number totalAmount: Total amount rideDetails: Trip details Number: Ordinal number carType: Vehicle type pickUpTime: Pickup time city: City startPlace: Origin endPlace: Destination mileage: Mileage amount: Amount remarks: Remarks
ShoppingReceipt	Shopping receipt	shopName: Issuer name receiptDate: Date of issue receiptTime: Time of issue contactNumber: Contact number shopAddress: Address totalAmount: Total (paid) amount receiptDetails: Product details
TaxClearanceCertificate	Tax clearance certificate	certificateNumber: Number drawer: Drawer formType: Copy number issueDate: Date of issue name: Taxpayer name remarks: Remarks taxAuthorityName: Tax authority taxClearanceDetails: Tax clearance details taxNumbe: Taxpayer identification number totalAmount: Total amount (lowercase) totalAmountInWords: Total amount (uppercase)
UsedCarInvoice	Used car sales unified invoice	title: Title formType: Copy number invoiceDate: Date of issue invoiceCode: Invoice code invoiceNumber: Invoice number printedInvoiceCode: Machine-printed code printedInvoiceNumber: Machine-printed number taxCode: Tax control code purchaserName: Buyer unit/individual name purchaserCode: Buyer unit code/ID number purchaserAddress: Buyer unit/individual address purchaserPhoneNumber: Buyer phone number sellerName: Seller unit/individual name sellerCode: Seller unit code/ID number sellerAddress: Seller unit/individual address sellerPhoneNumber: Seller phone number licensePlateNumber: License plate number certificateNumber: Registration certificate number vehicleType: Vehicle type vinCode: Vehicle identification number/frame number brandMode: Brand model vehicleAdministrationName: Transferred vehicle administration name totalAmountInWords: Total vehicle price (uppercase) totalAmount: Total vehicle price (lowercase) marketName: Used car market name marketTaxNumber: Used car market taxpayer identification number marketAddress: Used car market address marketBankAccountInfo: Used car market bank name and account marketPhoneNumber: Used car market phone number remarks: Remarks drawer: Drawer
VehicleLicense	Vehicle license	Vehicle license front fields: address: Address engineNumber: Engine number issueDate: Date of issue model: Brand model owner: Owner licensePlateNumber: License plate number registrationDate: Registration date useNature: Usage nature vehicleType: Vehicle type vinCode: Vehicle identification number issueAuthority: Issuing authority Vehicle license back fields: licensePlateNumber: License plate number inspectionRecord: Inspection record passengerCapacity: Approved passenger capacity totalWeight: Gross vehicle weight curbWeight: Curb weight permittedWeight: Approved load capacity overallDimension: Overall dimensions tractionWeight: Approved total traction mass energySign: Energy sign recordNumber: File number remarks: Remarks
DrivingLicense	Driver's license	Driver's license front fields: licenseNumber: License number name: Name sex: Gender nationality: Nationality address: Address birthDate: Date of birth initialIssueDate: Initial issue date approvedType: Approved driving type issueAuthority: Issuing authority validFromDate: Valid from date validPeriod: Period of validity Driver's license back fields: name: Name recordNumber: File number record: Record licenseNumber: License number
VehicleRegistration	Motor vehicle registration certificate	acquisitionMethod: Vehicle acquisition method axleNumber: Number of axles barCode: Barcode cabPassengerCapacity: Cab passenger capacity containerDimension: Cargo box internal dimensions displacement: Displacement engineNumber: Engine number engineType: Engine model frontWheelTrack: Front wheel track fuelType: Fuel type isDomestic: Domestic/imported issueAuthority: Issuing authority issueDate: Date of issue manufactureDate: Vehicle manufacturing date manufactureName: Manufacturer name overallDimension: Overall dimensions passengerCapacity: Cab passenger capacity permittedWeight: Approved load capacity power: Power rearWheelTrack: Rear wheel track registrationAuthority: Registration authority registrationDate: Registration date registrationNumber: Motor vehicle registration number springNumber: Number of leaf springs steeringForm: Steering type tireNumber: Number of tires tireSize: Tire size totalWeight: Gross vehicle weight tractionWeight: Approved total traction mass useNature: Usage nature vehicleBrand: Vehicle brand vehicleColor: Vehicle color vehicleModel: Vehicle model vehicleOwnerInfo: Motor vehicle owner/ID type/number vehicleType: Vehicle type vinCode: Vehicle identification number/frame number wheelbase: Wheelbase
VehicleCertification	Vehicle qualification certificate	MaximumLoadMass: Maximum allowed total mass of semi-trailer fifth wheel axleLoad: Axle load axleNumber: Number of axles cabPassengerCapacity: Approved cab passenger capacity certificateNumber: Certificate number chassisCertificateNumber: Chassis certificate number chassisId: Chassis ID chassisModel: Chassis model containerDimension: Cargo box internal dimensions displacement: Displacement emissionStandard: Emission standard engineModel: Engine model engineNumber: Engine number equipmentWeight: Equipment weight frontWheelTrack: Front wheel track fuelConsumption: Fuel consumption fuelType: Fuel type issueDate: Date of issue manufactureDate: Vehicle manufacturing date manufactureName: Vehicle manufacturer name massUtilizationCoefficient: Load mass utilization coefficient maxDesignSpeed: Maximum design speed maximumLadenMass: Rated load capacity overallDimension: Overall dimensions passengerCapacity: Rated passenger capacity power: Power rearWheelTrack: Rear wheel track remarks: Remarks springNumber: Number of leaf springs steeringForm: Steering type tireNumber: Number of tires tireSize: Tire size totalWeight: Gross vehicle weight tractionWeight: Approved total traction mass vehicleBrand: Vehicle brand vehicleColor: Vehicle color vehicleModel: Vehicle model vehicleName: Vehicle name vinCode: Vehicle identification number/frame number wheelbase: Wheelbase
LicensePlateNumber	License plate number	data: License plate information
CarVinCode	Vehicle VIN code	vinCode: License plate VIN code information
BusinessLicense	Business license	title: Title creditCode: Unified Social Credit Code companyName: Business name companyType: Type businessAddress: Business premises/domicile legalPerson: Legal representative/owner businessScope: Business scope registeredCapital: Registered capital RegistrationDate: Registration date issueDate: Date of issue validPeriod: Business term validFromDate: Formatted start date of business term validToDate: Formatted end date of business term companyForm: Organizational form
BusinessLicense	International business license	Indian company registration certificate fields: certificateType: Document type registrationNo: Registration number legalName: Legal name tradeName: Trade name businessConstitution: Business constitution businessAddress: Address liabilityDate: Liability date validFromDate: Valid from date validToDate: Valid to date registrationType: Registration type particularsOfApprovingAuthority: Details of approving authority name: Name designation: Designation jurisdictionalOffice: Jurisdictional office issueDate: Date of issue Korean business registration certificate fields: certificateType: Document type issuanceNo: Issuance number processingTime: Processing time companyNameEn: English company name companyName: Non-English company name registrationNo: Business registration number nameOfRepresentativeEn: English legal representative name nameOfRepresentative: Non-English legal representative name residentRegistrationNo: Legal representative ID number businessAddressEn: English business address businessAddress: Non-English business address businessCommencementDate: Business commencement date businessRegistrationDate: Business registration date businessTypeEn: English business type businessType: Non-English business type businessItemEn: English business scope businessItem: Non-English business scope jointCompanyName: Joint company name jointCompanyRegistrationNo: Joint company registration number issueDate: Date of issue issuer: Issuer
MedicalDeviceManageLicense	Medical device operating license	title: License title licenseNumber: License number companyName: Enterprise name businessType: Business method officeAddress: Domicile businessScope: Business scope businessAddress: Business premises warehouseAddress: Warehouse address issueDate: Date of issue issueAuthority: Issuing department legalRepresentative: Legal representative responsiblePerson: Enterprise owner qualityManager: Quality manager registeredAddress: Registered address validToDate: Period of validity/license term
MedicalDeviceProduceLicense	Medical device production license	registeredAddress: Registered address issueDate: Date of issue licenseNumber: License number issueAuthority: Issuing department legalRepresentative: Legal representative productionAddress: Production address responsiblePerson: Enterprise owner companyName: Enterprise name validToDate: Period of validity officeAddress: Domicile productionScope: Production scope
CosmeticProduceLicense	Cosmetic production license	title: License name enterpriseName: Enterprise name creditCode: Social credit code officeAddress: Domicile legalRepresentative: Legal representative responsiblePerson: Enterprise owner safetyManager: Quality and safety manager productionAddress: Production address licenceNumber: License number licensedItemScope: Licensed item scope regulatoryAuthority: Daily supervision and management authority regulatoryPersonnel: Daily supervision and management personnel reportHotline: Complaint hotline issueOfficer: Issuer issueAuthority: Issuing authority issueDate: Date of issue validToDate: Valid to date ftype: Is it a photocopy
TaxiInvoice	Taxi invoice	date: Ride date dropOffTime: Drop-off time fare: Amount invoiceCode: Invoice code invoiceNumber: Invoice number licensePlateNumber: License plate number mileage: Mileage pickUpTime: Pickup time
TrademarkCertificate	Trademark registration certificate	validToDate: Valid to date registeredAddress: Registrant address registrationDate: Registration date registrant: Registrant approvedRightScope: Approved goods/services scope iprNumber: Intellectual property number certificateNumber: Encoding
FoodProduceLicense	Food production license	producerName: Producer name creditCode: Social credit code (ID card number) legalRepresentative: Legal representative (owner) officeAddress: Domicile productionAddress: Production address foodType: Food category licenceNumber: License number regulatoryAuthority: Daily supervision and management authority regulatoryPersonnel: Daily supervision and management personnel reportHotline: Complaint hotline issueAuthority: Issuing authority issueOfficer: Issuer issueDate: Date of issue validToDate: Valid to date
FoodManagementLicense	Food operation license	operatorName: Operator name creditCode: Social credit code (ID card number) legalRepresentative: Legal representative (owner) officeAddress: Domicile businessAddress: Business premises mainBusiness: Main business type businessScope: Business scope licenceNumber: License number regulatoryAuthority: Daily supervision and management authority regulatoryPersonnel: Daily supervision and management personnel reportHotline: Complaint hotline issueAuthority: Issuing authority issueOfficer: Issuer issueDate: Date of issue standardizedIssueDate: Formatted issue date validToDate: Valid to date standardizedValidToDate: Formatted valid to date
ClassIIMedicalDeviceManageLicense	Class II medical device operating filing certificate	recordNumber: Filing number companyName: Enterprise name officeAddress: Domicile businessAddress: Business premises warehouseAddress: Warehouse address businessType: Business method legalRepresentative: Legal representative responsiblePerson: Enterprise owner businessScope: Business scope recordationAuthority: Filing department recordationDate: Filing date
WayBill	Electronic waybill	recipientName: Recipient name senderAddress: Sender name senderPhoneNumber: Sender phone number senderAddress: Sender address recipientPhoneNumber: Recipient phone number recipientAddress: Recipient address
BankAccountPermit	Bank account permit	bankAccount: Account number legalRepresentative: Legal representative depositaryBank: Bank of deposit approvalNumber: Approval number customerName: Name permitNumber: Number title: Title

Examples

Success response

JSON format

{
  "RequestId": "E2A98925-DC2C-18FB-995F-BAF507XXXXXX",
  "Data": {
    "Height": 2000,
    "Width": 1000,
    "Content": "\"合同编号...\"",
    "SubImageCount": 2,
    "SubImages": [
      {
        "SubImageId": 0,
        "Type": "身份证正面",
        "Angle": 0,
        "SubImagePoints": [
          {
            "X": 100,
            "Y": 200
          }
        ],
        "SubImageRect": {
          "CenterX": 100,
          "CenterY": 200,
          "Width": 1000,
          "Height": 2000
        },
        "KvInfo": {
          "KvCount": 6,
          "Data": "{\n  \"address\": \"XX省XX市XX街道XX号\",\n  \"ethnicity\": \"汉\",\n  \"sex\": \"男\",\n  \"name\": \"王XX\",\n  \"idNumber\": \"XXX\",\n  \"birthDate\": \"2000年1月1日\"\n}",
          "KvDetails": {
            "key": {
              "KeyName": "\"address\"",
              "KeyConfidence": 100,
              "Value": "\"XX省XX市XX街道\"",
              "ValueConfidence": 98,
              "ValuePoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "ValueRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 50,
                "Height": 50
              },
              "ValueAngle": 0
            }
          }
        },
        "BlockInfo": {
          "BlockCount": 12,
          "BlockDetails": [
            {
              "BlockId": 0,
              "BlockAngle": 0,
              "BlockContent": "“合同编号...”",
              "BlockConfidence": 98,
              "BlockPoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "BlockRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 50,
                "Height": 10
              },
              "CharInfos": [
                {
                  "CharId": 0,
                  "CharContent": "“合”",
                  "CharConfidence": 95,
                  "CharPoints": [
                    {
                      "X": 100,
                      "Y": 200
                    }
                  ],
                  "CharRect": {
                    "CenterX": 100,
                    "CenterY": 200,
                    "Width": 10,
                    "Height": 10
                  }
                }
              ]
            }
          ]
        },
        "TableInfo": {
          "TableCount": 2,
          "TableDetails": [
            {
              "TableId": 0,
              "RowCount": 10,
              "ColumnCount": 3,
              "CellCount": 29,
              "Header": {
                "Contents": [
                  "\"12.1本合同当事人\""
                ],
                "BlockId": 0
              },
              "Footer": {
                "Contents": [
                  "\"贷款人/抵押权人（盖章/电子签章）：\""
                ],
                "BlockId": 0
              },
              "CellDetails": [
                {
                  "CellId": 0,
                  "CellContent": "\"借款人/抵押人：\"",
                  "RowStart": 0,
                  "RowEnd": 0,
                  "ColumnStart": 2,
                  "ColumnEnd": 5,
                  "BlockList": [
                    0
                  ],
                  "CellPoints": [
                    {
                      "X": 100,
                      "Y": 200
                    }
                  ],
                  "CellRect": {
                    "CenterX": 100,
                    "CenterY": 200,
                    "Width": 20,
                    "Height": 20
                  },
                  "CellAngle": 0
                }
              ],
              "TablePoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "TableRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 100,
                "Height": 100
              }
            }
          ],
          "TableExcel": "https://example.xlsx",
          "TableHtml": "https://example.html"
        },
        "RowInfo": {
          "RowCount": 9,
          "RowDetails": [
            {
              "RowId": 0,
              "RowContent": "“合同编号...\"",
              "BlockList": [
                0
              ]
            }
          ]
        },
        "ParagraphInfo": {
          "ParagraphCount": 11,
          "ParagraphDetails": [
            {
              "ParagraphId": 0,
              "ParagraphContent": "“合同编号...”",
              "BlockList": [
                0
              ]
            }
          ]
        },
        "QrCodeInfo": {
          "QrCodeCount": 1,
          "QrCodeDetails": [
            {
              "Data": "“http://www.gsxt.gov.cn/indeXXX”",
              "QrCodePoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "QrCodeRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 100,
                "Height": 100
              },
              "QrCodeAngle": 0
            }
          ]
        },
        "BarCodeInfo": {
          "BarCodeCount": 2,
          "BarCodeDetails": [
            {
              "Type": "Code128",
              "Data": "\"1100011XXXXXX\"",
              "BarCodePoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "BarCodeRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 100,
                "Height": 10
              },
              "BarCodeAngle": 0
            }
          ]
        },
        "FigureInfo": {
          "key": {
            "FigureCount": 3,
            "FigureDetails": [
              {
                "Type": "face",
                "Data": "“”",
                "FigurePoints": [
                  {
                    "X": 100,
                    "Y": 200
                  }
                ],
                "FigureRect": {
                  "CenterX": 100,
                  "CenterY": 200,
                  "Width": 50,
                  "Height": 50
                },
                "FigureAngle": 0
              }
            ]
          }
        },
        "StampInfo": {
          "StampCount": 2,
          "StampDetails": [
            {
              "Data": {
                "CompanyId": "\"XXX\"",
                "OrganizationName": "\"XXX贸易有限公司\"",
                "AntiFakeCode": "\"3205823XXXXXX\"",
                "OtherText": "\"3205823XXXXXX\"",
                "TopText": "\"XXX贸易有限公司\"",
                "OrganizationNameEng": "\"\"",
                "TaxpayerId": "\"\""
              },
              "StampPoints": [
                {
                  "X": 100,
                  "Y": 200
                }
              ],
              "StampRect": {
                "CenterX": 100,
                "CenterY": 200,
                "Width": 50,
                "Height": 50
              },
              "StampAngle": 0
            }
          ]
        },
        "QualityInfo": {
          "IsCopy": false,
          "IsReshoot": false,
          "CompletenessScore": 90.5,
          "QualityScore": 80.5,
          "TamperScore": 10.5
        }
      }
    ],
    "XmlResult": "\"\"",
    "AlgoVersion": "\"\"",
    "DebugInfo": "\"\"",
    "AlgoServer": [
      "\"\""
    ],
    "IsMixedMode": false,
    "PageNo": 1,
    "KvExcelUrl": "https://example.xlsx"
  },
  "Code": "400",
  "Message": "illegalImageUrl"
}

Error codes

HTTP status code	Error code	Error message	Description
400	invalidInputParameter	%s
400	InvalidCountry	Specified parameter Country is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.