Main.java

package com.regula.documentreader.webclient.example;


import static com.regula.documentreader.webclient.model.TextFieldType.DOCUMENT_NUMBER;

import com.regula.documentreader.webclient.ApiClient;
import com.regula.documentreader.webclient.ApiException;
import com.regula.documentreader.webclient.api.DocumentReaderApi;
import com.regula.documentreader.webclient.model.CheckResult;
import com.regula.documentreader.webclient.model.GraphicFieldType;
import com.regula.documentreader.webclient.model.LexicalAnalysisResult;
import com.regula.documentreader.webclient.model.Light;
import com.regula.documentreader.webclient.model.ProcessParams;
import com.regula.documentreader.webclient.model.Result;
import com.regula.documentreader.webclient.model.Scenario;
import com.regula.documentreader.webclient.model.Source;
import com.regula.documentreader.webclient.model.TextField;
import com.regula.documentreader.webclient.model.ext.ProcessRequestImage;
import com.regula.documentreader.webclient.model.ext.RecognitionRequest;
import com.regula.documentreader.webclient.model.ext.RecognitionResponse;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;

import javax.annotation.Nullable;

public class Main {
    public static final String API_BASE_PATH = "API_BASE_PATH";

    public static void main(String[] args) throws IOException, ApiException {

        var apiBaseUrl = System.getenv(API_BASE_PATH);
        if (apiBaseUrl == null) {
            apiBaseUrl = "https://api.regulaforensics.com";
        }

        byte[] whitePage0 = readFile("WHITE.jpg");

        var whitePageRequestImage = new ProcessRequestImage(whitePage0, Light.WHITE, 0);

        var requestParams = new ProcessParams()
                .scenario(Scenario.FULL_PROCESS)
                .resultTypeOutput(
                        Arrays.asList(
                                // actual results
                                Result.STATUS, Result.TEXT, Result.IMAGES,
                                Result.DOCUMENT_TYPE, Result.DOCUMENT_TYPE_CANDIDATES, Result.IMAGE_QUALITY,
                                Result.DOCUMENT_POSITION,
                                // legacy results
                                Result.MRZ_TEXT, Result.VISUAL_TEXT, Result.BARCODE_TEXT, Result.RFID_TEXT,
                                Result.VISUAL_GRAPHICS, Result.BARCODE_GRAPHICS, Result.RFID_GRAPHICS,
                                Result.LEXICAL_ANALYSIS
                        )
                )
                .alreadyCropped(true);

        RecognitionRequest request = new RecognitionRequest(requestParams, List.of(whitePageRequestImage));

        String finalApiBaseUrl = apiBaseUrl;

        var apiClient = new ApiClient();
        apiClient.setBasePath(finalApiBaseUrl);
        // Set headers
//        apiClient.addDefaultHeader("Header", "value");

        var api = new DocumentReaderApi(apiClient);

        var info = api.health();
        System.out.println();
        System.out.format(
                "-----------------------------------------------------------------" + "\n"
                        + "Web API version: " + info.getVersion() + "\n"
                        + "-----------------------------------------------------------------");
        RecognitionResponse response = api.process(request);
        var requestJson = request.json();
        var responseJson = response.json();

        // to send raw request(ex encrypted one) with overriding processing params here use next api
        // RecognitionResponse response = api.process(request, requestParams);

        var status = response.status();
        var docOverallStatus = status.getOverallStatus() == CheckResult.OK ? "valid" : "not valid";
        var docOpticalTextStatus = status.getDetailsOptical().getText();

        var docType = response.documentType() == null ? "Unknown" : response.documentType().getDocumentName();

        var docNumberField = response.text().getField(DOCUMENT_NUMBER);
        var docNumberFieldByName = response.text().getField("Document Number");

        var docNumberVisual = docNumberField.getValue(Source.VISUAL);
        var docNumberMrz = docNumberField.getValue(Source.MRZ);
        var docNumberVisualValidity = docNumberField.sourceValidity(Source.VISUAL);
        var docNumberMrzValidity = docNumberField.sourceValidity(Source.MRZ);
        var docNumberMrzVisualMatching = docNumberField.crossSourceComparison(Source.MRZ, Source.VISUAL);

        System.out.println();
        System.out.format("-----------------------------------------------------------------" + "\n"
                + "Document Type: " + docType + "\n"
                + "Document Overall Status: " + docOverallStatus + "\n"
                + "Document Number Visual: " + docNumberVisual + "\n"
                + "Document Number MRZ: " + docNumberMrz + "\n"
                + "Validity Of Document Number Visual: " + docNumberVisualValidity + "\n"
                + "Validity Of Document Number MRZ: " + docNumberMrzValidity + "\n"
                + "MRZ-Visual values comparison: " + docNumberMrzVisualMatching + "\n"
                + "-----------------------------------------------------------------");
        System.out.println();

        if (response.text() != null) {
            for (TextField field : response.text().getFieldList()) {
                System.out.format(
                        "Field: " + " "
                                + field.getFieldName() + " "
                                + "Value: " + " "
                                + field.getValueList().get(0).getValue() + " "
                                + "Source: " + field.getValueList().get(0).getSource()
                                + "\n");
            }
            System.out.format("---------------------------------------------------------------");
        } else {
            System.out.format("                       NO TEXT DATA");
            System.out.format("---------------------------------------------------------------");
        }

        var documentImage = response.images().getField(GraphicFieldType.DOCUMENT_FRONT).getValue();
        var portraitField = response.images().getField(GraphicFieldType.PORTRAIT);
        var portraitFromVisual = portraitField != null ? portraitField.getValue(Source.VISUAL) : null;

        if (documentImage != null) {
            try {
                saveFile("document-image.jpg", documentImage);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }
        if (portraitFromVisual != null) {
            try {
                saveFile("portrait.jpg", portraitFromVisual);
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        }

        // how to get low lvl individual results
        LexicalAnalysisResult lexResult = response.resultByType(Result.LEXICAL_ANALYSIS);
    }

    @Nullable
    private static byte[] readFile(String filePath) throws IOException {
        var inputStream = Main.class.getClassLoader().getResourceAsStream(filePath);
        if (inputStream != null) {
            return inputStream.readAllBytes();
        }
        return null;
    }

    private static void saveFile(String filePath, byte[] data) throws IOException {
        Files.write(Path.of(filePath), data);
    }
}