SDK-2531, SDK-2532, SDK-2533

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.10.0-SNAPSHOT</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.10.0-SNAPSHOT'`
+`compile group: 'com.yoti', name: 'yoti-sdk-api', version: '4.0.0-SNAPSHOT'`
 
 You will find all classes packaged under `com.yoti.api`
 

examples/doc-scan/pom.xml

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

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

@@ -965,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">

pom.xml

@@ -5,7 +5,7 @@
   <groupId>com.yoti</groupId>
   <artifactId>yoti-sdk</artifactId>
   <packaging>pom</packaging>
-  <version>3.10.0-SNAPSHOT</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.10.0-SNAPSHOT</version>
+    <version>4.0.0-SNAPSHOT</version>
     <relativePath>../yoti-sdk-parent</relativePath>
   </parent>
 

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

@@ -0,0 +1,45 @@
+package com.yoti.api.client.docs.session.create;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileSubjectPayload {
+
+    @JsonProperty("subject_id")
+    private final String subjectId;
+
+    IdentityProfileSubjectPayload(String subjectId) {
+        this.subjectId = subjectId;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getSubjectId() {
+        return subjectId;
+    }
+
+    public static class Builder {
+
+        private String subjectId;
+
+        Builder() {}
+
+        /**
+         * Sets the subject ID for the Identity Profile requirement
+         *
+         * @param subjectId the subject ID
+         * @return the builder
+         */
+        public Builder withSubjectId(String subjectId) {
+            this.subjectId = subjectId;
+            return this;
+        }
+
+        public IdentityProfileSubjectPayload build() {
+            return new IdentityProfileSubjectPayload(subjectId);
+        }
+
+    }
+
+}

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

@@ -8,6 +8,7 @@
 import com.yoti.api.client.docs.session.create.check.RequestedCheck;
 import com.yoti.api.client.docs.session.create.filters.RequiredDocument;
 import com.yoti.api.client.docs.session.create.identityprofile.advanced.AdvancedIdentityProfileRequirementsPayload;
+import com.yoti.api.client.docs.session.create.identityprofile.simple.IdentityProfileRequirementsPayload;
 import com.yoti.api.client.docs.session.create.resources.ResourceCreationContainer;
 import com.yoti.api.client.docs.session.create.task.RequestedTask;
 
@@ -55,13 +56,13 @@ public class SessionSpec {
     private final IbvOptions ibvOptions;
 
     @JsonProperty(Property.IDENTITY_PROFILE_REQUIREMENTS)
-    private final Map<String, Object> identityProfile;
+    private final IdentityProfileRequirementsPayload identityProfile;
 
     @JsonProperty(Property.ADVANCED_IDENTITY_PROFILE_REQUIREMENTS)
     private final AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements;
 
     @JsonProperty(Property.SUBJECT)
-    private final Map<String, Object> subject;
+    private final IdentityProfileSubjectPayload subject;
 
     @JsonProperty(Property.RESOURCES)
     private final ResourceCreationContainer resources;
@@ -81,8 +82,8 @@ public class SessionSpec {
             Boolean blockBiometricConsent,
             IbvOptions ibvOptions,
             ZonedDateTime sessionDeadline,
-            Map<String, Object> identityProfile,
-            Map<String, Object> subject,
+            IdentityProfileRequirementsPayload identityProfile,
+            IdentityProfileSubjectPayload subject,
             ResourceCreationContainer resources,
             Boolean createIdentityProfilePreview,
             AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirements) {
@@ -223,7 +224,7 @@ public ZonedDateTime getSessionDeadline() {
      *
      * @return Identity Profile
      */
-    public Object getIdentityProfile() {
+    public IdentityProfileRequirementsPayload getIdentityProfile() {
         return identityProfile;
     }
 
@@ -232,7 +233,7 @@ public Object getIdentityProfile() {
      *
      * @return subject
      */
-    public Map<String, Object> getSubject() {
+    public IdentityProfileSubjectPayload getSubject() {
         return subject;
     }
 
@@ -277,9 +278,9 @@ public static class Builder {
         private Boolean blockBiometricConsent;
         private IbvOptions ibvOptions;
         private ZonedDateTime sessionDeadline;
-        private Map<String, Object> identityProfile;
+        private IdentityProfileRequirementsPayload identityProfile;
         private AdvancedIdentityProfileRequirementsPayload advancedIdentityProfileRequirementsPayload;
-        private Map<String, Object> subject;
+        private IdentityProfileSubjectPayload subject;
         private ResourceCreationContainer resources;
         private Boolean createIdentityProfilePreview;
 
@@ -428,7 +429,7 @@ public Builder withSessionDeadline(ZonedDateTime sessionDeadline) {
          * @param identityProfile the Identity Profile
          * @return the Builder
          */
-        public Builder withIdentityProfile(Map<String, Object> identityProfile) {
+        public Builder withIdentityProfile(IdentityProfileRequirementsPayload identityProfile) {
             this.identityProfile = identityProfile;
             return this;
         }
@@ -439,7 +440,7 @@ public Builder withIdentityProfile(Map<String, Object> identityProfile) {
          * @param subject the subject
          * @return the Builder
          */
-        public Builder withSubject(Map<String, Object> subject) {
+        public Builder withSubject(IdentityProfileSubjectPayload subject) {
             this.subject = subject;
             return this;
         }

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/identityprofile/simple/IdentityProfileRequirementsPayload.java

@@ -0,0 +1,67 @@
+package com.yoti.api.client.docs.session.create.identityprofile.simple;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class IdentityProfileRequirementsPayload {
+
+    @JsonProperty("trust_framework")
+    private final String trustFramework;
+
+    @JsonProperty("scheme")
+    private final IdentityProfileSchemePayload scheme;
+
+    IdentityProfileRequirementsPayload(String trustFramework, IdentityProfileSchemePayload scheme) {
+        this.trustFramework = trustFramework;
+        this.scheme = scheme;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getTrustFramework() {
+        return trustFramework;
+    }
+
+    public IdentityProfileSchemePayload getScheme() {
+        return scheme;
+    }
+
+    public static class Builder {
+
+        private String trustFramework;
+        private IdentityProfileSchemePayload scheme;
+
+        Builder() {}
+
+        /**
+         * Sets the trust framework name for the Identity Profile requirement
+         *
+         * @param trustFramework the name of the trust framework
+         * @return the builder
+         */
+        public Builder withTrustFramework(String trustFramework) {
+            this.trustFramework = trustFramework;
+            return this;
+        }
+
+        /**
+         * Sets the scheme for the Identity Profile requirement
+         *
+         * @param scheme the scheme
+         * @return the builder
+         */
+        public Builder withScheme(IdentityProfileSchemePayload scheme) {
+            this.scheme = scheme;
+            return this;
+        }
+
+        public IdentityProfileRequirementsPayload build() {
+            return new IdentityProfileRequirementsPayload(trustFramework, scheme);
+        }
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/create/identityprofile/simple/IdentityProfileSchemePayload.java

@@ -0,0 +1,67 @@
+package com.yoti.api.client.docs.session.create.identityprofile.simple;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class IdentityProfileSchemePayload {
+
+    @JsonProperty("type")
+    private final String type;
+
+    @JsonProperty("objective")
+    private final String objective;
+
+    IdentityProfileSchemePayload(String type, String objective) {
+        this.type = type;
+        this.objective = objective;
+    }
+
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getObjective() {
+        return objective;
+    }
+
+    public static class Builder {
+
+        private String type;
+        private String objective;
+
+        Builder() {}
+
+        /**
+         * Sets the type of the scheme for the Identity Profile
+         *
+         * @param type the type of scheme
+         * @return the builder
+         */
+        public Builder withType(String type) {
+            this.type = type;
+            return this;
+        }
+
+        /**
+         * Sets the objective of the scheme for the Identity Profile
+         *
+         * @param objective the objective of the scheme
+         * @return the builder
+         */
+        public Builder withObjective(String objective) {
+            this.objective = objective;
+            return this;
+        }
+
+        public IdentityProfileSchemePayload build() {
+            return new IdentityProfileSchemePayload(type, objective);
+        }
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileReportResponse.java

@@ -0,0 +1,45 @@
+package com.yoti.api.client.docs.session.retrieve;
+
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class IdentityProfileReportResponse {
+
+    @JsonProperty("trust_framework")
+    private String trustFramework;
+
+    @JsonProperty("media")
+    private MediaResponse media;
+
+    @JsonProperty("schemes_compliance")
+    private List<IdentityProfileSchemeComplianceReportResponse> schemesCompliance;
+
+    /**
+     * The trust framework the report was generated for
+     *
+     * @return the trust framework
+     */
+    public String getTrustFramework() {
+        return trustFramework;
+    }
+
+    /**
+     * The media object containing the report
+     *
+     * @return the report media
+     */
+    public MediaResponse getMedia() {
+        return media;
+    }
+
+    /**
+     * The list of schemes used in the trust framework
+     *
+     * @return the list of schemes
+     */
+    public List<IdentityProfileSchemeComplianceReportResponse> getSchemesCompliance() {
+        return schemesCompliance;
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/docs/session/retrieve/IdentityProfileResponse.java

@@ -1,7 +1,5 @@
 package com.yoti.api.client.docs.session.retrieve;
 
-import java.util.Map;
-
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 public class IdentityProfileResponse {
@@ -16,7 +14,7 @@ public class IdentityProfileResponse {
     private IdentityProfileFailureResponse failureReason;
 
     @JsonProperty(Property.IDENTITY_PROFILE_REPORT)
-    private Map<String, Object> identityProfileReport;
+    private IdentityProfileReportResponse identityProfileReport;
 
     public String getSubjectId() {
         return subjectId;
@@ -30,7 +28,7 @@ public IdentityProfileFailureResponse getFailureReason() {
         return failureReason;
     }
 
-    public Map<String, Object> getIdentityProfileReport() {
+    public IdentityProfileReportResponse getIdentityProfileReport() {
         return identityProfileReport;
     }