Merge pull request #292 from getyoti/release/3.11.0

Release/3.11.0
getyoti · Jan 9, 2024 · 8c273b7 · 8c273b7
2 parents 374fda8 + 07cfab0
commit 8c273b7
Show file tree

Hide file tree

Showing 23 changed files with 1,113 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -41,7 +41,8 @@ import "github.com/getyoti/yoti-go-sdk/v3"
 ```
 or add the following line to your go.mod file (check https://github.com/getyoti/yoti-go-sdk/releases for the latest version)
 ```
-require github.com/getyoti/yoti-go-sdk/v3 v3.10.0
+
+require github.com/getyoti/yoti-go-sdk/v3 v3.11.0
 ```
 
 ## Setup

diff --git a/_examples/idv/handlers.session.go b/_examples/idv/handlers.session.go
@@ -52,6 +52,20 @@ func showDBSPage(c *gin.Context) {
 	pageFromSessionSpec(c, sessionSpec)
 }
 
+func showAdvancedIdentityProfilePage(c *gin.Context) {
+	sessionSpec, err := buildAdvancedIdentityProfileSessionSpec()
+	if err != nil {
+		c.HTML(
+			http.StatusInternalServerError,
+			"error.html",
+			gin.H{
+				"ErrorTitle":   "Error when building sessions spec",
+				"ErrorMessage": err.Error()})
+		return
+	}
+	pageFromSessionSpec(c, sessionSpec)
+}
+
 func pageFromSessionSpec(c *gin.Context, sessionSpec *create.SessionSpecification) {
 	err := initialiseDocScanClient()
 	if err != nil {
@@ -209,3 +223,11 @@ func showPrivacyPolicyPage(c *gin.Context) {
 	render(c, gin.H{}, "privacy.html")
 	return
 }
+
+func showErrorPage(c *gin.Context) {
+	render(c, gin.H{
+		"ErrorTitle":   "Error Code",
+		"ErrorMessage": c.Request.URL.Query().Get("yotiErrorCode")},
+		"error.html")
+	return
+}
diff --git a/_examples/idv/models.sessionspec.go b/_examples/idv/models.sessionspec.go
@@ -13,7 +13,7 @@ import (
 func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 	var faceMatchCheck *check.RequestedFaceMatchCheck
 	faceMatchCheck, err = check.NewRequestedFaceMatchCheckBuilder().
-		WithManualCheckAlways().
+		WithManualCheckFallback().
 		Build()
 	if err != nil {
 		return nil, err
@@ -28,8 +28,8 @@ func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 
 	var livenessCheck *check.RequestedLivenessCheck
 	livenessCheck, err = check.NewRequestedLivenessCheckBuilder().
-		ForZoomLiveness().
-		WithMaxRetries(5).
+		ForStaticLiveness().
+		WithMaxRetries(3).
 		Build()
 	if err != nil {
 		return nil, err
@@ -71,7 +71,7 @@ func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 
 	var textExtractionTask *task.RequestedTextExtractionTask
 	textExtractionTask, err = task.NewRequestedTextExtractionTaskBuilder().
-		WithManualCheckAlways().
+		WithManualCheckFallback().
 		WithExpandedDocumentFields(true).
 		Build()
 	if err != nil {
@@ -80,7 +80,7 @@ func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 
 	var supplementaryDocTextExtractionTask *task.RequestedSupplementaryDocTextExtractionTask
 	supplementaryDocTextExtractionTask, err = task.NewRequestedSupplementaryDocTextExtractionTaskBuilder().
-		WithManualCheckAlways().
+		WithManualCheckFallback().
 		Build()
 	if err != nil {
 		return nil, err
@@ -98,6 +98,7 @@ func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 		WithErrorUrl("https://localhost:8080/error").
 		WithPrivacyPolicyUrl("https://localhost:8080/privacy-policy").
 		WithIdDocumentTextExtractionGenericAttempts(2).
+		WithAllowHandOff(true).
 		Build()
 	if err != nil {
 		return nil, err
@@ -158,7 +159,7 @@ func buildSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
 
 	sessionSpec, err = create.NewSessionSpecificationBuilder().
 		WithClientSessionTokenTTL(600).
-		WithResourcesTTL(90000).
+		WithResourcesTTL(87000).
 		WithUserTrackingID("some-tracking-id").
 		WithRequestedCheck(faceMatchCheck).
 		WithRequestedCheck(documentAuthenticityCheck).
@@ -203,7 +204,8 @@ func buildDBSSessionSpec() (sessionSpec *create.SessionSpecification, err error)
 	identityProfile := []byte(`{
 		"trust_framework": "UK_TFIDA",
 		"scheme": {
-    		"type": "RTW"
+    		"type": "DBS",
+    		"objective": "BASIC"
 		}
 	}`)
 
@@ -220,8 +222,8 @@ func buildDBSSessionSpec() (sessionSpec *create.SessionSpecification, err error)
 	}`)
 
 	sessionSpec, err = create.NewSessionSpecificationBuilder().
