SDK-2543: Move Identity Profile responses and associated classes to t…

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.9.0</version>
+    <version>4.0.0-SNAPSHOT</version>
 </dependency>
 ```
 
 If you are using Gradle, here is the dependency to add:
 
-`compile group: 'com.yoti', name: 'yoti-sdk-api', version: '3.9.0'`
+`compile group: 'com.yoti', name: 'yoti-sdk-api', version: '4.0.0-SNAPSHOT'`
 
 You will find all classes packaged under `com.yoti.api`
 
@@ -294,6 +294,10 @@ Instructions on how to run the Spring example projects can be found at the follo
 This major update does not have any major updates to the API, but instead builds upon and
 standardizes our implementation.
 
+## Breaking changes and enhancements made in v4.0.0
+
+- Creating an Identity Profile session now uses strongly typed classes, instead of a Map
+
 ### Dropped support for Java 7
 Minimum supported Java version is now 8.
 

examples/doc-scan/pom.xml

@@ -53,7 +53,7 @@
     <dependency>
       <groupId>com.yoti</groupId>
       <artifactId>yoti-sdk-api</artifactId>
-      <version>3.9.0</version>
+      <version>4.0.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
 

examples/doc-scan/src/main/java/com/yoti/docscan/demo/controller/DocScanController.java

@@ -1,11 +1,14 @@
 package com.yoti.docscan.demo.controller;
 
+import java.util.List;
+
 import javax.servlet.http.HttpSession;
 
 import com.yoti.api.client.Media;
 import com.yoti.api.client.docs.DocScanClient;
 import com.yoti.api.client.docs.DocScanException;
 import com.yoti.api.client.docs.session.create.CreateSessionResult;
+import com.yoti.api.client.docs.session.devicemetadata.MetadataResponse;
 import com.yoti.api.client.docs.session.retrieve.GetSessionResult;
 import com.yoti.docscan.demo.service.DocScanService;
 
@@ -23,6 +26,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@@ -68,8 +72,13 @@ public String getIndex(final Model model, HttpSession httpSession) {
     }
 
     @RequestMapping(value = "/success", method = RequestMethod.GET)
-    public String getUserSession(final Model model, HttpSession httpSession) {
-        String sessionId = (String) httpSession.getAttribute(DOC_SCAN_SESSION_ID);
+    public String getUserSession(@RequestParam(value = "sessionId") String sessionIdQueryParam, final Model model, HttpSession httpSession) {
+        String sessionId;
+        if (sessionIdQueryParam != null) {
+            sessionId = sessionIdQueryParam;
+        } else {
+            sessionId = (String) httpSession.getAttribute(DOC_SCAN_SESSION_ID);
+        }
 
         if (sessionId == null || sessionId.equals("")) {
             return "redirect:/";
@@ -117,6 +126,11 @@ public ResponseEntity<byte[]> getMedia(
         return new ResponseEntity<>(media.getContent(), headers, HttpStatus.OK);
     }
 
+    @RequestMapping(value = "/tracked-devices", method = RequestMethod.GET)
+    public @ResponseBody List<MetadataResponse> getTrackedDevices(@RequestParam(value = "sessionId") String sessionId) throws DocScanException {
+        return docScanService.getTrackedDevices(sessionId);
+    }
+
     @RequestMapping(value = "/privacy-policy", method = RequestMethod.GET)
     public String showPrivacyPolicyPage() {
         return "privacy";

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

@@ -1,6 +1,7 @@
 package com.yoti.docscan.demo.service;
 
 import java.util.Arrays;
+import java.util.List;
 
 import com.yoti.api.client.Media;
 import com.yoti.api.client.docs.DocScanClient;
@@ -22,6 +23,7 @@
 import com.yoti.api.client.docs.session.create.objective.ProofOfAddressObjective;
 import com.yoti.api.client.docs.session.create.task.RequestedIdDocTextExtractionTask;
 import com.yoti.api.client.docs.session.create.task.RequestedSupplementaryDocTextExtractionTask;
+import com.yoti.api.client.docs.session.devicemetadata.MetadataResponse;
 import com.yoti.api.client.docs.session.retrieve.GetSessionResult;
 import com.yoti.api.client.spi.remote.call.YotiConstants;
 
@@ -148,4 +150,8 @@ public String getIframeUrl(CreateSessionResult createSessionResult) {
     public Media getMedia(String sessionId, String mediaId) throws DocScanException {
         return docScanClient.getMediaContent(sessionId, mediaId);
     }
+
+    public List<MetadataResponse> getTrackedDevices(String sessionId) throws DocScanException {
+        return docScanClient.getTrackedDevices(sessionId);
+    }
 }

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

@@ -446,6 +446,40 @@ <h5>Media</h5>
                         </div>
                     </div>
 
+                    <!-- Expanded Document Fields -->
+                    <div class="card" th:if="${document.getExpandedDocumentFields() != null}">
+                        <div class="card-header" th:id="${'expanded-document-fields-' + iter.index}">
+                            <h4 class="mb-0">
+                                <button class="btn btn-link" type="button" data-toggle="collapse"
+                                        th:attr="data-target='#collapse-expanded-document-fields-' + ${iter.index}"
+                                        th:attrappend="aria-controls='collapse-expanded-document-fields-' + ${iter.index}"
+                                        aria-expanded="true">
+                                    Expanded Document Fields
+                                </button>
+                            </h4>
+                        </div>
+                        <div th:id="${'collapse-expanded-document-fields-' + iter.index}" class="collapse"
+                             th:aria-labelledby="${'expanded-document-fields-' + iter.index}">
+                            <div class="card-body">
+                                <th:block th:if="${document.getExpandedDocumentFields().getMedia() != null}">
+                                    <h5>Media</h5>
+                                    <table class="table table-striped table-light">
+                                        <tbody>
+                                        <tr>
+                                            <td>ID</td>
+                                            <td>
+                                                <a th:href="${'/media?mediaId=' + document.getDocumentFields().getMedia().getId()}"
+                                                   th:text="${document.getDocumentFields().getMedia().getId()}">
+                                                </a>
+                                            </td>
+                                        </tr>
+                                        </tbody>
+                                    </table>
+                                </th:block>
+                            </div>
+                        </div>
+                    </div>
+
                     <!-- Document ID Photo -->
                     <div class="card" th:if="${document.getDocumentIdPhoto() != null}">
                         <div class="card-header" th:id="${'document-id-photo-' + iter.index}">
@@ -931,6 +965,14 @@ <h2>Identity Profile</h2>
             </div>
         </div>
 
+        <th:block th:if="${sessionResult.getIdentityProfile().getIdentityProfileReport()() != null}">
+            <div th:if="${sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia() != null}">
+                Generated Profile Media: <a th:href="${'/media?mediaId=' + sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia().getId()}"
+                                            th:text="${sessionResult.getIdentityProfile().getIdentityProfileReport().getMedia().getId()}">
+                </a>
+            </div>
+        </th:block>
+
         <!-- Identity Profile Failure Reason -->
         <th:block th:if="${sessionResult.getIdentityProfile().getFailureReason() != null}">
             <div class="row pt-4">
@@ -1010,6 +1052,17 @@ <h4 class="mb-0">
         </th:block>
     </th:block>
 
+    <div class="row pt-4">
+        <div class="col">
+            <h2>
+                Tracked Devices
+                <a th:href="${'/tracked-devices?sessionId=' + sessionResult.getSessionId()}">
+                    <span class="badge badge-success" th:href="${'/tracked-devices?sessionId=' + sessionResult.getSessionId()}" th:text="GET">
+                    </span>
+                </a>
+            </h2>
+        </div>
+    </div>
 </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.9.0</version>
+  <version>4.0.0-SNAPSHOT</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>

yoti-sdk-api/pom.xml

@@ -11,7 +11,7 @@
   <parent>
     <groupId>com.yoti</groupId>
     <artifactId>yoti-sdk-parent</artifactId>
-    <version>3.9.0</version>
+    <version>4.0.0-SNAPSHOT</version>
     <relativePath>../yoti-sdk-parent</relativePath>
   </parent>
 

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/DocScanClient.java

@@ -6,6 +6,7 @@
 import java.io.IOException;
 import java.security.KeyPair;
 import java.security.Security;
+import java.util.List;
 
 import com.yoti.api.client.InitialisationException;
 import com.yoti.api.client.KeyPairSource;
@@ -14,6 +15,7 @@
 import com.yoti.api.client.docs.session.create.SessionSpec;
 import com.yoti.api.client.docs.session.create.facecapture.CreateFaceCaptureResourcePayload;
 import com.yoti.api.client.docs.session.create.facecapture.UploadFaceCaptureImagePayload;
+import com.yoti.api.client.docs.session.devicemetadata.MetadataResponse;
 import com.yoti.api.client.docs.session.instructions.Instructions;
 import com.yoti.api.client.docs.session.retrieve.CreateFaceCaptureResourceResponse;
 import com.yoti.api.client.docs.session.retrieve.GetSessionResult;
@@ -242,6 +244,31 @@ public SessionConfigurationResponse getSessionConfiguration(String sessionId) th
         return docScanService.fetchSessionConfiguration(sdkId, keyPair, sessionId);
     }
 
+    /**
+     * Fetches details of the devices tracked at key points in completing the session.
+     *
+     * @param sessionId the session ID
+     *
+     * @return the list of tracked devices information
+     * @throws DocScanException if an error has occurred
+     */
+    public List<MetadataResponse> getTrackedDevices(String sessionId) throws DocScanException {
+        LOG.debug("Fetching tracked devices for session '{}'", sessionId);
+        return docScanService.getTrackedDevices(sdkId, keyPair, sessionId);
+    }
+
+    /**
+     * Deletes the tracked devices metadata for the given sessionID.
+     *
+     * @param sessionId the session ID
+     *
+     * @throws DocScanException if an error has occurred
+     */
+    public void deleteTrackedDevices(String sessionId) throws DocScanException {
+        LOG.debug("Deleting tracked devices for session '{}'", sessionId);
+        docScanService.deleteTrackedDevices(sdkId, keyPair, sessionId);
+    }
+
     private KeyPair loadKeyPair(KeyPairSource kpSource) throws InitialisationException {
         try {
             LOG.debug("Loading key pair from '{}'", kpSource);

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/DocScanConstants.java

@@ -53,6 +53,10 @@ private DocScanConstants() { }
     public static final String CHECK_COMPLETION = "CHECK_COMPLETION";
     public static final String SESSION_COMPLETION = "SESSION_COMPLETION";
     public static final String CLIENT_SESSION_TOKEN_DELETED = "CLIENT_SESSION_TOKEN_DELETED";
+    public static final String NEW_PDF_SUPPLIED = "NEW_PDF_SUPPLIED";
+    public static final String INSTRUCTIONS_EMAIL_REQUESTED = "INSTRUCTIONS_EMAIL_REQUESTED";
+    public static final String THANK_YOU_EMAIL_REQUESTED = "THANK_YOU_EMAIL_REQUESTED";
+    public static final String FIRST_BRANCH_VISIT = "FIRST_BRANCH_VISIT";
 
     public static final String ALWAYS = "ALWAYS";
     public static final String FALLBACK = "FALLBACK";
@@ -83,4 +87,11 @@ private DocScanConstants() { }
 
     public static final String GBP = "GBP";
 
+    public static final String EARLY = "EARLY";
+    public static final String JUST_IN_TIME = "JUST_IN_TIME";
+
+    public static final String ON = "ON";
+    public static final String OFF = "OFF";
+    public static final String AUTO = "AUTO";
+
 }

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/DocScanService.java

@@ -24,6 +24,7 @@
 import com.yoti.api.client.docs.session.create.SessionSpec;
 import com.yoti.api.client.docs.session.create.facecapture.CreateFaceCaptureResourcePayload;
 import com.yoti.api.client.docs.session.create.facecapture.UploadFaceCaptureImagePayload;
+import com.yoti.api.client.docs.session.devicemetadata.MetadataResponse;
 import com.yoti.api.client.docs.session.instructions.Instructions;
 import com.yoti.api.client.docs.session.retrieve.CreateFaceCaptureResourceResponse;
 import com.yoti.api.client.docs.session.retrieve.GetSessionResult;
@@ -39,6 +40,7 @@
 import com.yoti.api.client.spi.remote.call.factory.UnsignedPathFactory;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
@@ -52,6 +54,9 @@
 final class DocScanService {
 
     private static final Logger LOG = LoggerFactory.getLogger(DocScanService.class);
+
+    private static final TypeReference<List<MetadataResponse>> METADATA_RESPONSE_TYPE_REF = new TypeReference<List<MetadataResponse>>() {};
+
     private static final int HTTP_STATUS_NO_CONTENT = 204;
     private static final String YOTI_MULTIPART_BOUNDARY = "yoti-doc-scan-boundary";
 
@@ -527,6 +532,53 @@ public void triggerIbvEmailNotification(String sdkId, KeyPair keyPair, String se
         }
     }
 
+    public List<MetadataResponse> getTrackedDevices(String sdkId, KeyPair keyPair, String sessionId) throws DocScanException {
+        notNullOrEmpty(sdkId, "SDK ID");
+        notNull(keyPair, "Application key Pair");
+        notNullOrEmpty(sessionId, "sessionId");
+
+        String path = unsignedPathFactory.createFetchTrackedDevices(sdkId, sessionId);
+        LOG.info("Fetching tracked devices at '{}'", path);
+
+        try {
+            SignedRequest signedRequest = signedRequestBuilderFactory.create()
+                    .withKeyPair(keyPair)
+                    .withBaseUrl(apiUrl)
+                    .withEndpoint(path)
+                    .withHttpMethod(HTTP_GET)
+                    .build();
+
+            return signedRequest.execute(METADATA_RESPONSE_TYPE_REF);
+        } catch (GeneralSecurityException | ResourceException ex) {
+            throw new DocScanException("Error executing the GET: " + ex.getMessage(), ex);
+        } catch (IOException | URISyntaxException ex) {
+            throw new DocScanException("Error building the request: " + ex.getMessage(), ex);
+        }
+    }
+
+    public void deleteTrackedDevices(String sdkId, KeyPair keyPair, String sessionId) throws DocScanException {
+        notNullOrEmpty(sdkId, "SDK ID");
+        notNull(keyPair, "Application key Pair");
+        notNullOrEmpty(sessionId, "sessionId");
+
+        String path = unsignedPathFactory.createDeleteTrackedDevices(sdkId, sessionId);
+        LOG.info("Deleting tracked devices at '{}'", path);
+
+        try {
+            signedRequestBuilderFactory.create()
+                    .withKeyPair(keyPair)
+                    .withBaseUrl(apiUrl)
+                    .withEndpoint(path)
+                    .withHttpMethod(HTTP_DELETE)
+                    .build()
+                    .execute();
+        } catch (GeneralSecurityException | ResourceException ex) {
+            throw new DocScanException("Error executing the GET: " + ex.getMessage(), ex);
+        } catch (IOException | URISyntaxException ex) {
+            throw new DocScanException("Error building the request: " + ex.getMessage(), ex);
+        }
+    }
+
     private String findContentType(SignedRequestResponse response) {
         List<String> contentTypeValues = null;
         for (Map.Entry<String, List<String>> entry : response.getResponseHeaders().entrySet()) {

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/IbvOptions.java

@@ -6,13 +6,13 @@
 
 public class IbvOptions {
 
-    @JsonProperty(Property.SUPPORT)
+    @JsonProperty("support")
     private final String support;
 
-    @JsonProperty(Property.GUIDANCE_URL)
+    @JsonProperty("guidance_url")
     private final String guidanceUrl;
 
-    @JsonProperty(Property.USER_PRICE)
+    @JsonProperty("user_price")
     private final UserPrice userPrice;
 
     private IbvOptions(String support, String guidanceUrl, UserPrice userPrice) {
@@ -102,14 +102,4 @@ public IbvOptions build() {
 
     }
 
-    private static final class Property {
-
-        private static final String SUPPORT = "support";
-        private static final String GUIDANCE_URL = "guidance_url";
-        private static final String USER_PRICE = "user_price";
-
-        private Property() { }
-
-    }
-
 }