SDK-2668: Add support for report_template property, when configuring check results in the sandbox

MrBurtyyy · MrBurtyyy · commit c34dd73b736a · 2025-09-19T12:20:36.000+01:00
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCheck.java
@@ -29,6 +29,7 @@ static abstract class Builder<T extends Builder<T>> {
 
         protected SandboxRecommendation recommendation;
         protected List<SandboxBreakdown> breakdown = new ArrayList<>();
+        protected String reportTemplate;
 
         public T withRecommendation(SandboxRecommendation recommendation) {
             this.recommendation = recommendation;
@@ -46,6 +47,11 @@ public T withBreakdowns(List<SandboxBreakdown> breakdowns) {
             return self();
         }
 
+        public T withReportTemplate(String reportTemplate) {
+            this.reportTemplate = reportTemplate;
+            return self();
+        }
+
         protected abstract T self();
 
         public abstract SandboxCheck build();
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCheckResult.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxCheckResult.java
@@ -9,12 +9,20 @@ class SandboxCheckResult {
     @JsonProperty("report")
     private final SandboxCheckReport report;
 
-    SandboxCheckResult(SandboxCheckReport report) {
+    @JsonProperty("report_template")
+    private final String reportTemplate;
+
+    SandboxCheckResult(SandboxCheckReport report, String reportTemplate) {
         this.report = report;
+        this.reportTemplate = reportTemplate;
     }
 
     public SandboxCheckReport getReport() {
         return report;
     }
 
+    public String getReportTemplate() {
+        return reportTemplate;
+    }
+    
 }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentAuthenticityCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentAuthenticityCheck.java
@@ -30,10 +30,8 @@ protected Builder self() {
 
         @Override
         public SandboxDocumentAuthenticityCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxCheckResult result = new SandboxCheckResult(report);
+            SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
             return new SandboxDocumentAuthenticityCheck(result, documentFilter);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentFaceMatchCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentFaceMatchCheck.java
@@ -30,10 +30,8 @@ protected Builder self() {
 
         @Override
         public SandboxDocumentFaceMatchCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxCheckResult result = new SandboxCheckResult(report);
+            SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
             return new SandboxDocumentFaceMatchCheck(result, documentFilter);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheck.java
@@ -57,10 +57,8 @@ protected Builder self() {
 
         @Override
         public SandboxDocumentTextDataCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxDocumentTextDataCheckResult result = new SandboxDocumentTextDataCheckResult(report, documentFields);
+            SandboxDocumentTextDataCheckResult result = new SandboxDocumentTextDataCheckResult(report, reportTemplate, documentFields);
 
             return new SandboxDocumentTextDataCheck(result, documentFilter);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheckResult.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheckResult.java
@@ -11,8 +11,8 @@ public class SandboxDocumentTextDataCheckResult extends SandboxCheckResult {
     @JsonProperty("document_fields")
     private Map<String, Object> documentFields;
 
-    SandboxDocumentTextDataCheckResult(SandboxCheckReport report, Map<String, Object> documentFields) {
-        super(report);
+    SandboxDocumentTextDataCheckResult(SandboxCheckReport report, String reportTemplate, Map<String, Object> documentFields) {
+        super(report, reportTemplate);
         this.documentFields = documentFields;
     }
 
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxIdDocumentComparisonCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxIdDocumentComparisonCheck.java
@@ -41,10 +41,8 @@ protected Builder self() {
 
         @Override
         public SandboxIdDocumentComparisonCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxCheckResult result = new SandboxCheckResult(report);
+            SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
             return new SandboxIdDocumentComparisonCheck(result, secondaryDocumentFilter);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxStaticLivenessCheckBuilder.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxStaticLivenessCheckBuilder.java
@@ -23,10 +23,8 @@ protected SandboxStaticLivenessCheckBuilder self() {
 
     @Override
     public SandboxLivenessCheck build() {
-        notNull(recommendation, "recommendation");
-
         SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-        SandboxCheckResult result = new SandboxCheckResult(report);
+        SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
         return new SandboxLivenessCheck(result, DocScanConstants.STATIC, responseDelay);
     }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheck.java
@@ -54,10 +54,8 @@ protected Builder self() {
 
         @Override
         public SandboxSupplementaryDocumentTextDataCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxSupplementaryDocumentTextDataCheckResult result = new SandboxSupplementaryDocumentTextDataCheckResult(report, documentFields);
+            SandboxSupplementaryDocumentTextDataCheckResult result = new SandboxSupplementaryDocumentTextDataCheckResult(report, reportTemplate, documentFields);
 
             return new SandboxSupplementaryDocumentTextDataCheck(result, documentFilter);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheckResult.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheckResult.java
@@ -11,8 +11,8 @@ public class SandboxSupplementaryDocumentTextDataCheckResult extends SandboxChec
     @JsonProperty("document_fields")
     private Map<String, Object> documentFields;
 
-    SandboxSupplementaryDocumentTextDataCheckResult(SandboxCheckReport report, Map<String, Object> documentFields) {
-        super(report);
+    SandboxSupplementaryDocumentTextDataCheckResult(SandboxCheckReport report, String reportTemplate, Map<String, Object> documentFields) {
+        super(report, reportTemplate);
         this.documentFields = documentFields;
     }
 
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxThirdPartyIdentityCheck.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxThirdPartyIdentityCheck.java
@@ -29,10 +29,8 @@ protected Builder self() {
 
         @Override
         public SandboxThirdPartyIdentityCheck build() {
-            notNull(recommendation, "recommendation");
-
             SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-            SandboxCheckResult result = new SandboxCheckResult(report);
+            SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
             return new SandboxThirdPartyIdentityCheck(result);
         }
diff --git a/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxZoomLivenessCheckBuilder.java b/yoti-sdk-sandbox/src/main/java/com/yoti/api/client/sandbox/docs/request/check/SandboxZoomLivenessCheckBuilder.java
@@ -23,10 +23,8 @@ public SandboxZoomLivenessCheckBuilder withResponseDelay(Integer responseDelay)
 
     @Override
     public SandboxLivenessCheck build() {
-        notNull(recommendation, "recommendation");
-
         SandboxCheckReport report = new SandboxCheckReport(recommendation, breakdown);
-        SandboxCheckResult result = new SandboxCheckResult(report);
+        SandboxCheckResult result = new SandboxCheckResult(report, reportTemplate);
 
         return new SandboxLivenessCheck(result, DocScanConstants.ZOOM, responseDelay);
     }
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentAuthenticityCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentAuthenticityCheckTest.java
@@ -27,17 +27,6 @@ public class SandboxDocumentAuthenticityCheckTest {
     @Mock SandboxBreakdown sandboxBreakdownMock;
     @Mock SandboxDocumentFilter sandboxDocumentFilterMock;
 
-    @Test
-    public void builder_shouldThrowExceptionWhenMissingRecommendation() {
-        try {
-            SandboxDocumentAuthenticityCheck.builder().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldBuildWithoutDocumentFilter() {
         SandboxDocumentAuthenticityCheck result = SandboxDocumentAuthenticityCheck.builder()
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentFaceMatchCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentFaceMatchCheckTest.java
@@ -21,17 +21,6 @@ public class SandboxDocumentFaceMatchCheckTest {
     @Mock SandboxRecommendation sandboxRecommendationMock;
     @Mock SandboxBreakdown sandboxBreakdownMock;
 
-    @Test
-    public void builder_shouldThrowExceptionWhenMissingRecommendation() {
-        try {
-            SandboxDocumentFaceMatchCheck.builder().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldBuildCorrectly() {
         SandboxDocumentFaceMatchCheck result = SandboxDocumentFaceMatchCheck.builder()
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxDocumentTextDataCheckTest.java
@@ -33,17 +33,6 @@ public class SandboxDocumentTextDataCheckTest {
     @Mock SandboxRecommendation sandboxRecommendationMock;
     @Mock SandboxBreakdown sandboxBreakdownMock;
 
-    @Test
-    public void builder_shouldThrowExceptionForMissingRecommendation() {
-        try {
-            SandboxDocumentTextDataCheck.builder().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldInitialiseDocumentFieldsMap() {
         SandboxDocumentTextDataCheck result = SandboxDocumentTextDataCheck.builder()
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxIdDocumentComparisonCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxIdDocumentComparisonCheckTest.java
@@ -22,17 +22,6 @@ public class SandboxIdDocumentComparisonCheckTest {
     @Mock SandboxBreakdown sandboxBreakdownMock;
     @Mock SandboxDocumentFilter secondaryDocumentFilterMock;
 
-    @Test
-    public void builder_shouldThrowExceptionForMissingRecommendation() {
-        try {
-            SandboxIdDocumentComparisonCheck.builder().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldBuildCorrectly() {
         SandboxIdDocumentComparisonCheck result = SandboxIdDocumentComparisonCheck.builder()
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxSupplementaryDocumentTextDataCheckTest.java
@@ -33,17 +33,6 @@ public class SandboxSupplementaryDocumentTextDataCheckTest {
     @Mock SandboxRecommendation sandboxRecommendationMock;
     @Mock SandboxBreakdown sandboxBreakdownMock;
 
-    @Test
-    public void builder_shouldThrowExceptionForMissingRecommendation() {
-        try {
-            SandboxSupplementaryDocumentTextDataCheck.builder().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldInitialiseDocumentFieldsMap() {
         SandboxSupplementaryDocumentTextDataCheck result = SandboxSupplementaryDocumentTextDataCheck.builder()
@@ -67,4 +56,4 @@ public void builder_shouldAllowMapForDocumentFields() {
         assertThat(result.getResult().getDocumentFields(), hasEntry("firstKey", (Object) "firstValue"));
         assertThat(result.getResult().getDocumentFields(), hasEntry("secondKey", (Object) 100));
     }
-}
+}
diff --git a/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxZoomLivenessCheckTest.java b/yoti-sdk-sandbox/src/test/java/com/yoti/api/client/sandbox/docs/request/check/SandboxZoomLivenessCheckTest.java
@@ -21,17 +21,6 @@ public class SandboxZoomLivenessCheckTest {
     @Mock SandboxRecommendation sandboxRecommendationMock;
     @Mock SandboxBreakdown sandboxBreakdownMock;
 
-    @Test
-    public void builder_shouldThrowExceptionForMissingRecommendation() {
-        try {
-            SandboxLivenessCheck.forZoomLiveness().build();
-        } catch (IllegalArgumentException ex) {
-            assertThat(ex.getMessage(), containsString("recommendation"));
-            return;
-        }
-        fail("Expected an exception");
-    }
-
     @Test
     public void builder_shouldBuildWithCorrectValues() {
         SandboxLivenessCheck result = new SandboxZoomLivenessCheckBuilder()

Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,20 @@ class SandboxCheckResult {`
`9`	`9`	`@JsonProperty("report")`
`10`	`10`	`private final SandboxCheckReport report;`
`11`	`11`
`12`		`- SandboxCheckResult(SandboxCheckReport report) {`
	`12`	`+ @JsonProperty("report_template")`
	`13`	`+ private final String reportTemplate;`
	`14`	`+`
	`15`	`+ SandboxCheckResult(SandboxCheckReport report, String reportTemplate) {`
`13`	`16`	`this.report = report;`
	`17`	`+ this.reportTemplate = reportTemplate;`
`14`	`18`	`}`
`15`	`19`
`16`	`20`	`public SandboxCheckReport getReport() {`
`17`	`21`	`return report;`
`18`	`22`	`}`
`19`	`23`
	`24`	`+ public String getReportTemplate() {`
	`25`	`+ return reportTemplate;`
	`26`	`+ }`
	`27`	`+`
`20`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ public class SandboxDocumentTextDataCheckResult extends SandboxCheckResult {`
`11`	`11`	`@JsonProperty("document_fields")`
`12`	`12`	`private Map<String, Object> documentFields;`
`13`	`13`
`14`		`- SandboxDocumentTextDataCheckResult(SandboxCheckReport report, Map<String, Object> documentFields) {`
`15`		`- super(report);`
	`14`	`+ SandboxDocumentTextDataCheckResult(SandboxCheckReport report, String reportTemplate, Map<String, Object> documentFields) {`
	`15`	`+ super(report, reportTemplate);`
`16`	`16`	`this.documentFields = documentFields;`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@ public class SandboxSupplementaryDocumentTextDataCheckResult extends SandboxChec`
`11`	`11`	`@JsonProperty("document_fields")`
`12`	`12`	`private Map<String, Object> documentFields;`
`13`	`13`
`14`		`- SandboxSupplementaryDocumentTextDataCheckResult(SandboxCheckReport report, Map<String, Object> documentFields) {`
`15`		`- super(report);`
	`14`	`+ SandboxSupplementaryDocumentTextDataCheckResult(SandboxCheckReport report, String reportTemplate, Map<String, Object> documentFields) {`
	`15`	`+ super(report, reportTemplate);`
`16`	`16`	`this.documentFields = documentFields;`
`17`	`17`	`}`
`18`	`18`