AddressInfo

Overseas document recognition address information

Used by actions: GetCardVerificationExternalResult, GetOcrVerificationResult.

Name	Type	Description
Country	String	Country
PostalCode	String	Postal code
Subdivision	String	Sub-region
District	String	District
City	String	City
Subdistrict	String	Sub-district office
FormattedAddress	String	Complete address
LineOne	String	First line of the address bar
LineTwo	String	Second line of the address bar
LineThree	String	Third line of the address bar
LineFour	String	Fourth line of the address bar
LineFive	String	Fifth line of the address bar

AnalyzedLog

Intelligent review log

Used by actions: PODAuditAI.

Name	Type	Description
StepKey	String	Indexes of the procedure. Enumeration value: L1_IMAGE_QUALITY: Image quality detection L2_RULE_ENGINE: Rule verification L3_LLM_JUDGE: Large model judgment
Decision	String	Compliant and non-compliant are final states; to be determined is an intermediate state. Judgment status of each layer: Compliant Non-Compliant Pending.
DecisionMessage	String	Reason for the current layer judgment
CostTime	Integer	Time taken by the current layer Unit: ms

BrazilCardInfo

Type of document in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name	Type	Description
RNE	BrazilRNEInfo	RNE document. Note: This field may return null, indicating that no valid values can be obtained.
RNM	BrazilRNMInfo	Specifies the document. Note: This field may return null, indicating that no valid values can be obtained.
DriverLicense	BrazilDriverLicenseInfo	Driver license document. Note: This field may return null, indicating that no valid values can be obtained.
IDCard	BrazilIDCardInfo	ID card document. Note: This field may return null, indicating that no valid values can be obtained.

BrazilDriverLicenseInfo

Driver'S license type in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name	Type	Description
NOME	String	Name.
CatHab	String	Specifies the driver's license type.
CNHNumber	String	Driver’s license id.
VALIDADE	String	Expiration date.
QUALIFICATION	String	Indicates the qualification.
IDENTIDADE	String	Identity card number.
CPF	String	Tax number of the person.
NASCIMENTO	String	Date of birth.
MEMBERSHIP	String	Membership status.
REGISTRO	String	Registration number.
OBSERVATIONS	String	Remarks.
IssueDate	String	Issue date.
LOCAL	String	Issuing location.
BackNumber	String	Record number.
PortraitImage	String	Specifies the avatar in base64 format.

BrazilIDCardInfo

Specifies the identity card type in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name	Type	Description
Nome	String	Name.
MemberShip	String	Parent information.
DataNascimento	String	Date of birth.
IssuingAgency	String	Issuing organization.
Fatorrh	String	Specifies the blood type.
NaturalIDade	String	Birthplace.
Observations	String	Remarks.
CPF	String	CPF Type
DNI	String	DNI Type
RegistroGeral	String	Common registration.
DispatchDate	String	Issue date. valid values: dd/mm/yyyy.
Registro	String	Address.
PortraitImage	String	Specifies the avatar in Base64 format of the id card.
DocOrigem	String	Original identity information.

BrazilRNEInfo

BrazilRNEInfo

Used by actions: RecognizeBrazilCommonOCR.

Name	Type	Description
RNE	String	RNE
CLASSIFICATION	String	CLASSIFICAÇÃO(CLASSIFICATION)
VALIDADE	String	VALIDADE
NOME	String	NOME
Membership	String	FILIAÇÃO(MEMBERSHIP)
NACIONALIDADE	String	NACIONALIDADE
NATURALIDADE	String	NATURALIDADE(PAÍS)
IssuingAgency	String	ORGÃO EXPEDIDOR(IssuingAgency)
DateOfBirth	String	DATA DE NASCIMENTO(DateOfBirth)
Sex	String	SEXO
EntryDate	String	DATA DE ENTRADA(EntryDate)
VIA	String	VIA
DispatchDate	String	DATA DE EXPEDIÇÃO(DispatchDate)
MRZ	String	MRZ
PortraitImage	String	PortraitImage

BrazilRNMInfo

Document type for brazil RNM.

Used by actions: RecognizeBrazilCommonOCR.

