ScanbotSDKDocumentDataExtractorTypes.h

Go to the documentation of this file.

// Auto-generated with ScanbotSDKCodegenV3. Modifications will be overwritten.
// Generated from SchemasV3/CoreSchemas/schemas/DocumentDataExtractorTypes.yaml
 
#pragma once
#ifndef SCANBOTSDK_DOCUMENTDATAEXTRACTORTYPES_H
#define SCANBOTSDK_DOCUMENTDATAEXTRACTORTYPES_H
 
 
#include <ScanbotSDKImage.h>
#include <ScanbotSDKTypes.h>
#include <common/ScanbotSDKCommonTypes.h>
#include <document_data/ScanbotSDKDocumentDataExtractorConfigurationTypes.h>
#include <document_scanner/ScanbotSDKDocumentScannerTypes.h>
#include <frame_accumulation/ScanbotSDKFrameAccumulationTypes.h>
#include <generic_document/ScanbotSDKCommonFieldType.h>
#include <generic_document/ScanbotSDKGenericDocument.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <ScanbotSDKErrorCode.h>
#include <ScanbotSDKDefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 

typedef enum scanbotsdk_document_data_extraction_status_t {

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK = 0,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_LOW_CONFIDENCE_RESULTS = 1,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_OK_BUT_INVALID_DOCUMENT = 2,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_SCANNING_IN_PROGRESS = 3,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_SCANNING_IN_PROGRESS_STILL_FOCUSING = 4,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_NOTHING_FOUND = 5,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_BAD_CROP = 6,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNKNOWN_DOCUMENT = 7,

    SCANBOTSDK_DOCUMENT_DATA_EXTRACTION_STATUS_ERROR_UNACCEPTABLE_DOCUMENT = 8,
 
} scanbotsdk_document_data_extraction_status_t;

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

typedef struct scanbotsdk_document_data_extraction_result_t scanbotsdk_document_data_extraction_result_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extraction_result_free(scanbotsdk_document_data_extraction_result_t* object);

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);

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);

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);

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);
 

typedef enum scanbotsdk_document_trust_mode_t {

    SCANBOTSDK_DOCUMENT_TRUST_MODE_TRUSTED = 0,

    SCANBOTSDK_DOCUMENT_TRUST_MODE_UNTRUSTED = 1,
 
} scanbotsdk_document_trust_mode_t;

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

typedef struct scanbotsdk_document_data_extractor_configuration_t scanbotsdk_document_data_extractor_configuration_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_create(
    scanbotsdk_result_accumulation_configuration_t* result_accumulation_config,
    scanbotsdk_u8string_ref_t* 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);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_create_with_defaults(
    scanbotsdk_document_data_extractor_configuration_t** result);
 

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_free(scanbotsdk_document_data_extractor_configuration_t* object);

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);
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);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_field_exclude_list(scanbotsdk_document_data_extractor_configuration_t* self, scanbotsdk_u8string_ref_t* field_exclude_list, size_t 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);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_set_field_exclude_list(scanbotsdk_document_data_extractor_configuration_t* self, scanbotsdk_u8string_ref_t* field_exclude_list, size_t field_exclude_list_size);

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);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_configurations_size(scanbotsdk_document_data_extractor_configuration_t* self, size_t* size);
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);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_data_extractor_configuration_get_return_crops(scanbotsdk_document_data_extractor_configuration_t* self, bool* 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);

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);
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);

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);
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);
 

typedef 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;

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

typedef struct scanbotsdk_field_consistency_verification_report_t scanbotsdk_field_consistency_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_free(scanbotsdk_field_consistency_verification_report_t* object);

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);

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);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_consistency_verification_report_get_field_full_names(scanbotsdk_field_consistency_verification_report_t* self, scanbotsdk_u8string_ref_t* field_full_names, size_t 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);
 

typedef struct scanbotsdk_consistency_verification_report_t scanbotsdk_consistency_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_free(scanbotsdk_consistency_verification_report_t* object);

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);

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);
SBSDK_API scanbotsdk_error_code_t scanbotsdk_consistency_verification_report_get_field_details_size(scanbotsdk_consistency_verification_report_t* self, size_t* size);
 

typedef enum scanbotsdk_value_semantics_t {

    SCANBOTSDK_VALUE_SEMANTICS_SKIPPED = 0,

    SCANBOTSDK_VALUE_SEMANTICS_VALID = 1,

    SCANBOTSDK_VALUE_SEMANTICS_INVALID = 2,
 
} scanbotsdk_value_semantics_t;

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

typedef struct scanbotsdk_field_value_semantics_t scanbotsdk_field_value_semantics_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_value_semantics_free(scanbotsdk_field_value_semantics_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_value_semantics_get_field_full_name(scanbotsdk_field_value_semantics_t* self, scanbotsdk_u8string_ref_t* field_full_name);

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

typedef struct scanbotsdk_composite_field_value_semantics_t scanbotsdk_composite_field_value_semantics_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_composite_field_value_semantics_free(scanbotsdk_composite_field_value_semantics_t* object);

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);

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);
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);
 

typedef struct scanbotsdk_semantics_verification_report_t scanbotsdk_semantics_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_free(scanbotsdk_semantics_verification_report_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_semantics_verification_report_get_overall_invalid_semantics(scanbotsdk_semantics_verification_report_t* self, bool* overall_invalid_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);

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);

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);

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);

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);

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);
 

typedef struct scanbotsdk_field_suspicious_data_verification_report_t scanbotsdk_field_suspicious_data_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_suspicious_data_verification_report_free(scanbotsdk_field_suspicious_data_verification_report_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_suspicious_data_verification_report_get_field_full_name(scanbotsdk_field_suspicious_data_verification_report_t* self, scanbotsdk_u8string_ref_t* field_full_name);

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);
 

typedef struct scanbotsdk_suspicious_data_verification_report_t scanbotsdk_suspicious_data_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_suspicious_data_verification_report_free(scanbotsdk_suspicious_data_verification_report_t* object);

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);

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);
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);
 

typedef struct scanbotsdk_field_invalid_data_verification_report_t scanbotsdk_field_invalid_data_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_invalid_data_verification_report_free(scanbotsdk_field_invalid_data_verification_report_t* object);

SBSDK_API scanbotsdk_error_code_t scanbotsdk_field_invalid_data_verification_report_get_field_full_name(scanbotsdk_field_invalid_data_verification_report_t* self, scanbotsdk_u8string_ref_t* field_full_name);

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);
 

typedef struct scanbotsdk_invalid_data_verification_report_t scanbotsdk_invalid_data_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_invalid_data_verification_report_free(scanbotsdk_invalid_data_verification_report_t* object);

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);

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);
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);
 

typedef 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;

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

typedef struct scanbotsdk_document_verification_report_t scanbotsdk_document_verification_report_t;

SBSDK_API scanbotsdk_error_code_t scanbotsdk_document_verification_report_free(scanbotsdk_document_verification_report_t* object);

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);

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);

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);

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);

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);
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SCANBOTSDK_DOCUMENTDATAEXTRACTORTYPES_H */