All Products
Search

This Product

    ID Verification:OCR fields for identification documents

    Document Center

    ID Verification:OCR fields for identification documents

    Last Updated:Sep 16, 2026

    Hong Kong identity card 00000006 and 00000008

    Note

    This feature supports both the 2003 version (00000006) and the 2018 version (00000008) of the China Hong Kong Identity Card.

    Field

    Type

    Description

    name

    String

    Name

    englishName

    String

    Name (English)

    nameCode

    String

    chinese name telecode

    sex

    String

    Sex. Possible values:

    • M: Male

    • F: Female

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    currentIssueDate

    String

    Registration date

    firstIssueDate

    String

    Month and year of first registration

    isPermanent

    String

    Specifies whether the card is permanent. Possible values:

    • Y: Yes

    • N: No

    symbols

    String

    Symbol. For example: ***AZ.

    Exit-entry permit for Hong Kong and Macao 00000007

    Field

    Type

    Description

    name

    String

    Name

    englishName

    String

    Name (Pinyin)

    sex

    String

    Sex

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    issueDate

    String

    Issue date

    expiryDate

    String

    Expiry date

    placeOfIssue

    String

    Place of issue

    originOfIssue

    String

    Issuing authority

    Home return permit 00000009

    Field

    Type

    Description

    name

    String

    Name

    englishName

    String

    Name (English)

    sex

    String

    Sex

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    issueDate

    String

    Issue date

    expiryDate

    String

    Expiry date

    originOfIssue

    String

    Issuing authority

    Taiwan compatriot permit 000000012

    Field

    Type

    Description

    name

    String

    Name

    englishName

    String

    Name (Pinyin)

    sex

    String

    Sex

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    issueDate

    String

    Issue date

    expiryDate

    String

    Expiry date

    originOfIssue

    String

    Issuing authority

    placeOfIssue

    String

    Place of issue

    e-Passport 01000000

    Note

    This feature recognizes content from the Machine-Readable Zone (MRZ) of ICAO-compliant e-Passports. It outputs fields in a standardized format to prevent compatibility issues that arise from varying data page layouts across countries.

    Field

    Type

    Description

    surname

    String

    Surname (Latin script based on MRZ recognition)

    givenname

    String

    Given name (Latin script based on MRZ recognition)

    sex

    String

    Sex (F or M)

    birthDate

    String

    Birth date (in yyyy-mm-dd format)

    passportNo

    String

    Passport number

    nationality

    String

    Nationality (3-digit country code)

    expiryDate

    String

    Expiry date (in yyyy-mm-dd format)

    countryCode

    String

    Country code of the passport issuing authority

    (3-digit country code)

    Macao resident identity card 000000011

    Field

    Type

    Description

    surnameCN

    String

    Surname (Chinese)

    givennameCN

    String

    Given name (Chinese)

    surname

    String

    Surname (English)

    givenname

    String

    Given name (English)

    sex

    String

    Sex

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    expiryDate

    String

    Expiry date

    placeOfBirth

    String

    Place of birth code. For example: "AS".

    Chinese resident identity card 00000001

    Field

    Type

    Description

    name

    String

    Name

    sex

    String

    Sex

    ethnicity

    String

    Ethnicity

    birthDate

    String

    Birth date

    idNumber

    String

    ID number

    address

    String

    Address

    province

    String

    Province

    Note

    This is a reserved field that is empty by default.

    city

    String

    City

    Note

    This is a reserved field that is empty by default.

    originOfIssue

    String

    Issuing authority

    issueDate

    String

    Issue date

    expiryDate

    String

    Expiry date