Name	Type	Description
SOBRENOME	String	SOBRENOME Type
NOME	String	NOME Type
DATADENASCIMENTO	String	DATA DE NASCIMENTO
SEXO	String	SEXO F
MEMBERSHIP	String	FILIAÇÃO(MEMBERSHIP)
NACIONALIDADE	String	NACIONALIDADE Type
VALIDADE	String	VALIDADE Type
RNM	String	RNM Type
CPF	String	CPF Type
CLASSIFICATION	String	CLASSIFICAÇÃO(CLASSIFICATION)
PRAZODERESIDENCIA	String	PRAZO DE RESIDENCIA
ISSUANCE	String	EMISSÃO(ISSUANCE)
AMPAROLEGAL	String	AMPARO LEGAL(LegalHelp)
MRZ	String	MRZCode
PortraitImage	String	Portrait Image
PortraitImageBack	String	PortraitImage(Back)

ConfigAdvanced

Supports single attribute configuration for templates.

Used by actions: ExtractDocMulti.

Name	Type	Required	Description
Scene	String	No	Single attribute configuration of a template.

Coord

Coordinates

Used by actions: ExtractDocMulti, GeneralAccurateOCR, GeneralBasicOCR, RecognizeDetectCardCoords, SmartStructuralOCRV2.

Name	Type	Description
X	Integer	Horizontal coordinate
Y	Integer	Vertical coordinate

CoordsItem

Detected coordinate recognition information.

Used by actions: RecognizeDetectCardCoords.

Name	Type	Description
Polygon	Polygon	Coordinates of four points in the image.
Coords	ItemCoord	Coordinates of two points in the image.

DetectedWordCoordPoint

Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name	Type	Description
WordCoordinate	Array of Coord	Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner

DetectedWords

Information about a character detected, including the character itself and its confidence

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name	Type	Description
Confidence	Integer	Confidence. Value range: 0–100
Character	String	A possible character

GeneralCard

General card certificate information

Used by actions: GetCardVerificationExternalResult, GetOcrVerificationResult.

Name	Type	Description
LicenseNumber	String	ID number
PersonalNumber	String	Personal number, returned when the identity document type is passport
FullName	String	Name
FullNameLocal	String	Localized name
FirstName	String	Name
FirstNameLocal	String	Localized name
MiddleName	String	Middle name
MiddleNameLocal	String	Localized middle name
LastName	String	Last name
LastNameLocal	String	Localized last name
Sex	String	Gender on the document M: man F: woman X: other gender identity
Birthday	String	Date of birth
BirthPlace	String	Birth place
IssuedDate	String	Issue date, in YYYY-MM-DD format
IssuedAuthority	String	Issuing authority
IssuedPlace	String	Place where the specified file is issued
IssuedCountry	String	Issuing country
IssuedCountryCode	String	Country code of the country that issued the file, ISO ALPHA-3 country/region code
ExpirationDate	String	Expiration date, in YYYY-MM-DD format
MRZLine1	String	Content of the single-line machine-readable zone (MRZ) on the document. The number represents the order in which the line appears in the MRZ
MRZLine2	String	Content of the single-line machine-readable zone (MRZ) on the document. The number represents the line count in the order of the MRZ
Nationality	String	Document nationality, returned following the ISO 3166 country coding specification
Address	AddressInfo	Address information on the document
Religion	String	Religious belief
Type	String	Document type
BloodType	String	Blood type
Height	String	Height
Weight	String	Weight
VehicleClass	String	Driver's license vehicle type (for example, A/B/C)
Restrictions	String	Driver's license restriction condition
Endorsement	String	Driver's license extra records
Others	String	Additional field

GroupInfo

The sequence number of an element group in the image

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
Groups	Array of LineInfo	The elements in each line.

ImageCoordinates

Avatar position coordinates

Used by actions: HmtResidentPermitOCR.

Name	Type	Description
X	Integer	Top-left horizontal coordinate of the avatar
Y	Integer	Top-left vertical coordinate of the avatar
Width	Integer	Avatar frame width. Unit: px.
Height	Integer	Avatar frame height. Unit: px.

ItemCoord

Pixel coordinates of the text line in the image after rotation correction, which is in the format of (X-coordinate of top-left point, Y-coordinate of top-left point, width, height).

Used by actions: GeneralAccurateOCR, GeneralBasicOCR, RecognizeDetectCardCoords.

Name	Type	Description
X	Integer	X-coordinate of top-left point.
Y	Integer	Y-coordinate of top-left point.
Width	Integer	Width
Height	Integer	Height

ItemInfo

Structured element group

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
Key	Key	The key information. Note: This field may return null, indicating that no valid values can be obtained.
Value	Value	The value information. Note: This field may return null, indicating that no valid values can be obtained.

ItemNames

Used by actions: ExtractDocMulti.

Name	Type	Required	Description
KeyName	String	No
KeyType	Integer	No
KeyPrompt	String	No
KeyExpectedValue	String	No
KeyAuditPrompt	String	No

Key

