Scanbot C SDK Document data

Typedefs
typedef struct scanbotsdk_document_data_extractor_t	scanbotsdk_document_data_extractor_t
	scanbotsdk_document_data_extractor_t class
typedef struct scanbotsdk_document_data_extractor_configuration_element_t	scanbotsdk_document_data_extractor_configuration_element_t
	scanbotsdk_document_data_extractor_configuration_element_t class
typedef struct scanbotsdk_date_validation_configuration_t	scanbotsdk_date_validation_configuration_t
	scanbotsdk_date_validation_configuration_t class
typedef struct scanbotsdk_de_address_parser_configuration_t	scanbotsdk_de_address_parser_configuration_t
	scanbotsdk_de_address_parser_configuration_t class
typedef enum scanbotsdk_european_health_insurance_card_issuing_country_t	scanbotsdk_european_health_insurance_card_issuing_country_t
	scanbotsdk_european_health_insurance_card_issuing_country_t enum
typedef struct scanbotsdk_european_health_insurance_card_configuration_t	scanbotsdk_european_health_insurance_card_configuration_t
	scanbotsdk_european_health_insurance_card_configuration_t class
typedef struct scanbotsdk_mrz_fallback_configuration_t	scanbotsdk_mrz_fallback_configuration_t
	scanbotsdk_mrz_fallback_configuration_t class
typedef struct scanbotsdk_auto_focus_configuration_t	scanbotsdk_auto_focus_configuration_t
	scanbotsdk_auto_focus_configuration_t class
typedef struct scanbotsdk_glare_detection_configuration_t	scanbotsdk_glare_detection_configuration_t
	scanbotsdk_glare_detection_configuration_t class
typedef struct scanbotsdk_document_data_extractor_common_configuration_t	scanbotsdk_document_data_extractor_common_configuration_t
	scanbotsdk_document_data_extractor_common_configuration_t class
typedef enum scanbotsdk_document_data_extraction_status_t	scanbotsdk_document_data_extraction_status_t
	scanbotsdk_document_data_extraction_status_t enum
typedef struct scanbotsdk_document_data_extraction_result_t	scanbotsdk_document_data_extraction_result_t
	scanbotsdk_document_data_extraction_result_t class
typedef enum scanbotsdk_document_trust_mode_t	scanbotsdk_document_trust_mode_t
	scanbotsdk_document_trust_mode_t enum
typedef struct scanbotsdk_document_data_extractor_configuration_t	scanbotsdk_document_data_extractor_configuration_t
	scanbotsdk_document_data_extractor_configuration_t class
typedef enum scanbotsdk_value_consistency_t	scanbotsdk_value_consistency_t
	scanbotsdk_value_consistency_t enum
typedef struct scanbotsdk_field_consistency_verification_report_t	scanbotsdk_field_consistency_verification_report_t
	scanbotsdk_field_consistency_verification_report_t class
typedef struct scanbotsdk_consistency_verification_report_t	scanbotsdk_consistency_verification_report_t
	scanbotsdk_consistency_verification_report_t class
typedef enum scanbotsdk_value_semantics_t	scanbotsdk_value_semantics_t
	scanbotsdk_value_semantics_t enum
typedef struct scanbotsdk_field_value_semantics_t	scanbotsdk_field_value_semantics_t
	scanbotsdk_field_value_semantics_t class
typedef struct scanbotsdk_composite_field_value_semantics_t	scanbotsdk_composite_field_value_semantics_t
	scanbotsdk_composite_field_value_semantics_t class
typedef struct scanbotsdk_semantics_verification_report_t	scanbotsdk_semantics_verification_report_t
	scanbotsdk_semantics_verification_report_t class
typedef struct scanbotsdk_field_suspicious_data_verification_report_t	scanbotsdk_field_suspicious_data_verification_report_t
	scanbotsdk_field_suspicious_data_verification_report_t class
typedef struct scanbotsdk_suspicious_data_verification_report_t	scanbotsdk_suspicious_data_verification_report_t
	scanbotsdk_suspicious_data_verification_report_t class
typedef struct scanbotsdk_field_invalid_data_verification_report_t	scanbotsdk_field_invalid_data_verification_report_t
	scanbotsdk_field_invalid_data_verification_report_t class
typedef struct scanbotsdk_invalid_data_verification_report_t	scanbotsdk_invalid_data_verification_report_t
	scanbotsdk_invalid_data_verification_report_t class
typedef enum scanbotsdk_document_verification_status_t	scanbotsdk_document_verification_status_t
	scanbotsdk_document_verification_status_t enum
typedef struct scanbotsdk_document_verification_report_t	scanbotsdk_document_verification_report_t
	scanbotsdk_document_verification_report_t class

Enumerations
enum	scanbotsdk_european_health_insurance_card_issuing_country_t {   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_AUSTRIA = 0 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BELGIUM = 1 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BULGARIA = 2 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CROATIA = 3 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CYPRUS = 4 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CZECH_REPUBLIC = 5 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_DENMARK = 6 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ESTONIA = 7 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FINLAND = 8 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FRANCE = 9 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GERMANY = 10 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GREECE = 11 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_HUNGARY = 12 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_IRELAND = 13 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ITALY = 14 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LATVIA = 15 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LITHUANIA = 16 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LUXEMBOURG = 17 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_MALTA = 18 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_NETHERLANDS = 19 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_POLAND = 20 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_PORTUGAL = 21 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ROMANIA = 22 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVAKIA = 23 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVENIA = 24 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SPAIN = 25 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWEDEN = 26 ,   SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWITZERLAND = 27 }
	scanbotsdk_european_health_insurance_card_issuing_country_t enum More...
enum	scanbotsdk_document_data_extraction_status_t {   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK = 0 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_INVALID_DOCUMENT = 1 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_NOT_CONFIRMED = 2 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_SCANNING_IN_PROGRESS_STILL_FOCUSING = 3 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_NOTHING_FOUND = 4 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_BAD_CROP = 5 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNKNOWN_DOCUMENT = 6 ,   SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNACCEPTABLE_DOCUMENT = 7 }
	scanbotsdk_document_data_extraction_status_t enum More...
enum	scanbotsdk_document_trust_mode_t {   SCANBOTSDK_DOCUMENT_TRUST_MODE_TRUSTED = 0 ,   SCANBOTSDK_DOCUMENT_TRUST_MODE_UNTRUSTED = 1 }
	scanbotsdk_document_trust_mode_t enum More...
enum	scanbotsdk_value_consistency_t {   SCANBOTSDK_VALUE_CONSISTENCY_OK = 0 ,   SCANBOTSDK_VALUE_CONSISTENCY_OK_PUNCTUATION_UPPER_CASE_CLEANED = 1 ,   SCANBOTSDK_VALUE_CONSISTENCY_OK_DEBURRED = 2 ,   SCANBOTSDK_VALUE_CONSISTENCY_OK_DEBURRED_EXTENDED = 3 ,   SCANBOTSDK_VALUE_CONSISTENCY_OK_TRUNCATED = 4 ,   SCANBOTSDK_VALUE_CONSISTENCY_INCONSISTENT = 5 }
	scanbotsdk_value_consistency_t enum More...
enum	scanbotsdk_value_semantics_t {   SCANBOTSDK_VALUE_SEMANTICS_SKIPPED = 0 ,   SCANBOTSDK_VALUE_SEMANTICS_VALID = 1 ,   SCANBOTSDK_VALUE_SEMANTICS_INVALID = 2 }
	scanbotsdk_value_semantics_t enum More...
enum	scanbotsdk_document_verification_status_t {   SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_OK = 0 ,   SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_OK_WITH_WARNINGS = 1 ,   SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_INVALID = 2 }
	scanbotsdk_document_verification_status_t enum More...

