Release 3.9.0

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Yoti Support
+    url: https://support.yoti.com/yotisupport/s/contactsupport
+    about: Please send your questions or issues here.

.github/dependabot.yml

@@ -9,7 +9,8 @@ updates:
   reviewers:
   - bucky-boy
   - MrBurtyyy
-  - psmelia
   - pn-santos
+  - irotech
   assignees:
   - MrBurtyyy
+  - irotech

.github/workflows/junit.yml

@@ -18,10 +18,11 @@ jobs:
         jdk-version: [8,11,17]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Java ${{ matrix.jdk-version }}
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
+          distribution: 'zulu'
           java-version: ${{ matrix.jdk-version }}
           architecture: x64
       - run: mvn test -B -pl yoti-sdk-api -Ddependency-check.skip=true

.github/workflows/sonar.yml

@@ -11,17 +11,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           # Disabling shallow clone is recommended for improving relevancy of reporting
           fetch-depth: 0
-      - name: Set up Java 11
-        uses: actions/setup-java@v1
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
         with:
-          java-version: 11
+          distribution: 'zulu'
+          java-version: 17
           architecture: x64
       - name: Scan SDK
         run: mvn -B clean install sonar:sonar -Ddependency-check.skip=true -Dgpg.skip=true -Dfindbugs.skip=true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

README.md

@@ -101,13 +101,13 @@ If you are using Maven, you need to add the following dependency:
 <dependency>
     <groupId>com.yoti</groupId>
     <artifactId>yoti-sdk-api</artifactId>