Key information

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
AutoName	String	The name of the recognized field.
ConfigName	String	The name of a defined field (the key passed in). Note: This field may return null, indicating that no valid values can be obtained.

LineInfo

Line number

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
Lines	Array of ItemInfo	The elements in a line

MainlandTravelPermitBackInfos

Used by actions: MainlandPermitOCR.

Name	Type	Description
Type	String
Name	String
IDNumber	String
HistoryNumber	String

PassportRecognizeInfos

Passport Information Page Content

Used by actions: MLIDPassportOCR.

Name	Type	Description
Type	String	Document type, obtained from passport visual zone
IssuingCountry	String	Issuing country, obtained from passport visual zone
PassportID	String	Unique serial number / identification number of the passport, obtained from passport visual zone
Surname	String	Last name, obtained from passport visual zone
GivenName	String	First name, obtained from passport visual zone
Name	String	Full name, obtained from passport visual zone
Nationality	String	Nationality, obtained from passport visual zone
DateOfBirth	String	Date of birth, obtained from passport visual zone
Sex	String	Gender, obtained from passport visual zone
DateOfIssuance	String	Date of issue, obtained from passport visual zone
DateOfExpiration	String	Passport expiry date, obtained from passport visual zone
Signature	String	Holder's signature, obtained from passport visual zone (Note: Only returned for PRC passport)
IssuePlace	String	Place of issue, obtained from passport visual zone (Note: Only returned for PRC passport)
IssuingAuthority	String	Issuing Authority, obtained from passport visual zone (Note: Only returned for PRC passport)
BirthPlace	String	Place of birth, obtained from passport visual zone
PassportFlag	String	Passport flag, obtained from passport visual zone
MiddleName	String	Middle name, obtained from passport visual zone
FatherName	String	Father's name, obtained from passport visual zone
MotherName	String	Mother's name, obtained from passport visual zone
Title	String	Title, obtained from passport visual zone
Postname	String	Name suffix, obtained from passport visual zone

Polygon

The coordinates of the four vertices of the text
Note: This field may return null, indicating that no valid values can be obtained.

Used by actions: ExtractDocMulti, RecognizeDetectCardCoords, SmartStructuralOCRV2.

Name	Type	Description
LeftTop	Coord	The coordinates of the upper-left vertex.
RightTop	Coord	The coordinates of the upper-right vertex.
RightBottom	Coord	The coordinates of the lower-left vertex.
LeftBottom	Coord	The coordinates of the lower-right vertex.

PortraitImageInfo

Avatar photo and coordinates

Used by actions: HmtResidentPermitOCR.

Name	Type	Description
PortraitImage	String	Avatar
ImageCoordinates	ImageCoordinates	Avatar coordinate

TextDetection

OCR result.

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name	Type	Description
DetectedText	String	Recognized text line content.
Confidence	Integer	Confidence. Value range: 0–100.
Polygon	Array of Coord	Text line coordinates, which are represented as 4 vertex coordinates. Note: this field may return null, indicating that no valid values can be obtained.
AdvancedInfo	String	Extended field. The paragraph information Parag returned by the GeneralBasicOcr API contains ParagNo.
ItemPolygon	ItemCoord	Pixel coordinates of the text line in the image after rotation correction, which is in the format of (X-coordinate of top-left point, Y-coordinate of top-left point, width, height).
Words	Array of DetectedWords	Information about a character, including the character itself and its confidence. Supported APIs: GeneralBasicOCR, GeneralAccurateOCR
WordCoordPoint	Array of DetectedWordCoordPoint	Coordinates of a word’s four corners on the input image. Supported APIs: GeneralBasicOCR, GeneralAccurateOCR

TextDetectionResult

Recognition result

Used by actions: RecognizePhilippinesDrivingLicenseOCR, RecognizePhilippinesSssIDOCR, RecognizePhilippinesTinIDOCR, RecognizePhilippinesUMIDOCR, RecognizePhilippinesVoteIDOCR.

Name	Type	Description
Value	String	The recognized text line content.

Value

Value information

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
AutoContent	String	The value of the recognized field.
Coord	Polygon	The coordinates of the four vertices. Note: This field may return null, indicating that no valid values can be obtained.

WordItem

The recognized text information.

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
DetectedText	String	The text content.
Coord	Polygon	The coordinates of the four vertices.
AdvancedInfo	String	Description.
WordCoord	Array of WordPolygon	Specifies the four-point coordinate of the word.

WordPolygon

Word coordinates info.

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name	Type	Description
DetectedText	String	The text content.
Coord	Polygon	The coordinates of the four vertices.