-		WithClientSessionTokenTTL(6000).
-		WithResourcesTTL(900000).
+		WithClientSessionTokenTTL(600).
+		WithResourcesTTL(87000).
 		WithUserTrackingID("some-tracking-id").
 		WithSDKConfig(sdkConfig).
 		WithIdentityProfileRequirements(identityProfile).
@@ -232,3 +234,59 @@ func buildDBSSessionSpec() (sessionSpec *create.SessionSpecification, err error)
 
 	return sessionSpec, nil
 }
+
+func buildAdvancedIdentityProfileSessionSpec() (sessionSpec *create.SessionSpecification, err error) {
+	var sdkConfig *create.SDKConfig
+	sdkConfig, err = create.NewSdkConfigBuilder().
+		WithAllowsCameraAndUpload().
+		WithPrimaryColour("#2d9fff").
+		WithSecondaryColour("#FFFFFF").
+		WithFontColour("#FFFFFF").
+		WithLocale("en-GB").
+		WithPresetIssuingCountry("GBR").
+		WithSuccessUrl("https://localhost:8080/success").
+		WithErrorUrl("https://localhost:8080/error").
+		WithPrivacyPolicyUrl("https://localhost:8080/privacy-policy").
+		Build()
+	if err != nil {
+		return nil, err
+	}
+
+	advancedIdentityProfile := []byte(`{
+		"profiles": [
+			{
+				"trust_framework": "UK_TFIDA",
+				"schemes": [
+					{
+						"label": "LB912",
+						"type": "RTW"
+					}
+				]
+			},
+			{
+				"trust_framework": "YOTI_GLOBAL",
+				"schemes": [
+					{
+						"label": "LB321",
+						"type": "IDENTITY",
+						"objective": "AL_L1"
+					}
+				]
+			}
+		]
+	}`)
+
+	subject := []byte(`{
+		"subject_id": "unique-user-id-for-examples"
+	}`)
+
+	return create.NewSessionSpecificationBuilder().
+		WithClientSessionTokenTTL(6000).
+		WithResourcesTTL(900000).
+		WithUserTrackingID("some-tracking-id").
+		WithSDKConfig(sdkConfig).
+		WithAdvancedIdentityProfileRequirements(advancedIdentityProfile).
+		WithCreateIdentityProfilePreview(true).
+		WithSubject(subject).
+		Build()
+}
diff --git a/_examples/idv/routes.go b/_examples/idv/routes.go
@@ -9,7 +9,9 @@ func initializeRoutes() {
 	// Handle the index route
 	router.GET("/", showIndexPage)
 	router.GET("/dbs", showDBSPage)
+	router.GET("/advanced", showAdvancedIdentityProfilePage)
 	router.GET("/success", showSuccessPage)
 	router.GET("/media", getMedia)
 	router.GET("/privacy-policy", showPrivacyPolicyPage)
+	router.GET("/error", showErrorPage)
 }
diff --git a/_examples/idv/templates/success.html b/_examples/idv/templates/success.html
@@ -76,6 +76,35 @@ <h2>Identity Profile</h2>
     {{ end }}
     {{ end }}
     {{ end }}
+    {{ if .getSessionResult.AdvancedIdentityProfileResponse }}
+    <div class="row pt-4">
+        <div class="col">
+            <h2>Advanced Identity Profile</h2>
+        </div>
+    </div>
+    {{ $media := index .getSessionResult.AdvancedIdentityProfileResponse.Report "media"}}
+    {{ if $media }}
+    {{ $media_id := index $media "id" }}
+    {{ if $media_id }}
+    <div class="row pt-4">
+        <div class="col">
+            <table class="table table-striped table-light">
+                <tbody>
+                <tr>
+                    <td>ID</td>
+                    <td>
+                        <a href='/media?mediaId={{ $media_id }}'>
+                            {{ $media_id }}
+                        </a>
+                    </td>
+                </tr>
+                </tbody>
+            </table>
+        </div>
+    </div>
+    {{ end }}
+    {{ end }}
+    {{ end }}
     {{ if .getSessionResult.IdentityProfilePreview }}
     <div class="row pt-4">
         <div class="col">
@@ -99,6 +128,29 @@ <h2>Identity Profile Preview</h2>
         </div>
     </div>
     {{ end }}
