# API Reference ### get\_deviceid ```python def get_deviceid() -> str: ```


Name	get_device_id
Description	Retrieves the Hardware ID from a library.
Input	None
Output	The Hardware ID is returned as a standard Python string.

### set\_activation {% code overflow="wrap" %} ```python def set_activation(license_key: str) -> str: ``` {% endcode %}


Name	set_activation
Description	Activates the OCR engine using the provided license key.
Input	license_key (str): License key string, this should be encoded as UTF-8.
Output	A JSON-formatted string containing the result of the activation Typically includes an "errorCode" field indicating the status of the activation. 0: Success Non-zero: Activation failed

### init\_sdk {% code overflow="wrap" %} ```python def init_sdk(dict_path: str) -> int: ``` {% endcode %}


Name	init_sdk
Description	Initializes the OCR engine with the required dictionary files.
Input	dict_path (str): Path to the engine binary files directory, This path must be provided as a UTF-8 encoded string.
Output	A JSON-formatted string containing the result of the initialization. Typically includes an "errorCode" field indicating the status of the initialization. 0: Success Non-zero: Initialization failed

### ocr\_id\_card {% code overflow="wrap" %} ```python def ocr_id_card(file_path1: str, file_path2: str) -> str ``` {% endcode %}


Name	ocr_id_card
Description	Extracts data from ID card
Input	file_path1 (str): The path to the front image file. file_path2 (str): The path to the back image file.
Output	A JSON-formatted string containing the OCR results.

#### Example of ID OCR results

```json { "mrz": { "givenNames":"JOHN", "name":"DOE JOHN", "dateOfExpiry":"2028-12-07", "documentClassCode":"ID", "nationality":"Ukraine", "surname":"DOE", "sex":"M", "dateOfBirth":"1964-09-02", "mrzCode":"IDUKR00235423491964090245614<<^6409029M2812070UKR<<<<<<<<<<<5^DOE< str: ```


Name	ocr_credit_card
Description	Etracts data from credit card
Input	file_path (str): The path to the credit card image file.
Output	A JSON-formatted string containing the OCR results.

### ocr\_barcode ``` def ocr_barcode(file_path: str) -> str: ```


Name	ocr_barcode
Description	Etracts data from barcode
Input	file_path (str): The path to the barcode image file.
Output	A JSON-formatted string containing the OCR results.

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.recognito.vision/id-document-recognition-sdk/integration-guide/linux/api-reference.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.