com.yoti.api.client.docs.session.create.task.RequestedIdDocTextExtractionTaskConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yoti-sdk-api Show documentation

Java SDK for simple integration with the Yoti platform

The newest version!

package com.yoti.api.client.docs.session.create.task;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * The configuration applied when creating each TextExtractionTask
 */
public class RequestedIdDocTextExtractionTaskConfig implements RequestedTaskConfig {

    @JsonProperty("manual_check")
    private final String manualCheck;

    @JsonProperty("chip_data")
    private final String chipData;

    @JsonProperty("create_expanded_document_fields")
    private final Boolean createExpandedDocumentFields;

    RequestedIdDocTextExtractionTaskConfig(String manualCheck, String chipData, Boolean createExpandedDocumentFields) {
        this.manualCheck = manualCheck;
        this.chipData = chipData;
        this.createExpandedDocumentFields = createExpandedDocumentFields;
    }

    /**
     * Describes the manual fallback behaviour applied to each Task
     *
     * @return the manual check value
     */
    public String getManualCheck() {
        return manualCheck;
    }

    /**
     * Describes how to use chip data from an ID document if
     * it is available
     *
     * @return the chip data usage
     */
    public String getChipData() {
        return chipData;
    }

    /**
     * Describes whether or not expanded document fields should be created as part of text extraction
     *
     * @return whether to create expanded document fields
     */
    public Boolean getCreateExpandedDocumentFields() {
        return createExpandedDocumentFields;
    }

}