Functions
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_create (scanbotsdk_document_data_extractor_configuration_t *configuration, scanbotsdk_document_data_extractor_t **result)
	Creates a new instance of scanbotsdk_document_data_extractor with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_free (scanbotsdk_document_data_extractor_t *self)
	Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_run (scanbotsdk_document_data_extractor_t *self, scanbotsdk_image_t *image, scanbotsdk_document_data_extraction_result_t **result)
	Recognize the document in the given image.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_clear_result (scanbotsdk_document_data_extractor_t *self)
	Clears the accumulated results. Should be called after a document has been recognized to the customers satisfaction to prevent a poisoned cache.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_verify_document (scanbotsdk_document_data_extractor_t *self, scanbotsdk_generic_document_t **document_parts, size_t document_parts_size, scanbotsdk_document_verification_report_t **result)
	Verify whether the extracted document has signs of forgery or tampering.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_free (scanbotsdk_document_data_extractor_configuration_element_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_configuration_element_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_create (int min_year, int max_year, const char *field_type_name, scanbotsdk_date_validation_configuration_t **result)
	Creates a new instance of scanbotsdk_date_validation_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_create_with_defaults (const char *field_type_name, scanbotsdk_date_validation_configuration_t **result)
	Creates a new instance of scanbotsdk_date_validation_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_free (scanbotsdk_date_validation_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_date_validation_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_date_validation_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_date_validation_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_date_validation_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_date_validation_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_date_validation_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_date_validation_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_date_validation_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_get_min_year (scanbotsdk_date_validation_configuration_t *self, int *min_year)
	Returns value of min_year field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_set_min_year (scanbotsdk_date_validation_configuration_t *self, int min_year)
	Sets value of min_year field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_get_max_year (scanbotsdk_date_validation_configuration_t *self, int *max_year)
	Returns value of max_year field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_set_max_year (scanbotsdk_date_validation_configuration_t *self, int max_year)
	Sets value of max_year field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_get_field_type_name (scanbotsdk_date_validation_configuration_t *self, const char **field_type_name)
	Returns value of field_type_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_date_validation_configuration_set_field_type_name (scanbotsdk_date_validation_configuration_t *self, const char *field_type_name)
	Sets value of field_type_name field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_create (const char **document_types, size_t document_types_size, const char *binary_file_address_database, scanbotsdk_de_address_parser_configuration_t **result)
	Creates a new instance of scanbotsdk_de_address_parser_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_create_with_defaults (const char **document_types, size_t document_types_size, scanbotsdk_de_address_parser_configuration_t **result)
	Creates a new instance of scanbotsdk_de_address_parser_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_free (scanbotsdk_de_address_parser_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_de_address_parser_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_de_address_parser_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_de_address_parser_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_de_address_parser_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_de_address_parser_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_de_address_parser_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_de_address_parser_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_de_address_parser_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_get_document_types (scanbotsdk_de_address_parser_configuration_t *self, const char **document_types, size_t size)
	Returns value of document_types field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_get_document_types_size (scanbotsdk_de_address_parser_configuration_t *self, size_t *size)
	Returns size of document_types array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_set_document_types (scanbotsdk_de_address_parser_configuration_t *self, const char **document_types, size_t document_types_size)
	Sets value of document_types field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_get_binary_file_address_database (scanbotsdk_de_address_parser_configuration_t *self, const char **binary_file_address_database)
	Returns value of binary_file_address_database field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_de_address_parser_configuration_set_binary_file_address_database (scanbotsdk_de_address_parser_configuration_t *self, const char *binary_file_address_database)
	Sets value of binary_file_address_database field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_issuing_country_t_to_string (scanbotsdk_european_health_insurance_card_issuing_country_t value, const char **result)
	Returns the string representation of the given scanbotsdk_european_health_insurance_card_issuing_country_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_create (scanbotsdk_european_health_insurance_card_issuing_country_t *expected_country, scanbotsdk_european_health_insurance_card_configuration_t **result)
	Creates a new instance of scanbotsdk_european_health_insurance_card_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_create_with_defaults (scanbotsdk_european_health_insurance_card_configuration_t **result)
	Creates a new instance of scanbotsdk_european_health_insurance_card_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_free (scanbotsdk_european_health_insurance_card_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_european_health_insurance_card_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_european_health_insurance_card_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_european_health_insurance_card_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_european_health_insurance_card_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_european_health_insurance_card_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_european_health_insurance_card_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_european_health_insurance_card_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_european_health_insurance_card_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_get_expected_country (scanbotsdk_european_health_insurance_card_configuration_t *self, scanbotsdk_european_health_insurance_card_issuing_country_t **expected_country)
	Returns value of expected_country field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_european_health_insurance_card_configuration_set_expected_country (scanbotsdk_european_health_insurance_card_configuration_t *self, scanbotsdk_european_health_insurance_card_issuing_country_t *expected_country)
	Sets value of expected_country field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_create (const char **accepted_countries, size_t accepted_countries_size, scanbotsdk_mrz_document_type_t *accepted_mrz_types, size_t accepted_mrz_types_size, scanbotsdk_mrz_fallback_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_fallback_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_create_with_defaults (scanbotsdk_mrz_fallback_configuration_t **result)
	Creates a new instance of scanbotsdk_mrz_fallback_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_free (scanbotsdk_mrz_fallback_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_mrz_fallback_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_mrz_fallback_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_mrz_fallback_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_mrz_fallback_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_mrz_fallback_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_mrz_fallback_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_mrz_fallback_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_mrz_fallback_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_get_accepted_countries (scanbotsdk_mrz_fallback_configuration_t *self, const char **accepted_countries, size_t size)
	Returns value of accepted_countries field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_get_accepted_countries_size (scanbotsdk_mrz_fallback_configuration_t *self, size_t *size)
	Returns size of accepted_countries array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_set_accepted_countries (scanbotsdk_mrz_fallback_configuration_t *self, const char **accepted_countries, size_t accepted_countries_size)
	Sets value of accepted_countries field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types (scanbotsdk_mrz_fallback_configuration_t *self, scanbotsdk_mrz_document_type_t **accepted_mrz_types)
	Returns value of accepted_mrz_types field of the given object. The returned value is direct view into memory, no pre-allocations needed.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types_size (scanbotsdk_mrz_fallback_configuration_t *self, size_t *size)
	Returns size of accepted_mrz_types array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_mrz_fallback_configuration_set_accepted_mrz_types (scanbotsdk_mrz_fallback_configuration_t *self, scanbotsdk_mrz_document_type_t *accepted_mrz_types, size_t accepted_mrz_types_size)
	Sets value of accepted_mrz_types field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_create (double sensitivity_threshold, scanbotsdk_auto_focus_configuration_t **result)
	Creates a new instance of scanbotsdk_auto_focus_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_create_with_defaults (scanbotsdk_auto_focus_configuration_t **result)
	Creates a new instance of scanbotsdk_auto_focus_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_free (scanbotsdk_auto_focus_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_auto_focus_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_auto_focus_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_auto_focus_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_auto_focus_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_auto_focus_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_auto_focus_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_auto_focus_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_auto_focus_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_get_sensitivity_threshold (scanbotsdk_auto_focus_configuration_t *self, double *sensitivity_threshold)
	Returns value of sensitivity_threshold field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_auto_focus_configuration_set_sensitivity_threshold (scanbotsdk_auto_focus_configuration_t *self, double sensitivity_threshold)
	Sets value of sensitivity_threshold field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_create (double glare_detection_threshold, scanbotsdk_glare_detection_configuration_t **result)
	Creates a new instance of scanbotsdk_glare_detection_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_create_with_defaults (scanbotsdk_glare_detection_configuration_t **result)
	Creates a new instance of scanbotsdk_glare_detection_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_free (scanbotsdk_glare_detection_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_glare_detection_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_glare_detection_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_glare_detection_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_glare_detection_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_glare_detection_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_glare_detection_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_glare_detection_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_glare_detection_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_get_glare_detection_threshold (scanbotsdk_glare_detection_configuration_t *self, double *glare_detection_threshold)
	Returns value of glare_detection_threshold field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_glare_detection_configuration_set_glare_detection_threshold (scanbotsdk_glare_detection_configuration_t *self, double glare_detection_threshold)
	Sets value of glare_detection_threshold field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_create (const char **accepted_document_types, size_t accepted_document_types_size, scanbotsdk_document_data_extractor_common_configuration_t **result)
	Creates a new instance of scanbotsdk_document_data_extractor_common_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_create_with_defaults (scanbotsdk_document_data_extractor_common_configuration_t **result)
	Creates a new instance of scanbotsdk_document_data_extractor_common_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_free (scanbotsdk_document_data_extractor_common_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_common_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_document_data_extractor_common_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, bool *result)
	Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_document_data_extractor_common_configuration_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_document_data_extractor_common_configuration (scanbotsdk_document_data_extractor_configuration_element_t *object, scanbotsdk_document_data_extractor_common_configuration_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_document_data_extractor_common_configuration_t. If the given instance is not an instance of the subtype, result will be null.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_as_scanbotsdk_document_data_extractor_configuration_element (scanbotsdk_document_data_extractor_common_configuration_t *object, scanbotsdk_document_data_extractor_configuration_element_t **result)
	Casts the given instance of scanbotsdk_document_data_extractor_common_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types (scanbotsdk_document_data_extractor_common_configuration_t *self, const char **accepted_document_types, size_t size)
	Returns value of accepted_document_types field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types_size (scanbotsdk_document_data_extractor_common_configuration_t *self, size_t *size)
	Returns size of accepted_document_types array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_common_configuration_set_accepted_document_types (scanbotsdk_document_data_extractor_common_configuration_t *self, const char **accepted_document_types, size_t accepted_document_types_size)
	Sets value of accepted_document_types field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_status_t_to_string (scanbotsdk_document_data_extraction_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_data_extraction_status_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_result_free (scanbotsdk_document_data_extraction_result_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_data_extraction_result_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_result_get_status (scanbotsdk_document_data_extraction_result_t *self, scanbotsdk_document_data_extraction_status_t *status)
	Returns value of status field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_result_get_document (scanbotsdk_document_data_extraction_result_t *self, scanbotsdk_generic_document_t **document)
	Returns value of document field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_result_get_document_detection_result (scanbotsdk_document_data_extraction_result_t *self, scanbotsdk_document_detection_result_t **document_detection_result)
	Returns value of document_detection_result field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extraction_result_get_cropped_image (scanbotsdk_document_data_extraction_result_t *self, scanbotsdk_image_t **cropped_image)
	Returns value of cropped_image field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_trust_mode_t_to_string (scanbotsdk_document_trust_mode_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_trust_mode_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_create (scanbotsdk_result_accumulation_configuration_t *result_accumulation_config, const char **field_exclude_list, size_t field_exclude_list_size, scanbotsdk_document_data_extractor_configuration_element_t **configurations, size_t configurations_size, bool return_crops, scanbotsdk_document_trust_mode_t document_trust_mode, scanbotsdk_processing_mode_t processing_mode, scanbotsdk_document_data_extractor_configuration_t **result)
	Creates a new instance of scanbotsdk_document_data_extractor_configuration with given params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_create_with_defaults (scanbotsdk_document_data_extractor_configuration_t **result)
	Creates a new instance of scanbotsdk_document_data_extractor_configuration_t with given required params and stores it in the location specified by the last argument.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_free (scanbotsdk_document_data_extractor_configuration_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_configuration_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_result_accumulation_config (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_result_accumulation_configuration_t **result_accumulation_config)
	Returns value of result_accumulation_config field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_result_accumulation_config (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_result_accumulation_configuration_t *result_accumulation_config)
	Sets value of result_accumulation_config field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_field_exclude_list (scanbotsdk_document_data_extractor_configuration_t *self, const char **field_exclude_list, size_t size)
	Returns value of field_exclude_list field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_field_exclude_list_size (scanbotsdk_document_data_extractor_configuration_t *self, size_t *size)
	Returns size of field_exclude_list array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_field_exclude_list (scanbotsdk_document_data_extractor_configuration_t *self, const char **field_exclude_list, size_t field_exclude_list_size)
	Sets value of field_exclude_list field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_configurations (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_document_data_extractor_configuration_element_t **configurations, size_t size)
	Returns value of configurations field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_configurations_size (scanbotsdk_document_data_extractor_configuration_t *self, size_t *size)
	Returns size of configurations array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_configurations (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_document_data_extractor_configuration_element_t **configurations, size_t configurations_size)
	Sets value of configurations field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_return_crops (scanbotsdk_document_data_extractor_configuration_t *self, bool *return_crops)
	Returns value of return_crops field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_return_crops (scanbotsdk_document_data_extractor_configuration_t *self, bool return_crops)
	Sets value of return_crops field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_document_trust_mode (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_document_trust_mode_t *document_trust_mode)
	Returns value of document_trust_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_document_trust_mode (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_document_trust_mode_t document_trust_mode)
	Sets value of document_trust_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_get_processing_mode (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_processing_mode_t *processing_mode)
	Returns value of processing_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_data_extractor_configuration_set_processing_mode (scanbotsdk_document_data_extractor_configuration_t *self, scanbotsdk_processing_mode_t processing_mode)
	Sets value of processing_mode field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_value_consistency_t_to_string (scanbotsdk_value_consistency_t value, const char **result)
	Returns the string representation of the given scanbotsdk_value_consistency_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_consistency_verification_report_free (scanbotsdk_field_consistency_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_consistency_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_consistency_verification_report_get_field_type (scanbotsdk_field_consistency_verification_report_t *self, scanbotsdk_common_field_type_t *field_type)
	Returns value of field_type field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_consistency_verification_report_get_consistency (scanbotsdk_field_consistency_verification_report_t *self, scanbotsdk_value_consistency_t *consistency)
	Returns value of consistency field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_consistency_verification_report_get_field_full_names (scanbotsdk_field_consistency_verification_report_t *self, const char **field_full_names, size_t size)
	Returns value of field_full_names field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_consistency_verification_report_get_field_full_names_size (scanbotsdk_field_consistency_verification_report_t *self, size_t *size)
	Returns size of field_full_names array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_consistency_verification_report_free (scanbotsdk_consistency_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_consistency_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_consistency_verification_report_get_overall_consistency (scanbotsdk_consistency_verification_report_t *self, scanbotsdk_value_consistency_t *overall_consistency)
	Returns value of overall_consistency field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_consistency_verification_report_get_field_details (scanbotsdk_consistency_verification_report_t *self, scanbotsdk_field_consistency_verification_report_t **field_details, size_t size)
	Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_consistency_verification_report_get_field_details_size (scanbotsdk_consistency_verification_report_t *self, size_t *size)
	Returns size of field_details array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_value_semantics_t_to_string (scanbotsdk_value_semantics_t value, const char **result)
	Returns the string representation of the given scanbotsdk_value_semantics_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_value_semantics_free (scanbotsdk_field_value_semantics_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_value_semantics_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_value_semantics_get_field_full_name (scanbotsdk_field_value_semantics_t *self, const char **field_full_name)
	Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_value_semantics_get_invalid_semantics (scanbotsdk_field_value_semantics_t *self, bool *invalid_semantics)
	Returns value of invalid_semantics field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_composite_field_value_semantics_free (scanbotsdk_composite_field_value_semantics_t *object)
	Frees the memory allocated for the instance of scanbotsdk_composite_field_value_semantics_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_composite_field_value_semantics_get_overall_field_value_semantics (scanbotsdk_composite_field_value_semantics_t *self, scanbotsdk_value_semantics_t *overall_field_value_semantics)
	Returns value of overall_field_value_semantics field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_composite_field_value_semantics_get_field_details (scanbotsdk_composite_field_value_semantics_t *self, scanbotsdk_field_value_semantics_t **field_details, size_t size)
	Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_composite_field_value_semantics_get_field_details_size (scanbotsdk_composite_field_value_semantics_t *self, size_t *size)
	Returns size of field_details array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_free (scanbotsdk_semantics_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_semantics_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_overall_invalid_semantics (scanbotsdk_semantics_verification_report_t *self, bool *overall_invalid_semantics)
	Returns value of overall_invalid_semantics field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_expiry_date_semantics (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_composite_field_value_semantics_t **expiry_date_semantics)
	Returns value of expiry_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_issue_date_semantics (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_composite_field_value_semantics_t **issue_date_semantics)
	Returns value of issue_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_birth_date_semantics (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_composite_field_value_semantics_t **birth_date_semantics)
	Returns value of birth_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_issue_date_before_expiry_date (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_value_semantics_t *issue_date_before_expiry_date)
	Returns value of issue_date_before_expiry_date field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_birth_date_before_issue_date (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_value_semantics_t *birth_date_before_issue_date)
	Returns value of birth_date_before_issue_date field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_semantics_verification_report_get_birth_date_before_expiry_date (scanbotsdk_semantics_verification_report_t *self, scanbotsdk_value_semantics_t *birth_date_before_expiry_date)
	Returns value of birth_date_before_expiry_date field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_suspicious_data_verification_report_free (scanbotsdk_field_suspicious_data_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_suspicious_data_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_suspicious_data_verification_report_get_field_full_name (scanbotsdk_field_suspicious_data_verification_report_t *self, const char **field_full_name)
	Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_suspicious_data_verification_report_get_is_suspicious (scanbotsdk_field_suspicious_data_verification_report_t *self, bool *is_suspicious)
	Returns value of is_suspicious field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_suspicious_data_verification_report_free (scanbotsdk_suspicious_data_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_suspicious_data_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_suspicious_data_verification_report_get_overall_suspicious_data (scanbotsdk_suspicious_data_verification_report_t *self, bool *overall_suspicious_data)
	Returns value of overall_suspicious_data field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_suspicious_data_verification_report_get_field_details (scanbotsdk_suspicious_data_verification_report_t *self, scanbotsdk_field_suspicious_data_verification_report_t **field_details, size_t size)
	Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_suspicious_data_verification_report_get_field_details_size (scanbotsdk_suspicious_data_verification_report_t *self, size_t *size)
	Returns size of field_details array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_invalid_data_verification_report_free (scanbotsdk_field_invalid_data_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_field_invalid_data_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_invalid_data_verification_report_get_field_full_name (scanbotsdk_field_invalid_data_verification_report_t *self, const char **field_full_name)
	Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_field_invalid_data_verification_report_get_is_invalid (scanbotsdk_field_invalid_data_verification_report_t *self, bool *is_invalid)
	Returns value of is_invalid field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_invalid_data_verification_report_free (scanbotsdk_invalid_data_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_invalid_data_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_invalid_data_verification_report_get_overall_is_invalid (scanbotsdk_invalid_data_verification_report_t *self, bool *overall_is_invalid)
	Returns value of overall_is_invalid field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_invalid_data_verification_report_get_field_details (scanbotsdk_invalid_data_verification_report_t *self, scanbotsdk_field_invalid_data_verification_report_t **field_details, size_t size)
	Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_invalid_data_verification_report_get_field_details_size (scanbotsdk_invalid_data_verification_report_t *self, size_t *size)
	Returns size of field_details array.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_status_t_to_string (scanbotsdk_document_verification_status_t value, const char **result)
	Returns the string representation of the given scanbotsdk_document_verification_status_t value.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_free (scanbotsdk_document_verification_report_t *object)
	Frees the memory allocated for the instance of scanbotsdk_document_verification_report_t. If null is passed, the function does nothing.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_get_overall_verification_status (scanbotsdk_document_verification_report_t *self, scanbotsdk_document_verification_status_t *overall_verification_status)
	Returns value of overall_verification_status field of the given object.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_get_consistency_verification_report (scanbotsdk_document_verification_report_t *self, scanbotsdk_consistency_verification_report_t **consistency_verification_report)
	Returns value of consistency_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_get_semantics_verification_report (scanbotsdk_document_verification_report_t *self, scanbotsdk_semantics_verification_report_t **semantics_verification_report)
	Returns value of semantics_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_get_suspicious_data_verification_report (scanbotsdk_document_verification_report_t *self, scanbotsdk_suspicious_data_verification_report_t **suspicious_data_verification_report)
	Returns value of suspicious_data_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.
SBSDK_API scanbotsdk_error_code_t	scanbotsdk_document_verification_report_get_invalid_data_verification_report (scanbotsdk_document_verification_report_t *self, scanbotsdk_invalid_data_verification_report_t **invalid_data_verification_report)
	Returns value of invalid_data_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Detailed Description

Typedef Documentation

scanbotsdk_auto_focus_configuration_t

typedef struct scanbotsdk_auto_focus_configuration_t scanbotsdk_auto_focus_configuration_t

scanbotsdk_auto_focus_configuration_t class

Auto-focus configuration. The recognizer will ignore frames that are not focused. This option is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

scanbotsdk_composite_field_value_semantics_t

typedef struct scanbotsdk_composite_field_value_semantics_t scanbotsdk_composite_field_value_semantics_t

scanbotsdk_composite_field_value_semantics_t class

Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.

scanbotsdk_consistency_verification_report_t

typedef struct scanbotsdk_consistency_verification_report_t scanbotsdk_consistency_verification_report_t

scanbotsdk_consistency_verification_report_t class

Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field is consistent.

scanbotsdk_date_validation_configuration_t

typedef struct scanbotsdk_date_validation_configuration_t scanbotsdk_date_validation_configuration_t

scanbotsdk_date_validation_configuration_t class

Date validation configuration. This configuration element does not enable the scanning of any document types by itself. Add to recognizer configuration to require date validation checks for specific document types.

scanbotsdk_de_address_parser_configuration_t

typedef struct scanbotsdk_de_address_parser_configuration_t scanbotsdk_de_address_parser_configuration_t

scanbotsdk_de_address_parser_configuration_t class

German Address Field validation configuration. This configuration does not enable the scanning of any document types by itself. Add to recognizer configuration to require German Address validation checks for specific document types.

scanbotsdk_document_data_extraction_result_t

typedef struct scanbotsdk_document_data_extraction_result_t scanbotsdk_document_data_extraction_result_t

scanbotsdk_document_data_extraction_result_t class

Contains the result of running the document data extractor.

scanbotsdk_document_data_extraction_status_t

typedef enum scanbotsdk_document_data_extraction_status_t scanbotsdk_document_data_extraction_status_t

scanbotsdk_document_data_extraction_status_t enum

The status of the extraction process.

scanbotsdk_document_data_extractor_common_configuration_t

typedef struct scanbotsdk_document_data_extractor_common_configuration_t scanbotsdk_document_data_extractor_common_configuration_t

scanbotsdk_document_data_extractor_common_configuration_t class

Convenience configuration element for enabling the scanning of multiple document types with a common configuration. Add to extractor configuration to enable the scanning of multiple document types.

scanbotsdk_document_data_extractor_configuration_element_t

typedef struct scanbotsdk_document_data_extractor_configuration_element_t scanbotsdk_document_data_extractor_configuration_element_t

scanbotsdk_document_data_extractor_configuration_element_t class

Base class for all document data extraction configuration elements.

scanbotsdk_document_data_extractor_configuration_t

typedef struct scanbotsdk_document_data_extractor_configuration_t scanbotsdk_document_data_extractor_configuration_t

scanbotsdk_document_data_extractor_configuration_t class

Configuration for the document data extractor.

scanbotsdk_document_data_extractor_t

typedef struct scanbotsdk_document_data_extractor_t scanbotsdk_document_data_extractor_t

scanbotsdk_document_data_extractor_t class

API for extracting data from documents.

scanbotsdk_document_trust_mode_t

typedef enum scanbotsdk_document_trust_mode_t scanbotsdk_document_trust_mode_t

scanbotsdk_document_trust_mode_t enum

Level of trust in the authenticity of the extracted document.

scanbotsdk_document_verification_report_t

typedef struct scanbotsdk_document_verification_report_t scanbotsdk_document_verification_report_t

scanbotsdk_document_verification_report_t class

Report of the document verification.

scanbotsdk_document_verification_status_t

typedef enum scanbotsdk_document_verification_status_t scanbotsdk_document_verification_status_t

scanbotsdk_document_verification_status_t enum

Overall status of the document verification.

scanbotsdk_european_health_insurance_card_configuration_t

typedef struct scanbotsdk_european_health_insurance_card_configuration_t scanbotsdk_european_health_insurance_card_configuration_t

scanbotsdk_european_health_insurance_card_configuration_t class

European Health Insurance Card (EHIC) configuration element. Add to extractor configuration to scan EHICs.

scanbotsdk_european_health_insurance_card_issuing_country_t

typedef enum scanbotsdk_european_health_insurance_card_issuing_country_t scanbotsdk_european_health_insurance_card_issuing_country_t

scanbotsdk_european_health_insurance_card_issuing_country_t enum

European Health Insurance Card (EHIC) issuing country.

scanbotsdk_field_consistency_verification_report_t

typedef struct scanbotsdk_field_consistency_verification_report_t scanbotsdk_field_consistency_verification_report_t

scanbotsdk_field_consistency_verification_report_t class

Report of the field consistency verification.

scanbotsdk_field_invalid_data_verification_report_t

typedef struct scanbotsdk_field_invalid_data_verification_report_t scanbotsdk_field_invalid_data_verification_report_t

scanbotsdk_field_invalid_data_verification_report_t class

Report which shows whether the data in the field that can be validated is valid.

scanbotsdk_field_suspicious_data_verification_report_t

typedef struct scanbotsdk_field_suspicious_data_verification_report_t scanbotsdk_field_suspicious_data_verification_report_t

scanbotsdk_field_suspicious_data_verification_report_t class

Report of the suspicious data field verification.

scanbotsdk_field_value_semantics_t

typedef struct scanbotsdk_field_value_semantics_t scanbotsdk_field_value_semantics_t

scanbotsdk_field_value_semantics_t class

Report of the field value semantics verification.

scanbotsdk_glare_detection_configuration_t

typedef struct scanbotsdk_glare_detection_configuration_t scanbotsdk_glare_detection_configuration_t

scanbotsdk_glare_detection_configuration_t class

Glare detection configuration. The recognizer will detect whether fields are obstructed by glare. This feature is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

scanbotsdk_invalid_data_verification_report_t

typedef struct scanbotsdk_invalid_data_verification_report_t scanbotsdk_invalid_data_verification_report_t

scanbotsdk_invalid_data_verification_report_t class

Report of the field validation verification.

scanbotsdk_mrz_fallback_configuration_t

typedef struct scanbotsdk_mrz_fallback_configuration_t scanbotsdk_mrz_fallback_configuration_t

scanbotsdk_mrz_fallback_configuration_t class

MRZ fallback configuration element. This configuration element does not enable the scanning of any document types by itself. Add to extractor configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported. Note that this may enable scanning of documents that were not enabled through the accepted document types.

scanbotsdk_semantics_verification_report_t

typedef struct scanbotsdk_semantics_verification_report_t scanbotsdk_semantics_verification_report_t

scanbotsdk_semantics_verification_report_t class

Report of the document value semantics verification.

scanbotsdk_suspicious_data_verification_report_t

typedef struct scanbotsdk_suspicious_data_verification_report_t scanbotsdk_suspicious_data_verification_report_t

scanbotsdk_suspicious_data_verification_report_t class

Report of the suspicious data document verification.

scanbotsdk_value_consistency_t

typedef enum scanbotsdk_value_consistency_t scanbotsdk_value_consistency_t

scanbotsdk_value_consistency_t enum

The status of the consistency verification.

scanbotsdk_value_semantics_t

typedef enum scanbotsdk_value_semantics_t scanbotsdk_value_semantics_t

scanbotsdk_value_semantics_t enum

The result of the value semantics verification.

Enumeration Type Documentation

scanbotsdk_document_data_extraction_status_t

enum scanbotsdk_document_data_extraction_status_t

scanbotsdk_document_data_extraction_status_t enum

The status of the extraction process.

Enumerator
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK	The document data was extracted.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_INVALID_DOCUMENT	The document data was extracted. Some fields in the document have failed validation, e.g. because the document is damaged, not authentic, or does not have all required fields.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_NOT_CONFIRMED	The document data was extracted. Some fields have not yet been confirmed.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_SCANNING_IN_PROGRESS_STILL_FOCUSING	Document data extraction in progress. Waiting for camera to finish focusing.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_NOTHING_FOUND	No document was detected.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_BAD_CROP	A document was detected at an angle or distance that would result in a poor quality crop.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNKNOWN_DOCUMENT	A document was detected, but it does not match any supported document format.
SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNACCEPTABLE_DOCUMENT	A supported document was detected, but it is unacceptable in the current configuration.

scanbotsdk_document_trust_mode_t

enum scanbotsdk_document_trust_mode_t

scanbotsdk_document_trust_mode_t enum

Level of trust in the authenticity of the extracted document.

Enumerator
SCANBOTSDK_DOCUMENT_TRUST_MODE_TRUSTED	The extracted document is trusted, i.e. the scanner may assume that it's authentic. This allows certain optimizations that make extraction faster.
SCANBOTSDK_DOCUMENT_TRUST_MODE_UNTRUSTED	The extracted document is not trusted, i.e. its authenticity cannot be assumed. All fields will be read out independently and can be further verified. Extracting untrusted documents takes slightly longer, as the extractor is not allowed to employ certain time-saving optimizations.

scanbotsdk_document_verification_status_t

enum scanbotsdk_document_verification_status_t

scanbotsdk_document_verification_status_t enum

Overall status of the document verification.

Enumerator
SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_OK	All the verifications passed successfully.
SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_OK_WITH_WARNINGS	No verifications failed, but some of them returned warnings.
SCANBOTSDK_DOCUMENT_VERIFICATION_STATUS_INVALID	At least one verification failed.

scanbotsdk_european_health_insurance_card_issuing_country_t

enum scanbotsdk_european_health_insurance_card_issuing_country_t

scanbotsdk_european_health_insurance_card_issuing_country_t enum

European Health Insurance Card (EHIC) issuing country.

Enumerator
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_AUSTRIA	Austria (Validation on the personal identification number is performed as described in "site:www.sozialversicherung.at Was ist die Versicherungsnummer?").
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BELGIUM	Belgium.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_BULGARIA	Bulgaria.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CROATIA	Croatia.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CYPRUS	Cyprus.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_CZECH_REPUBLIC	Czech Republic.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_DENMARK	Denmark.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ESTONIA	Estonia.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FINLAND	Finland.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_FRANCE	France.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GERMANY	Germany (Validation performed according to "Spezifikation für Musterkarten und Testkarten (eGK, HBA, SMC), Anhang A" and "GS1 Struktur der Kenn-Nummer (ICCSN) der elektronischen Gesundheitskarte").
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_GREECE	Greece.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_HUNGARY	Hungary.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_IRELAND	Ireland.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ITALY	Italy.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LATVIA	Latvia.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LITHUANIA	Lithuania.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_LUXEMBOURG	Luxembourg.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_MALTA	Malta.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_NETHERLANDS	Netherlands.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_POLAND	Poland.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_PORTUGAL	Portugal.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_ROMANIA	Romania.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVAKIA	Slovakia.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SLOVENIA	Slovenia.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SPAIN	Spain.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWEDEN	Sweden.
SCANBOTSDK_EUROPEAN_HEALTH_INSURANCE_CARD_ISSUING_COUNTRY_SWITZERLAND	Switzerland.

scanbotsdk_value_consistency_t

enum scanbotsdk_value_consistency_t

scanbotsdk_value_consistency_t enum

The status of the consistency verification.

Enumerator
SCANBOTSDK_VALUE_CONSISTENCY_OK	All values that correspond to the same logical field are exactly equal.
SCANBOTSDK_VALUE_CONSISTENCY_OK_PUNCTUATION_UPPER_CASE_CLEANED	All values that correspond to the same logical field are equal after punctuation is removed and all characters are converted to upper case.
SCANBOTSDK_VALUE_CONSISTENCY_OK_DEBURRED	All values that correspond to the same logical field are equal after punctuation is removed, all characters are converted to upper case and diacritics are replaced with their base characters.
SCANBOTSDK_VALUE_CONSISTENCY_OK_DEBURRED_EXTENDED	Same as OK_DEBURRED but allows replacing diacritics not only with their base characters but also with some more complex combinations. E.g., according to ICAO 9303 MRZ standard Ü can be replaced with U or UE or UXX.
SCANBOTSDK_VALUE_CONSISTENCY_OK_TRUNCATED	In addition to OK_DEBURRED_EXTENDED, allows one string to be a prefix of another string. Correctly works with complex diacritics replacements. In particular, if one string is MUEL and another is MÜLLER, then they are considered equal up to truncation.
SCANBOTSDK_VALUE_CONSISTENCY_INCONSISTENT	The values that correspond to the same logical field are inconsistent.

scanbotsdk_value_semantics_t

enum scanbotsdk_value_semantics_t

scanbotsdk_value_semantics_t enum

The result of the value semantics verification.

Enumerator
SCANBOTSDK_VALUE_SEMANTICS_SKIPPED	Verification of the value semantics was skipped. For example, because the field is empty.
SCANBOTSDK_VALUE_SEMANTICS_VALID	No errors were detected during semantics verification. For example, the date of birth is in the past, the date of expiry is in the future.
SCANBOTSDK_VALUE_SEMANTICS_INVALID	Semantically invalid value. For example, the date of birth is in the future, the date of expiry is in the past.

Function Documentation

scanbotsdk_auto_focus_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_auto_focus_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_auto_focus_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_auto_focus_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_auto_focus_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_create	(	double	sensitivity_threshold,
		scanbotsdk_auto_focus_configuration_t **	result )

Creates a new instance of scanbotsdk_auto_focus_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

sensitivity_threshold

Sensitivity threshold for detecting that autofocus is in progress. The value should be in the range [0.0, 1.0]. The lower the value, the more frames might be discarded as not focused. The higher the value, the earlier the focus might be considered as focused. If set to 0.0, the feature is disabled.

Default is 0.02

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_auto_focus_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_auto_focus_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_create_with_defaults

(

scanbotsdk_auto_focus_configuration_t **

result

)

Creates a new instance of scanbotsdk_auto_focus_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_auto_focus_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_auto_focus_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_free

(

scanbotsdk_auto_focus_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_auto_focus_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_auto_focus_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_auto_focus_configuration_get_sensitivity_threshold()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_get_sensitivity_threshold	(	scanbotsdk_auto_focus_configuration_t *	self,
		double *	sensitivity_threshold )

Returns value of sensitivity_threshold field of the given object.

Sensitivity threshold for detecting that autofocus is in progress. The value should be in the range [0.0, 1.0]. The lower the value, the more frames might be discarded as not focused. The higher the value, the earlier the focus might be considered as focused. If set to 0.0, the feature is disabled.

Default is 0.02

Parameters

self	Pointer to the instance of scanbotsdk_auto_focus_configuration_t
sensitivity_threshold	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_auto_focus_configuration_set_sensitivity_threshold()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_auto_focus_configuration_set_sensitivity_threshold	(	scanbotsdk_auto_focus_configuration_t *	self,
		double	sensitivity_threshold )

Sets value of sensitivity_threshold field of the given object.

Sensitivity threshold for detecting that autofocus is in progress. The value should be in the range [0.0, 1.0]. The lower the value, the more frames might be discarded as not focused. The higher the value, the earlier the focus might be considered as focused. If set to 0.0, the feature is disabled.

Default is 0.02

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_auto_focus_configuration_t, the field of which will be set
sensitivity_threshold	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_composite_field_value_semantics_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_composite_field_value_semantics_free

(

scanbotsdk_composite_field_value_semantics_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_composite_field_value_semantics_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_composite_field_value_semantics_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_composite_field_value_semantics_get_field_details()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_composite_field_value_semantics_get_field_details	(	scanbotsdk_composite_field_value_semantics_t *	self,
		scanbotsdk_field_value_semantics_t **	field_details,
		size_t	size )

Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of value semantics for each field corresponding to the same logical field.

Parameters

self	Pointer to the instance of scanbotsdk_composite_field_value_semantics_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_details	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_composite_field_value_semantics_get_field_details_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_composite_field_value_semantics_get_field_details_size	(	scanbotsdk_composite_field_value_semantics_t *	self,
		size_t *	size )

Returns size of field_details array.

Parameters

self	Pointer to the instance of scanbotsdk_composite_field_value_semantics_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_composite_field_value_semantics_get_overall_field_value_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_composite_field_value_semantics_get_overall_field_value_semantics	(	scanbotsdk_composite_field_value_semantics_t *	self,
		scanbotsdk_value_semantics_t *	overall_field_value_semantics )

Returns value of overall_field_value_semantics field of the given object.

Overall status of the logical value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If no fields are present, the overall status is SKIPPED.

Parameters

self	Pointer to the instance of scanbotsdk_composite_field_value_semantics_t
overall_field_value_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_consistency_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_free

(

scanbotsdk_consistency_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_consistency_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_consistency_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_consistency_verification_report_get_field_details()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_get_field_details	(	scanbotsdk_consistency_verification_report_t *	self,
		scanbotsdk_field_consistency_verification_report_t **	field_details,
		size_t	size )

Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of reports for each field that was verified.

Parameters

self	Pointer to the instance of scanbotsdk_consistency_verification_report_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_details	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_consistency_verification_report_get_field_details_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_get_field_details_size	(	scanbotsdk_consistency_verification_report_t *	self,
		size_t *	size )

Returns size of field_details array.

Parameters

self	Pointer to the instance of scanbotsdk_consistency_verification_report_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_consistency_verification_report_get_overall_consistency()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_get_overall_consistency	(	scanbotsdk_consistency_verification_report_t *	self,
		scanbotsdk_value_consistency_t *	overall_consistency )

Returns value of overall_consistency field of the given object.

Overall status of the consistency verification. Corresponds to the most severe status of all fields.

Parameters

self	Pointer to the instance of scanbotsdk_consistency_verification_report_t
overall_consistency	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_date_validation_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_date_validation_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_date_validation_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_date_validation_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_create	(	int	min_year,
		int	max_year,
		const char *	field_type_name,
		scanbotsdk_date_validation_configuration_t **	result )

Creates a new instance of scanbotsdk_date_validation_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

min_year

Minimum year that is considered valid.

Default is 0

Parameters

max_year

Maximum year that is considered valid.

Default is 2999

Parameters

field_type_name	Name, FullName, or NormalizedName of field type for which the year bounds should be applied. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_date_validation_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_create_with_defaults	(	const char *	field_type_name,
		scanbotsdk_date_validation_configuration_t **	result )

Creates a new instance of scanbotsdk_date_validation_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

field_type_name	Name, FullName, or NormalizedName of field type for which the year bounds should be applied. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_date_validation_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_free

(

scanbotsdk_date_validation_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_date_validation_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_date_validation_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_get_field_type_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_field_type_name	(	scanbotsdk_date_validation_configuration_t *	self,
		const char **	field_type_name )

Returns value of field_type_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Name, FullName, or NormalizedName of field type for which the year bounds should be applied.

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t
field_type_name	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_date_validation_configuration_get_max_year()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_max_year	(	scanbotsdk_date_validation_configuration_t *	self,
		int *	max_year )

Returns value of max_year field of the given object.

Maximum year that is considered valid.

Default is 2999

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t
max_year	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_date_validation_configuration_get_min_year()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_get_min_year	(	scanbotsdk_date_validation_configuration_t *	self,
		int *	min_year )

Returns value of min_year field of the given object.

Minimum year that is considered valid.

Default is 0

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t
min_year	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_date_validation_configuration_set_field_type_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_field_type_name	(	scanbotsdk_date_validation_configuration_t *	self,
		const char *	field_type_name )

Sets value of field_type_name field of the given object.

Name, FullName, or NormalizedName of field type for which the year bounds should be applied.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t, the field of which will be set
field_type_name	The value to be set. Must not be null.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_set_max_year()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_max_year	(	scanbotsdk_date_validation_configuration_t *	self,
		int	max_year )

Sets value of max_year field of the given object.

Maximum year that is considered valid.

Default is 2999

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t, the field of which will be set
max_year	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_date_validation_configuration_set_min_year()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_date_validation_configuration_set_min_year	(	scanbotsdk_date_validation_configuration_t *	self,
		int	min_year )

Sets value of min_year field of the given object.

Minimum year that is considered valid.

Default is 0

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_date_validation_configuration_t, the field of which will be set
min_year	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_de_address_parser_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_de_address_parser_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_de_address_parser_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_create	(	const char **	document_types,
		size_t	document_types_size,
		const char *	binary_file_address_database,
		scanbotsdk_de_address_parser_configuration_t **	result )

Creates a new instance of scanbotsdk_de_address_parser_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

document_types	List of generic document formats for which German Address validation has to be applied. Entries of the array must not be null.
document_types_size	Size of the array document_types
binary_file_address_database	binary file with address database.

Default is "" The value must not be null.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_de_address_parser_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_create_with_defaults	(	const char **	document_types,
		size_t	document_types_size,
		scanbotsdk_de_address_parser_configuration_t **	result )

Creates a new instance of scanbotsdk_de_address_parser_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

document_types	List of generic document formats for which German Address validation has to be applied. Entries of the array must not be null.
document_types_size	Size of the array document_types
result	Pointer to a variable that will store the created instance of scanbotsdk_de_address_parser_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_free

(

scanbotsdk_de_address_parser_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_de_address_parser_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_de_address_parser_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_get_binary_file_address_database()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_binary_file_address_database	(	scanbotsdk_de_address_parser_configuration_t *	self,
		const char **	binary_file_address_database )

Returns value of binary_file_address_database field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

binary file with address database.

Default is ""

Parameters

self	Pointer to the instance of scanbotsdk_de_address_parser_configuration_t
binary_file_address_database	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_de_address_parser_configuration_get_document_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_document_types	(	scanbotsdk_de_address_parser_configuration_t *	self,
		const char **	document_types,
		size_t	size )

Returns value of document_types field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of generic document formats for which German Address validation has to be applied.

Parameters

self	Pointer to the instance of scanbotsdk_de_address_parser_configuration_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
document_types	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_de_address_parser_configuration_get_document_types_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_get_document_types_size	(	scanbotsdk_de_address_parser_configuration_t *	self,
		size_t *	size )

Returns size of document_types array.

Parameters

self	Pointer to the instance of scanbotsdk_de_address_parser_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_de_address_parser_configuration_set_binary_file_address_database()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_set_binary_file_address_database	(	scanbotsdk_de_address_parser_configuration_t *	self,
		const char *	binary_file_address_database )

Sets value of binary_file_address_database field of the given object.

binary file with address database.

Default is ""

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_de_address_parser_configuration_t, the field of which will be set
binary_file_address_database	The value to be set. Must not be null.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_de_address_parser_configuration_set_document_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_de_address_parser_configuration_set_document_types	(	scanbotsdk_de_address_parser_configuration_t *	self,
		const char **	document_types,
		size_t	document_types_size )

Sets value of document_types field of the given object.

List of generic document formats for which German Address validation has to be applied.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_de_address_parser_configuration_t, the field of which will be set
document_types	The value to be set.
document_types_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extraction_result_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_free

(

scanbotsdk_document_data_extraction_result_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_document_data_extraction_result_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_document_data_extraction_result_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extraction_result_get_cropped_image()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_get_cropped_image	(	scanbotsdk_document_data_extraction_result_t *	self,
		scanbotsdk_image_t **	cropped_image )

Returns value of cropped_image field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Crop of the document if it was detected.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extraction_result_t
cropped_image	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extraction_result_get_document()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_get_document	(	scanbotsdk_document_data_extraction_result_t *	self,
		scanbotsdk_generic_document_t **	document )

Returns value of document field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

The extracted document.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extraction_result_t
document	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extraction_result_get_document_detection_result()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_get_document_detection_result	(	scanbotsdk_document_data_extraction_result_t *	self,
		scanbotsdk_document_detection_result_t **	document_detection_result )

Returns value of document_detection_result field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Result of the document detection in the input image.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extraction_result_t
document_detection_result	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extraction_result_get_status()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_get_status	(	scanbotsdk_document_data_extraction_result_t *	self,
		scanbotsdk_document_data_extraction_status_t *	status )

Returns value of status field of the given object.

The status of the extraction process.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extraction_result_t
status	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extraction_status_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_status_t_to_string	(	scanbotsdk_document_data_extraction_status_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_document_data_extraction_status_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_clear_result()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_clear_result

(

scanbotsdk_document_data_extractor_t *

self

)

Clears the accumulated results. Should be called after a document has been recognized to the customers satisfaction to prevent a poisoned cache.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_t method to be called on

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_common_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_document_data_extractor_common_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_common_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_document_data_extractor_common_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_common_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_create	(	const char **	accepted_document_types,
		size_t	accepted_document_types_size,
		scanbotsdk_document_data_extractor_common_configuration_t **	result )

Creates a new instance of scanbotsdk_document_data_extractor_common_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

accepted_document_types	List of document types to scan. By default, the list is empty. Entries of the array must not be null.
accepted_document_types_size	Size of the array accepted_document_types
result	Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_common_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_common_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_create_with_defaults

(

scanbotsdk_document_data_extractor_common_configuration_t **

result

)

Creates a new instance of scanbotsdk_document_data_extractor_common_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_common_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_common_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_free

(

scanbotsdk_document_data_extractor_common_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_common_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_document_data_extractor_common_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types	(	scanbotsdk_document_data_extractor_common_configuration_t *	self,
		const char **	accepted_document_types,
		size_t	size )

Returns value of accepted_document_types field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of document types to scan. By default, the list is empty.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_common_configuration_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
accepted_document_types	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_get_accepted_document_types_size	(	scanbotsdk_document_data_extractor_common_configuration_t *	self,
		size_t *	size )

Returns size of accepted_document_types array.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_common_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_common_configuration_set_accepted_document_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_common_configuration_set_accepted_document_types	(	scanbotsdk_document_data_extractor_common_configuration_t *	self,
		const char **	accepted_document_types,
		size_t	accepted_document_types_size )

Sets value of accepted_document_types field of the given object.

List of document types to scan. By default, the list is empty.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_common_configuration_t, the field of which will be set
accepted_document_types	The value to be set.
accepted_document_types_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_create	(	scanbotsdk_result_accumulation_configuration_t *	result_accumulation_config,
		const char **	field_exclude_list,
		size_t	field_exclude_list_size,
		scanbotsdk_document_data_extractor_configuration_element_t **	configurations,
		size_t	configurations_size,
		bool	return_crops,
		scanbotsdk_document_trust_mode_t	document_trust_mode,
		scanbotsdk_processing_mode_t	processing_mode,
		scanbotsdk_document_data_extractor_configuration_t **	result )

Creates a new instance of scanbotsdk_document_data_extractor_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result_accumulation_config	Configuration for how to accumulate results. The value must not be null.
field_exclude_list	Normalized names of the fields to exclude from the result. Entries of the array must not be null.
field_exclude_list_size	Size of the array field_exclude_list
configurations	List of configuration elements for the document data extractor. Entries of the array must not be null.
configurations_size	Size of the array configurations
return_crops	If true, crops of the detected documents and fields will be returned in the result.

Default is false

Parameters

document_trust_mode

Level of trust in the authenticity of the extracted document.

Default is TRUSTED

Parameters

processing_mode

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_create_with_defaults

(

scanbotsdk_document_data_extractor_configuration_t **

result

)

Creates a new instance of scanbotsdk_document_data_extractor_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_auto_focus_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_auto_focus_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_auto_focus_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_auto_focus_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_auto_focus_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_date_validation_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_date_validation_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_date_validation_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_date_validation_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_date_validation_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_de_address_parser_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_de_address_parser_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_de_address_parser_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_de_address_parser_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_de_address_parser_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_document_data_extractor_common_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_document_data_extractor_common_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_document_data_extractor_common_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_document_data_extractor_common_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_document_data_extractor_common_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_european_health_insurance_card_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_european_health_insurance_card_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_european_health_insurance_card_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_european_health_insurance_card_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_european_health_insurance_card_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_glare_detection_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_glare_detection_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_glare_detection_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_glare_detection_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_glare_detection_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_mrz_fallback_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_as_scanbotsdk_mrz_fallback_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		scanbotsdk_mrz_fallback_configuration_t **	result )

Casts the given instance of scanbotsdk_document_data_extractor_configuration_element_t to its subtype scanbotsdk_mrz_fallback_configuration_t. If the given instance is not an instance of the subtype, result will be null.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_mrz_fallback_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_free

(

scanbotsdk_document_data_extractor_configuration_element_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_configuration_element_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_auto_focus_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_auto_focus_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_auto_focus_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_date_validation_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_date_validation_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_date_validation_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_de_address_parser_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_de_address_parser_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_de_address_parser_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_document_data_extractor_common_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_document_data_extractor_common_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_document_data_extractor_common_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_european_health_insurance_card_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_european_health_insurance_card_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_european_health_insurance_card_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_glare_detection_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_glare_detection_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_glare_detection_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_mrz_fallback_configuration()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_element_is_scanbotsdk_mrz_fallback_configuration	(	scanbotsdk_document_data_extractor_configuration_element_t *	object,
		bool *	result )

Checks if the given instance of scanbotsdk_document_data_extractor_configuration_element_t is an instance of its subtype scanbotsdk_mrz_fallback_configuration_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be checked
result	Pointer to a variable that will store the result of the check

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_free

(

scanbotsdk_document_data_extractor_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_get_configurations()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_configurations	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_document_data_extractor_configuration_element_t **	configurations,
		size_t	size )

Returns value of configurations field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of configuration elements for the document data extractor.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
configurations	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_configurations_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_configurations_size	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		size_t *	size )

Returns size of configurations array.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_document_trust_mode()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_document_trust_mode	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_document_trust_mode_t *	document_trust_mode )

Returns value of document_trust_mode field of the given object.

Level of trust in the authenticity of the extracted document.

Default is TRUSTED

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
document_trust_mode	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_field_exclude_list()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_field_exclude_list	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		const char **	field_exclude_list,
		size_t	size )

Returns value of field_exclude_list field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Normalized names of the fields to exclude from the result.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_exclude_list	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_field_exclude_list_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_field_exclude_list_size	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		size_t *	size )

Returns size of field_exclude_list array.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_processing_mode()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_processing_mode	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_processing_mode_t *	processing_mode )

Returns value of processing_mode field of the given object.

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
processing_mode	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_result_accumulation_config()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_result_accumulation_config	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_result_accumulation_configuration_t **	result_accumulation_config )

Returns value of result_accumulation_config field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Configuration for how to accumulate results.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
result_accumulation_config	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_get_return_crops()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_return_crops	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		bool *	return_crops )

Returns value of return_crops field of the given object.

If true, crops of the detected documents and fields will be returned in the result.

Default is false

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t
return_crops	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_data_extractor_configuration_set_configurations()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_configurations	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_document_data_extractor_configuration_element_t **	configurations,
		size_t	configurations_size )

Sets value of configurations field of the given object.

List of configuration elements for the document data extractor.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
configurations	The value to be set.
configurations_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_set_document_trust_mode()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_document_trust_mode	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_document_trust_mode_t	document_trust_mode )

Sets value of document_trust_mode field of the given object.

Level of trust in the authenticity of the extracted document.

Default is TRUSTED

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
document_trust_mode	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_set_field_exclude_list()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_field_exclude_list	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		const char **	field_exclude_list,
		size_t	field_exclude_list_size )

Sets value of field_exclude_list field of the given object.

Normalized names of the fields to exclude from the result.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
field_exclude_list	The value to be set.
field_exclude_list_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_set_processing_mode()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_processing_mode	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_processing_mode_t	processing_mode )

Sets value of processing_mode field of the given object.

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default is AUTO

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
processing_mode	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_set_result_accumulation_config()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_result_accumulation_config	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		scanbotsdk_result_accumulation_configuration_t *	result_accumulation_config )

Sets value of result_accumulation_config field of the given object.

Configuration for how to accumulate results.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
result_accumulation_config	The value to be set. Must not be null.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_configuration_set_return_crops()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_return_crops	(	scanbotsdk_document_data_extractor_configuration_t *	self,
		bool	return_crops )

Sets value of return_crops field of the given object.

If true, crops of the detected documents and fields will be returned in the result.

Default is false

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_t, the field of which will be set
return_crops	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_create	(	scanbotsdk_document_data_extractor_configuration_t *	configuration,
		scanbotsdk_document_data_extractor_t **	result )

Creates a new instance of scanbotsdk_document_data_extractor with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

configuration	The configuration to use for the recognizer. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_free

(

scanbotsdk_document_data_extractor_t *

self

)

Frees the memory allocated for the instance of scanbotsdk_document_data_extractor_t. If null is passed, the function does nothing.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_run()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_run	(	scanbotsdk_document_data_extractor_t *	self,
		scanbotsdk_image_t *	image,
		scanbotsdk_document_data_extraction_result_t **	result )

Recognize the document in the given image.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_t method to be called on
image	The image to recognize. The value must not be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_data_extractor_verify_document()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_verify_document	(	scanbotsdk_document_data_extractor_t *	self,
		scanbotsdk_generic_document_t **	document_parts,
		size_t	document_parts_size,
		scanbotsdk_document_verification_report_t **	result )

Verify whether the extracted document has signs of forgery or tampering.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_document_data_extractor_t method to be called on
document_parts	The document parts to verify. For example, the front and back of an ID card. Entries of the array must not be null.
document_parts_size	Size of the array document_parts
result	Pointer to a variable that will store the created instance of scanbotsdk_document_data_extractor_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_trust_mode_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_trust_mode_t_to_string	(	scanbotsdk_document_trust_mode_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_document_trust_mode_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_free

(

scanbotsdk_document_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_document_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_document_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_document_verification_report_get_consistency_verification_report()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_get_consistency_verification_report	(	scanbotsdk_document_verification_report_t *	self,
		scanbotsdk_consistency_verification_report_t **	consistency_verification_report )

Returns value of consistency_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field and is present in different parts of the document is consistent.

Parameters

self	Pointer to the instance of scanbotsdk_document_verification_report_t
consistency_verification_report	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_report_get_invalid_data_verification_report()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_get_invalid_data_verification_report	(	scanbotsdk_document_verification_report_t *	self,
		scanbotsdk_invalid_data_verification_report_t **	invalid_data_verification_report )

Returns value of invalid_data_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Some fields in the documents allow validation, for example, MRZ contains check digits to verify the data. This report shows whether there are any invalid fields in the document.

Parameters

self	Pointer to the instance of scanbotsdk_document_verification_report_t
invalid_data_verification_report	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_report_get_overall_verification_status()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_get_overall_verification_status	(	scanbotsdk_document_verification_report_t *	self,
		scanbotsdk_document_verification_status_t *	overall_verification_status )

Returns value of overall_verification_status field of the given object.

Overall status of the document verification.

Parameters

self	Pointer to the instance of scanbotsdk_document_verification_report_t
overall_verification_status	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_report_get_semantics_verification_report()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_get_semantics_verification_report	(	scanbotsdk_document_verification_report_t *	self,
		scanbotsdk_semantics_verification_report_t **	semantics_verification_report )

Returns value of semantics_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Report of the semantics verification. Shows whether the values in the fields are semantically correct.

Parameters

self	Pointer to the instance of scanbotsdk_document_verification_report_t
semantics_verification_report	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_report_get_suspicious_data_verification_report()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_get_suspicious_data_verification_report	(	scanbotsdk_document_verification_report_t *	self,
		scanbotsdk_suspicious_data_verification_report_t **	suspicious_data_verification_report )

Returns value of suspicious_data_verification_report field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Shows whether the data in the document is suspicious, e.g. contains word "Sample" in the name.

Parameters

self	Pointer to the instance of scanbotsdk_document_verification_report_t
suspicious_data_verification_report	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_document_verification_status_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_status_t_to_string	(	scanbotsdk_document_verification_status_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_document_verification_status_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_european_health_insurance_card_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_european_health_insurance_card_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_european_health_insurance_card_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_european_health_insurance_card_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_european_health_insurance_card_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_create	(	scanbotsdk_european_health_insurance_card_issuing_country_t *	expected_country,
		scanbotsdk_european_health_insurance_card_configuration_t **	result )

Creates a new instance of scanbotsdk_european_health_insurance_card_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

expected_country	If an expected country is selected, validation rules for the given country are used, and if the expected country cannot be inferred or the inferred country doesn't match the given country, the result of extract() will be IncompleteValidation. The value can be null.
result	Pointer to a variable that will store the created instance of scanbotsdk_european_health_insurance_card_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_european_health_insurance_card_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_create_with_defaults

(

scanbotsdk_european_health_insurance_card_configuration_t **

result

)

Creates a new instance of scanbotsdk_european_health_insurance_card_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_european_health_insurance_card_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_european_health_insurance_card_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_free

(

scanbotsdk_european_health_insurance_card_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_european_health_insurance_card_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_european_health_insurance_card_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_european_health_insurance_card_configuration_get_expected_country()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_get_expected_country	(	scanbotsdk_european_health_insurance_card_configuration_t *	self,
		scanbotsdk_european_health_insurance_card_issuing_country_t **	expected_country )

Returns value of expected_country field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

If an expected country is selected, validation rules for the given country are used, and if the expected country cannot be inferred or the inferred country doesn't match the given country, the result of extract() will be IncompleteValidation.

Parameters

self	Pointer to the instance of scanbotsdk_european_health_insurance_card_configuration_t
expected_country	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_european_health_insurance_card_configuration_set_expected_country()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_configuration_set_expected_country	(	scanbotsdk_european_health_insurance_card_configuration_t *	self,
		scanbotsdk_european_health_insurance_card_issuing_country_t *	expected_country )

Sets value of expected_country field of the given object.

If an expected country is selected, validation rules for the given country are used, and if the expected country cannot be inferred or the inferred country doesn't match the given country, the result of extract() will be IncompleteValidation.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_european_health_insurance_card_configuration_t, the field of which will be set
expected_country	The value to be set. Can be null.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_european_health_insurance_card_issuing_country_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_european_health_insurance_card_issuing_country_t_to_string	(	scanbotsdk_european_health_insurance_card_issuing_country_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_european_health_insurance_card_issuing_country_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_consistency_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_free

(

scanbotsdk_field_consistency_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_field_consistency_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_field_consistency_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_field_consistency_verification_report_get_consistency()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_get_consistency	(	scanbotsdk_field_consistency_verification_report_t *	self,
		scanbotsdk_value_consistency_t *	consistency )

Returns value of consistency field of the given object.

The status of the consistency verification.

Parameters

self	Pointer to the instance of scanbotsdk_field_consistency_verification_report_t
consistency	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_consistency_verification_report_get_field_full_names()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_get_field_full_names	(	scanbotsdk_field_consistency_verification_report_t *	self,
		const char **	field_full_names,
		size_t	size )

Returns value of field_full_names field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Full names of the fields that were considered during the verification.

Parameters

self	Pointer to the instance of scanbotsdk_field_consistency_verification_report_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_full_names	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_consistency_verification_report_get_field_full_names_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_get_field_full_names_size	(	scanbotsdk_field_consistency_verification_report_t *	self,
		size_t *	size )

Returns size of field_full_names array.

Parameters

self	Pointer to the instance of scanbotsdk_field_consistency_verification_report_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_consistency_verification_report_get_field_type()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_get_field_type	(	scanbotsdk_field_consistency_verification_report_t *	self,
		scanbotsdk_common_field_type_t *	field_type )

Returns value of field_type field of the given object.

Logical field that is being verified.

Parameters

self	Pointer to the instance of scanbotsdk_field_consistency_verification_report_t
field_type	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_invalid_data_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_invalid_data_verification_report_free

(

scanbotsdk_field_invalid_data_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_field_invalid_data_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_field_invalid_data_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_field_invalid_data_verification_report_get_field_full_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_invalid_data_verification_report_get_field_full_name	(	scanbotsdk_field_invalid_data_verification_report_t *	self,
		const char **	field_full_name )

Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Full name of the field that was considered during the verification.

Parameters

self	Pointer to the instance of scanbotsdk_field_invalid_data_verification_report_t
field_full_name	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_invalid_data_verification_report_get_is_invalid()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_invalid_data_verification_report_get_is_invalid	(	scanbotsdk_field_invalid_data_verification_report_t *	self,
		bool *	is_invalid )

Returns value of is_invalid field of the given object.

Shows whether the data in the field is valid, e.g. if MRZ check digits are correct.

Parameters

self	Pointer to the instance of scanbotsdk_field_invalid_data_verification_report_t
is_invalid	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_suspicious_data_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_suspicious_data_verification_report_free

(

scanbotsdk_field_suspicious_data_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_field_suspicious_data_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_field_suspicious_data_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_field_suspicious_data_verification_report_get_field_full_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_suspicious_data_verification_report_get_field_full_name	(	scanbotsdk_field_suspicious_data_verification_report_t *	self,
		const char **	field_full_name )

Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Full name of the field that was considered during the verification.

Parameters

self	Pointer to the instance of scanbotsdk_field_suspicious_data_verification_report_t
field_full_name	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_suspicious_data_verification_report_get_is_suspicious()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_suspicious_data_verification_report_get_is_suspicious	(	scanbotsdk_field_suspicious_data_verification_report_t *	self,
		bool *	is_suspicious )

Returns value of is_suspicious field of the given object.

Shows whether the data in the field is suspicious, e.g. contains word "Sample" in the name.

Parameters

self	Pointer to the instance of scanbotsdk_field_suspicious_data_verification_report_t
is_suspicious	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_value_semantics_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_value_semantics_free

(

scanbotsdk_field_value_semantics_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_field_value_semantics_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_field_value_semantics_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_field_value_semantics_get_field_full_name()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_value_semantics_get_field_full_name	(	scanbotsdk_field_value_semantics_t *	self,
		const char **	field_full_name )

Returns value of field_full_name field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Full name of the field that was considered during the verification.

Parameters

self	Pointer to the instance of scanbotsdk_field_value_semantics_t
field_full_name	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_field_value_semantics_get_invalid_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_value_semantics_get_invalid_semantics	(	scanbotsdk_field_value_semantics_t *	self,
		bool *	invalid_semantics )

Returns value of invalid_semantics field of the given object.

Shows whether the data in the field is semantically invalid, e.g. the date of birth is in the future.

Parameters

self	Pointer to the instance of scanbotsdk_field_value_semantics_t
invalid_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_glare_detection_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_glare_detection_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_glare_detection_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_glare_detection_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_glare_detection_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_create	(	double	glare_detection_threshold,
		scanbotsdk_glare_detection_configuration_t **	result )

Creates a new instance of scanbotsdk_glare_detection_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

glare_detection_threshold

Glare detection threshold. The value should be in the range [0.0, 1.0]. Determines how much glare is acceptable relative to the text size. So 0.5 means that the glare can be up to 50% of the text size. If set to 0.0, the feature is disabled.

Default is 0.5

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_glare_detection_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_glare_detection_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_create_with_defaults

(

scanbotsdk_glare_detection_configuration_t **

result

)

Creates a new instance of scanbotsdk_glare_detection_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_glare_detection_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_glare_detection_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_free

(

scanbotsdk_glare_detection_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_glare_detection_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_glare_detection_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_glare_detection_configuration_get_glare_detection_threshold()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_get_glare_detection_threshold	(	scanbotsdk_glare_detection_configuration_t *	self,
		double *	glare_detection_threshold )

Returns value of glare_detection_threshold field of the given object.

Glare detection threshold. The value should be in the range [0.0, 1.0]. Determines how much glare is acceptable relative to the text size. So 0.5 means that the glare can be up to 50% of the text size. If set to 0.0, the feature is disabled.

Default is 0.5

Parameters

self	Pointer to the instance of scanbotsdk_glare_detection_configuration_t
glare_detection_threshold	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_glare_detection_configuration_set_glare_detection_threshold()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_glare_detection_configuration_set_glare_detection_threshold	(	scanbotsdk_glare_detection_configuration_t *	self,
		double	glare_detection_threshold )

Sets value of glare_detection_threshold field of the given object.

Glare detection threshold. The value should be in the range [0.0, 1.0]. Determines how much glare is acceptable relative to the text size. So 0.5 means that the glare can be up to 50% of the text size. If set to 0.0, the feature is disabled.

Default is 0.5

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_glare_detection_configuration_t, the field of which will be set
glare_detection_threshold	The value to be set.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_invalid_data_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_invalid_data_verification_report_free

(

scanbotsdk_invalid_data_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_invalid_data_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_invalid_data_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_invalid_data_verification_report_get_field_details()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_invalid_data_verification_report_get_field_details	(	scanbotsdk_invalid_data_verification_report_t *	self,
		scanbotsdk_field_invalid_data_verification_report_t **	field_details,
		size_t	size )

Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of reports for each field that was verified.

Parameters

self	Pointer to the instance of scanbotsdk_invalid_data_verification_report_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_details	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_invalid_data_verification_report_get_field_details_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_invalid_data_verification_report_get_field_details_size	(	scanbotsdk_invalid_data_verification_report_t *	self,
		size_t *	size )

Returns size of field_details array.

Parameters

self	Pointer to the instance of scanbotsdk_invalid_data_verification_report_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_invalid_data_verification_report_get_overall_is_invalid()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_invalid_data_verification_report_get_overall_is_invalid	(	scanbotsdk_invalid_data_verification_report_t *	self,
		bool *	overall_is_invalid )

Returns value of overall_is_invalid field of the given object.

Overall status of the document verification. Corresponds to the most severe status of all fields, i.e. if at least one field is invalid, the overall status is invalid.

Parameters

self	Pointer to the instance of scanbotsdk_invalid_data_verification_report_t
overall_is_invalid	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_mrz_fallback_configuration_as_scanbotsdk_document_data_extractor_configuration_element()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_as_scanbotsdk_document_data_extractor_configuration_element	(	scanbotsdk_mrz_fallback_configuration_t *	object,
		scanbotsdk_document_data_extractor_configuration_element_t **	result )

Casts the given instance of scanbotsdk_mrz_fallback_configuration_t to its parent type scanbotsdk_document_data_extractor_configuration_element_t.

Parameters

object	Pointer to the instance of scanbotsdk_document_data_extractor_configuration_element_t to be casted
result	Pointer to a variable that will store the casted instance of scanbotsdk_mrz_fallback_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_mrz_fallback_configuration_create()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_create	(	const char **	accepted_countries,
		size_t	accepted_countries_size,
		scanbotsdk_mrz_document_type_t *	accepted_mrz_types,
		size_t	accepted_mrz_types_size,
		scanbotsdk_mrz_fallback_configuration_t **	result )

Creates a new instance of scanbotsdk_mrz_fallback_configuration with given params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

accepted_countries	List of ISO 3166-1 alpha-3 country codes for which the MRZ fallback is enabled. (e.g. "DEU" for Germany). Entries of the array must not be null.
accepted_countries_size	Size of the array accepted_countries
accepted_mrz_types	List of MRZ document types for which MRZ fallback is enabled.
accepted_mrz_types_size	Size of the array accepted_mrz_types
result	Pointer to a variable that will store the created instance of scanbotsdk_mrz_fallback_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_mrz_fallback_configuration_create_with_defaults()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_create_with_defaults

(

scanbotsdk_mrz_fallback_configuration_t **

result

)

Creates a new instance of scanbotsdk_mrz_fallback_configuration_t with given required params and stores it in the location specified by the last argument.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

result

Pointer to a variable that will store the created instance of scanbotsdk_mrz_fallback_configuration_t

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_mrz_fallback_configuration_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_free

(

scanbotsdk_mrz_fallback_configuration_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_mrz_fallback_configuration_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_mrz_fallback_configuration_get_accepted_countries()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_countries	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		const char **	accepted_countries,
		size_t	size )

Returns value of accepted_countries field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of ISO 3166-1 alpha-3 country codes for which the MRZ fallback is enabled. (e.g. "DEU" for Germany).

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
accepted_countries	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_mrz_fallback_configuration_get_accepted_countries_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_countries_size	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		size_t *	size )

Returns size of accepted_countries array.

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		scanbotsdk_mrz_document_type_t **	accepted_mrz_types )

Returns value of accepted_mrz_types field of the given object. The returned value is direct view into memory, no pre-allocations needed.

List of MRZ document types for which MRZ fallback is enabled.

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t
accepted_mrz_types	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_get_accepted_mrz_types_size	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		size_t *	size )

Returns size of accepted_mrz_types array.

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_mrz_fallback_configuration_set_accepted_countries()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_set_accepted_countries	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		const char **	accepted_countries,
		size_t	accepted_countries_size )

Sets value of accepted_countries field of the given object.

List of ISO 3166-1 alpha-3 country codes for which the MRZ fallback is enabled. (e.g. "DEU" for Germany).

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t, the field of which will be set
accepted_countries	The value to be set.
accepted_countries_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_mrz_fallback_configuration_set_accepted_mrz_types()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_mrz_fallback_configuration_set_accepted_mrz_types	(	scanbotsdk_mrz_fallback_configuration_t *	self,
		scanbotsdk_mrz_document_type_t *	accepted_mrz_types,
		size_t	accepted_mrz_types_size )

Sets value of accepted_mrz_types field of the given object.

List of MRZ document types for which MRZ fallback is enabled.

As a rule if a function argument is a pointer to a scanbotsdk structure (scanbotsdk_..._t*) then the corresponding objects after function execution are left in valid but unspecified state, the caller is still responsible for freeing them. Exceptions are scanbotsdk_image_t*, scanbotdk_random_access_source_t* (if applicable) which are guaranteed to be in the original state.

Parameters

self	Pointer to the instance of scanbotsdk_mrz_fallback_configuration_t, the field of which will be set
accepted_mrz_types	The value to be set.
accepted_mrz_types_size	Size of the array.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_semantics_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_free

(

scanbotsdk_semantics_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_semantics_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_semantics_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_semantics_verification_report_get_birth_date_before_expiry_date()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_birth_date_before_expiry_date	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_value_semantics_t *	birth_date_before_expiry_date )

Returns value of birth_date_before_expiry_date field of the given object.

Result of verification whether the birth date is before the expiry date.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
birth_date_before_expiry_date	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_birth_date_before_issue_date()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_birth_date_before_issue_date	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_value_semantics_t *	birth_date_before_issue_date )

Returns value of birth_date_before_issue_date field of the given object.

Result of verification whether the birth date is before the issue date.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
birth_date_before_issue_date	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_birth_date_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_birth_date_semantics	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_composite_field_value_semantics_t **	birth_date_semantics )

Returns value of birth_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Status of the birth date semantics verification. Shows whether the birth date in the document is in the past.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
birth_date_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_expiry_date_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_expiry_date_semantics	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_composite_field_value_semantics_t **	expiry_date_semantics )

Returns value of expiry_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Status of the expiry date semantics verification. Shows whether the expiry date in the document is in the future.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
expiry_date_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_issue_date_before_expiry_date()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_issue_date_before_expiry_date	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_value_semantics_t *	issue_date_before_expiry_date )

Returns value of issue_date_before_expiry_date field of the given object.

Result of verification whether the issue date is before the expiry date.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
issue_date_before_expiry_date	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_issue_date_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_issue_date_semantics	(	scanbotsdk_semantics_verification_report_t *	self,
		scanbotsdk_composite_field_value_semantics_t **	issue_date_semantics )

Returns value of issue_date_semantics field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

Status of the issue date semantics verification. Shows whether the issue date in the document is in the past.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
issue_date_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_semantics_verification_report_get_overall_invalid_semantics()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_overall_invalid_semantics	(	scanbotsdk_semantics_verification_report_t *	self,
		bool *	overall_invalid_semantics )

Returns value of overall_invalid_semantics field of the given object.

Overall status of the value semantics verification. Corresponds to the most severe status of all fields, i.e. if at least one field is semantically incorrect, the overall status is semantically incorrect. If some verifications are skipped, they do not impact the overall status.

Parameters

self	Pointer to the instance of scanbotsdk_semantics_verification_report_t
overall_invalid_semantics	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_suspicious_data_verification_report_free()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_suspicious_data_verification_report_free

(

scanbotsdk_suspicious_data_verification_report_t *

object

)

Frees the memory allocated for the instance of scanbotsdk_suspicious_data_verification_report_t. If null is passed, the function does nothing.

Parameters

object

Pointer to the instance of scanbotsdk_suspicious_data_verification_report_t to be freed

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered

scanbotsdk_suspicious_data_verification_report_get_field_details()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_suspicious_data_verification_report_get_field_details	(	scanbotsdk_suspicious_data_verification_report_t *	self,
		scanbotsdk_field_suspicious_data_verification_report_t **	field_details,
		size_t	size )

Returns value of field_details field of the given object. The returned pointers do NOT own the underlying object, caller must not free them.

List of reports for each field that was verified.

Parameters

self	Pointer to the instance of scanbotsdk_suspicious_data_verification_report_t
size	Size of the pre-allocated array. Must be equal to the size obtained by calling the corresponding _size function.
field_details	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_suspicious_data_verification_report_get_field_details_size()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_suspicious_data_verification_report_get_field_details_size	(	scanbotsdk_suspicious_data_verification_report_t *	self,
		size_t *	size )

Returns size of field_details array.

Parameters

self	Pointer to the instance of scanbotsdk_suspicious_data_verification_report_t
size	Pointer to a variable that will store the size.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_suspicious_data_verification_report_get_overall_suspicious_data()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_suspicious_data_verification_report_get_overall_suspicious_data	(	scanbotsdk_suspicious_data_verification_report_t *	self,
		bool *	overall_suspicious_data )

Returns value of overall_suspicious_data field of the given object.

Overall status of the suspicious data verification. Corresponds to the most severe status of all fields, i.e. if at least one field is suspicious, the overall status is suspicious.

Parameters

self	Pointer to the instance of scanbotsdk_suspicious_data_verification_report_t
overall_suspicious_data	Pointer to a variable that will store the value of the field.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_value_consistency_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_value_consistency_t_to_string	(	scanbotsdk_value_consistency_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_value_consistency_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.

scanbotsdk_value_semantics_t_to_string()

SBSDK_API scanbotsdk_error_code_t scanbotsdk_value_semantics_t_to_string	(	scanbotsdk_value_semantics_t	value,
		const char **	result )

Returns the string representation of the given scanbotsdk_value_semantics_t value.

The returned string doesn't need to be freed.

Parameters

value	The value to be converted to string.
result	Pointer to a variable that will store the string representation of the value.

Returns

: Error code, SCANBOTSDK_OK if no errors were encountered.