+    {{ if .getSessionResult.AdvancedIdentityProfilePreview }}
+        <div class="row pt-4">
+            <div class="col">
+                <h2>Advanced Identity Profile Preview</h2>
+            </div>
+        </div>
+        <div class="row pt-4">
+            <div class="col">
+                <table class="table table-striped table-light">
+                    <tbody>
+                    <tr>
+                        <td>ID</td>
+                        <td>
+                            <a href='/media?mediaId={{ .getSessionResult.AdvancedIdentityProfilePreview.Media.ID }}'>
+                                {{ .getSessionResult.AdvancedIdentityProfilePreview.Media.ID }}
+                            </a>
+                        </td>
+                    </tr>
+                    </tbody>
+                </table>
+            </div>
+        </div>
+    {{ end }}
     {{ if .getSessionResult.ImportTokenResponse }}
     <div class="row pt-4">
         <div class="col">
@@ -812,15 +864,15 @@ <h2>Static Liveness Resources</h2>
                 <tr>
                     <td>ID</td>
                     <td>{{ $liveness.ID }}
-                        
+
                     </td>
                 </tr>
-                 
+
                 </tbody>
             </table>
 
             <div class="accordion mt-3">
-                
+
                     <div class="card">
                         <div class="card-header" id="liveness-{{ $livenessNum }}-frames">
                             <h3 class="mb-0">
@@ -835,18 +887,18 @@ <h3 class="mb-0">
                         <div id="collapse-liveness-{{ $livenessNum }}-frames" class="collapse"
                              aria-labelledby="liveness-{{ $livenessNum }}-frames">
                             <div class="card-group">
-                                
+
                                         <div class="card">
                                             <img class="card-img-top"
                     src="/media?mediaId={{ $liveness.Image.Media.ID }}"/>
                                         </div>
-                                 
+
                             </div>
                         </div>
                     </div>
-                
+
             </div>
-            
+
         </div>
     </div>
 {{ end }}

diff --git a/_examples/profile/.env.example b/_examples/profile/.env.example
@@ -1,3 +1,5 @@
 YOTI_SCENARIO_ID=
 YOTI_CLIENT_SDK_ID=
 YOTI_KEY_FILE_PATH=
+# Optional configuration
+YOTI_API_URL=
diff --git a/_examples/profile/advancedIdentityProfile.go b/_examples/profile/advancedIdentityProfile.go
@@ -0,0 +1,65 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/getyoti/yoti-go-sdk/v3/dynamic"
+)
+
+func advancedIdentityProfile(w http.ResponseWriter, req *http.Request) {
+	advancedIdentityProfile := []byte(`{
+		"profiles": [
+			{
+				"trust_framework": "UK_TFIDA",
+				"schemes": [
+					{
+						"label": "LB912",
+						"type": "RTW"
+					}
+				]
+			},
+			{
+				"trust_framework": "YOTI_GLOBAL",
+				"schemes": [
+					{
+						"label": "LB321",
+						"type": "IDENTITY",
+						"objective": "AL_L1"
+					}
+				]
+			}
+		]
+	}`)
+
+	policy, err := (&dynamic.PolicyBuilder{}).
+		WithAdvancedIdentityProfileRequirements(advancedIdentityProfile).
+		Build()
+	if err != nil {
+		errorPage(w, req.WithContext(context.WithValue(
+			req.Context(),
+			contextKey("yotiError"),
+			fmt.Sprintf(scenarioBuilderErr, err),
+		)))
+		return
+	}
+
+	subject := []byte(`{
+		"subject_id": "my_subject_id"
+	}`)
+	scenario, err := (&dynamic.ScenarioBuilder{}).
+		WithPolicy(policy).
+		WithSubject(subject).
+		WithCallbackEndpoint(profileEndpoint).Build()
+	if err != nil {
+		errorPage(w, req.WithContext(context.WithValue(
+			req.Context(),
+			contextKey("yotiError"),
+			fmt.Sprintf(scenarioBuilderErr, err),
+		)))
+		return
+	}
+
+	pageFromScenario(w, req, "Advanced Identity Profile Example", scenario)
+}
diff --git a/_examples/profile/main.go b/_examples/profile/main.go
@@ -72,6 +72,7 @@ func main() {
 	http.HandleFunc("/dynamic-share", dynamicShare)
 	http.HandleFunc("/source-constraints", sourceConstraints)
 	http.HandleFunc("/dbs-check", dbsCheck)
+	http.HandleFunc("/advanced", advancedIdentityProfile)
 
 	rootdir, err := os.Getwd()
 	if err != nil {

diff --git a/consts/version.go b/consts/version.go
@@ -2,5 +2,5 @@ package consts
 
 const (
 	SDKIdentifier        = "Go"
-	SDKVersionIdentifier = "3.10.0"
+	SDKVersionIdentifier = "3.11.0"
 )