Skip to main content

Document OCR

Command Description

Recognizes data from ID cards, driver's licenses, and bank cards.

Command Input Parameters

input parametersInput parameter typeDescription
Document TypeenumID Card, Bank Card, or Driver's License
Image SourceenumLocal File, Desktop Element, or Web Element
Image PathstrFull path to the local image. Required when Image Source is Local File
Desktop ElementWinElement or str (captured element UID, not element name or ms-rpa-id)Captured desktop element or a desktop element returned by Get Desktop Element, Get Related Desktop Elements, or Get Similar Desktop Elements. Required when Image Source is Desktop Element
Webpage ObjectWebPageWebpage containing the target element. Required when Image Source is Web Element
Web ElementWebElement or str (captured element UID, not element name or ms-rpa-id)Captured web element or a web element returned by Get Web Element, Get Similar Web Elements, or Get Related Web Elements. Required when Image Source is Web Element

Command Output Parameters

Output parametersOutput parameter typeDescription
Recognition ResultIDCardOCR, BankCardOCR, or DrivingLicenceOCROutput type determined by Document Type

Type Definition Reference

Example