-    <version>3.8.0</version>
+    <version>3.9.0</version>
 </dependency>
 ```
 
 If you are using Gradle, here is the dependency to add:
 
-`compile group: 'com.yoti', name: 'yoti-sdk-api', version: '3.8.0'`
+`compile group: 'com.yoti', name: 'yoti-sdk-api', version: '3.9.0'`
 
 You will find all classes packaged under `com.yoti.api`
 

examples/doc-scan/pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
-    <version>2.7.16</version>
+    <version>2.7.18</version>
     <relativePath/> <!-- lookup parent from repository -->
   </parent>
 
@@ -53,7 +53,7 @@
     <dependency>
       <groupId>com.yoti</groupId>
       <artifactId>yoti-sdk-api</artifactId>
-      <version>3.8.0</version>
+      <version>3.9.0</version>
     </dependency>
   </dependencies>
 

examples/doc-scan/src/main/java/com/yoti/docscan/demo/service/DocScanService.java

@@ -60,7 +60,7 @@ public CreateSessionResult createSession() throws DocScanException {
 
         SessionSpec sessionSpec = SessionSpec.builder()
                 .withClientSessionTokenTtl(600)
-                .withResourcesTtl(90000)
+                .withResourcesTtl(604800)
                 .withUserTrackingId("some-user-tracking-id")
                 .withSdkConfig(sdkConfig)
                 .withRequestedCheck(
@@ -69,13 +69,13 @@ public CreateSessionResult createSession() throws DocScanException {
                 )
                 .withRequestedCheck(
                         RequestedFaceMatchCheck.builder()
-                                .withManualCheckAlways()
+                                .withManualCheckFallback()
                                 .build()
                 )
                 .withRequestedCheck(
                         RequestedLivenessCheck.builder()
-                                .forZoomLiveness()
-                                .withMaxRetries(1)
+                                .forStaticLiveness()
+                                .withMaxRetries(3)
                                 .build()
                 )
                 .withRequestedCheck(
@@ -97,12 +97,12 @@ public CreateSessionResult createSession() throws DocScanException {
                 )
                 .withRequestedTask(
                         RequestedIdDocTextExtractionTask.builder()
-                                .withManualCheckAlways()
+                                .withManualCheckFallback()
                                 .build()
                 )
                 .withRequestedTask(
                         RequestedSupplementaryDocTextExtractionTask.builder()
-                                .withManualCheckAlways()
+                                .withManualCheckFallback()
                                 .build()
                 )
                 .withRequiredDocument(

examples/doc-scan/src/main/resources/templates/success.html

@@ -924,6 +924,92 @@ <h2>Import Token</h2>
         </div>
     </th:block>
 
+    <th:block th:if="${sessionResult.getIdentityProfile() != null}">
+        <div class="row pt-4">
+            <div class="col">
+                <h2>Identity Profile</h2>
+            </div>
+        </div>
+
+        <!-- Identity Profile Failure Reason -->
+        <th:block th:if="${sessionResult.getIdentityProfile().getFailureReason() != null}">
+            <div class="row pt-4">
+                <div class="col">
+                    <div class="accordion mt-3">
+                        <div class="card" th:if="${sessionResult.getIdentityProfile().getFailureReason() != null}">
+                            Failure Reason: <span th:text="${sessionResult.getIdentityProfile().getFailureReason().getReasonCode()}"></span>
+                            <th:block th:if="${!sessionResult.getIdentityProfile().getFailureReason().getRequirementNotMetDetails().isEmpty()}">
+                                <div th:each="requirementsNotMetDetails : ${sessionResult.getIdentityProfile().getFailureReason().getRequirementNotMetDetails()}">
+                                    <span th:if="${requirementsNotMetDetails.getFailureType() != null}">Failure Type: <span th:text="${requirementsNotMetDetails.getFailureType()}"></span></span>
+                                    <span th:if="${requirementsNotMetDetails.getDocumentType() != null}">Document Type: <span th:text="${requirementsNotMetDetails.getDocumentType()}"></span></span>
+                                    <span th:if="${requirementsNotMetDetails.getDocumentCountryIsoCode() != null}">Document Country ISO Code: <span th:text="${requirementsNotMetDetails.getDocumentCountryIsoCode()}"></span></span>
+                                    <span th:if="${requirementsNotMetDetails.getAuditId() != null}">Audit ID: <span th:text="${requirementsNotMetDetails.getAuditId()}"></span></span>
+                                    <span th:if="${requirementsNotMetDetails.getDetails() != null}">Details: <span th:text="${requirementsNotMetDetails.getDetails()}"></span></span>
+                                </div>
+                            </th:block>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </th:block>
+
+    </th:block>
+
+    <th:block th:if="${sessionResult.getAdvancedIdentityProfile() != null}">
+        <div class="row pt-4">
+            <div class="col">
+                <h2>
+                    <span th:remove="tag">Advanced Identity Profile</span>
+                    <span class="badge badge-primary" th:text="${sessionResult.getAdvancedIdentityProfile().getResult()}"></span>
+                    <span class="badge badge-warning" th:if="${sessionResult.getAdvancedIdentityProfile().getFailureReason() != null}" th:text="${sessionResult.getAdvancedIdentityProfile().getFailureReason().getReasonCode()}"></span>
+                </h2>
+            </div>
+        </div>
+
+        <div class="row pt-4">
+            <div class="col">
+                <th:block th:if="${sessionResult.getAdvancedIdentityProfile().getSubjectId() != null}">
+                    <span>Subject ID: <span th:text="${sessionResult.getAdvancedIdentityProfile().getSubjectId()}"/></span>
+                </th:block>
+            </div>
+        </div>
+
+        <th:block th:if="${sessionResult.getAdvancedIdentityProfile().getIdentityProfileReport() != null}">
+            <div th:if="${sessionResult.getAdvancedIdentityProfile().getIdentityProfileReport().getMedia() != null}">
+                Generated Profile Media: <a th:href="${'/media?mediaId=' + sessionResult.getAdvancedIdentityProfile().getIdentityProfileReport().getMedia().getId()}"
+                   th:text="${sessionResult.getAdvancedIdentityProfile().getIdentityProfileReport().getMedia().getId()}">
+                </a>
+            </div>
+
+            <div class="accordion mt-3">
+                <th:block th:each="compliance, iter : ${sessionResult.getAdvancedIdentityProfile().getIdentityProfileReport().getCompliance()}">
+                    <div class="card-header" th:id="${'advanced-identity-profile-compliance-' + iter.index}">
+                        <h4 class="mb-0">
+                            <button class="btn btn-link" type="button" data-toggle="collapse"
+                                    th:attr="data-target='#collapse-advanced-identity-profile-compliance-' + ${iter.index}"
+                                    th:attrappend="aria-controls='collapse-advanced-identity-profile-compliance-' + ${iter.index}"
+                                    th:text="${compliance.getTrustFramework()}"
+                                    aria-expanded="true">
+                            </button>
+                        </h4>
+                    </div>
+                    <div th:id="${'collapse-advanced-identity-profile-compliance-' + iter.index}" class="collapse"
+                         th:aria-labelledby="${'advanced-identity-profile-compliance-' + iter.index}">
+                        <div class="card-body"></div>
+                        <div class="card-body" th:each="scheme : ${compliance.getSchemesCompliance()}">
+
+                            <span><b>Type: </b></span><span th:text="${scheme.getScheme().getType()}"></span><br/>
+                            <span><b>Objective: </b></span><span th:text="${scheme.getScheme().getObjective()}"></span><br/>
+                            <span><b>Label: </b></span><span th:text="${scheme.getScheme().getLabel()}"></span><br/>
+                            <span><b>Requirements Met: </b></span><span th:text="${scheme.getRequirementsMet()}"></span><br/>
+                            <span><b>Requirements Not Met Info: </b></span><span th:text="${scheme.getRequirementsNotMetInfo()}"></span><br/>
+                        </div>
+                    </div>
+                </th:block>
+            </div>
+        </th:block>
+    </th:block>
+
 </div>
 
 <div th:replace="fragments/components :: footer"></div>

pom.xml

@@ -5,7 +5,7 @@
   <groupId>com.yoti</groupId>
   <artifactId>yoti-sdk</artifactId>
   <packaging>pom</packaging>
-  <version>3.8.0</version>
+  <version>3.9.0</version>
   <name>Yoti SDK</name>
   <description>Java SDK for simple integration with the Yoti platform</description>
   <url>https://github.com/getyoti/yoti-java-sdk</url>
@@ -20,17 +20,68 @@
   </modules>
 
   <properties>
+    <supported.java.version>1.8</supported.java.version>
+
+    <maven.min.version>3.8.5</maven.min.version>
+
     <!-- plugin versions -->
     <maven-deploy-plugin.version>3.1.1</maven-deploy-plugin.version>
-    <properties-maven-plugin.version>1.1.0</properties-maven-plugin.version>
-    <spotbugs-maven-plugin.version>4.7.3.4</spotbugs-maven-plugin.version>
+    <properties-maven-plugin.version>1.2.1</properties-maven-plugin.version>
+    <spotbugs-maven-plugin.version>4.8.3.1</spotbugs-maven-plugin.version>
+    <maven-enforcer-plugin.version>3.4.1</maven-enforcer-plugin.version>
+    <extra-enforcer-rules.version>1.7.0</extra-enforcer-rules.version>
   </properties>
 
   <build>
-    <plugins>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <artifactId>maven-enforcer-plugin</artifactId>
+          <version>${maven-enforcer-plugin.version}</version>
+          <executions>
+            <execution>
+              <id>enforce-bytecode-version</id>
+              <goals>
+                <goal>enforce</goal>
+              </goals>
+              <phase>verify</phase>
+              <configuration>
+                <rules>
+                  <enforceBytecodeVersion>
+                    <maxJdkVersion>${supported.java.version}</maxJdkVersion>
+                  </enforceBytecodeVersion>
+                </rules>
+                <fail>true</fail>
+              </configuration>
+            </execution>
+            <execution>
+              <id>enforce-dependency-versions</id>
+              <goals>
+                <goal>enforce</goal>
+              </goals>
+              <configuration>
+                <rules>
+                  <dependencyConvergence/>
+                  <requireMavenVersion>
+                    <version>${maven.min.version}</version>
+                  </requireMavenVersion>
+                </rules>
+              </configuration>
+            </execution>
+          </executions>
+          <dependencies>
+            <dependency>
+              <groupId>org.codehaus.mojo</groupId>
+              <artifactId>extra-enforcer-rules</artifactId>
+              <version>${extra-enforcer-rules.version}</version>
+            </dependency>
+          </dependencies>
+        </plugin>
+      </plugins>
+    </pluginManagement>
 
+    <plugins>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-deploy-plugin</artifactId>
         <version>${maven-deploy-plugin.version}</version>
         <configuration>
@@ -62,6 +113,10 @@
         <artifactId>spotbugs-maven-plugin</artifactId>
         <version>${spotbugs-maven-plugin.version}</version>
       </plugin>
+
+      <plugin>
+        <artifactId>maven-enforcer-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 

yoti-sdk-api/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <groupId>com.yoti</groupId>
     <artifactId>yoti-sdk-parent</artifactId>
-    <version>3.8.0</version>
+    <version>3.9.0</version>
     <relativePath>../yoti-sdk-parent</relativePath>
   </parent>
 
@@ -87,19 +87,16 @@
         <artifactId>animal-sniffer-maven-plugin</artifactId>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
       </plugin>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>${maven-compiler-plugin.version}</version>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-source-plugin</artifactId>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
       </plugin>
       <plugin>
@@ -121,7 +118,6 @@
   <reporting>
     <plugins>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-project-info-reports-plugin</artifactId>
       </plugin>
     </plugins>

yoti-sdk-api/spotbugs/exclude-filter.xml

@@ -22,6 +22,10 @@
     <Bug pattern="CRLF_INJECTION_LOGS"/>
   </Match>
 
+  <Match>
+    <Bug pattern="CT_CONSTRUCTOR_THROW"/>
+  </Match>
+
   <Match>
     <Class name="com.yoti.api.client.spi.remote.call.SignedRequest"/>
     <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>