smile-identity-core 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab854f61f188586b70f98ef4a0766575e308343bae0fc5e73b2c748c876ce83e
-  data.tar.gz: e8c2f3ac08e780dff638e8754aab74567ddccc84ac97d68e95d2fb5fa596c97e
+  metadata.gz: 1b08d29788e9df7942697da8ef9391fdc7200e5d31ac8b0e6520649d9051fbc0
+  data.tar.gz: 4e27841299e6c26392883a14d38a72ae104195df8cc06492bb27457198a96e89
 SHA512:
-  metadata.gz: 8f98bb6732acb0ac767590b6c15beb41c32cf411dc95b9d18a3a4af1cc92a672717442398d049efffbfd000f84c83ab9e71d2403342cda79cf4f504a5900fdd4
-  data.tar.gz: 102f5e6e96c23e3407600591697eaf0f0bc26cf55bd37061eff5555544a07452927988f9001227a60874a2ec3107b9b47a38c75591cd5698852df2b9f1ed9d4d
+  metadata.gz: b08f43d9d9849048f18adb39ef3553c442cdf5aa2ccb4e77a97048df1b2b1a0b72a36fa2d8c0750e13177d9b7a2db987d7f3746c5218f771402da047721cc73b
+  data.tar.gz: febc9a1df0e0535fc93f3fc4d7562ee118f0f87031445da6ddc2ec2c91e5a9c52df27c05e8bc0e4db4377b81924e9f26e8b87b1594583e8554495923e898be54

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.3] - 2023-10-20
+## Added
+- Adds support for Enhanced Document Verification
+
 ## [Unreleased]
 
 ## [2.2.2] - 2023-10-05

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (2.2.2)
+    smile-identity-core (2.2.3)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -13,7 +13,7 @@ GEM
     docile (1.4.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     json (2.5.1)
     parallel (1.22.1)
     parser (3.1.2.1)

data/examples/enhanced_document_verification.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+
+# See https://docs.smileidentity.com/server-to-server/ruby/products/enhanced_document-verification for
+# how to setup and retrieve configuation values for the WebApi class.
+
+# Initialize
+partner_id = '<Put your partner ID here>'; # login to the Smile Identity portal to view your partner id
+default_callback = '<Put your default callback url here>'
+api_key = '<Put your API key here>'; # copy your API key from the Smile Identity portal
+sid_server = '<0 | 1>'; # Use '0' for the sandbox server, use '1' for production server
+
+connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+
+# Create required tracking parameters
+partner_params = {
+  user_id: '<put your unique ID for the user here>',
+  job_id: '<put your unique job ID here>',
+  job_type: 11
+}
+
+# Create image list
+# image_type_id (Integer) - This infers to either a file or a base64 encoded image, but not both.
+# 0 - Selfie image jpg or png (if you have the full path of the selfie)
+# 2 - Selfie image jpg or png base64 encoded (if you have the base64image string of the selfie)
+# 4 - Liveness image jpg or png (if you have the full path of the liveness image)
+# 6 - Liveness image jpg or png base64 encoded (if you have the base64image string of the liveness image)
+# 1 - Front of ID document image jpg or png (if you have the full path of the selfie)
+# 3 - Front of ID document image jpg or png base64 encoded (if you have the base64image string of the selfie)
+# 5 - Back of ID document image jpg or png (if you have the full path of the selfie)
+# 7 - Back of ID document image jpg or png base64 encoded (if you have the base64image string of the selfie)
+image_details = [
+  {
+    image_type_id: '<0 | 2>',
+    image: '<full path to selfie image or base64image string>'
+  },
+  { # Not required if you don't require proof of life (note photo of photo check
+    # will still be performed on the uploaded selfie)
+    image_type_id: '<4 | 6>',
+    image: '<full path to liveness image or base64 image string>'
+  },
+  {
+    image_type_id: '<1 | 3>',
+    image: '<full path to front of id document image or base64image string>'
+  },
+  { # Optional, only use if you're uploading the back of the id document image
+    image_type_id: '<5 | 7>',
+    image: '<full path to back of id document image or base64image string>'
+  }
+]
+
+# The ID Document Information
+id_info = {
+  country: '<2-letter country code>', # The country where ID document was issued
+  id_type: '<id type>' # The ID document type
+}
+
+# Set options for the job
+options = {
+  # Set to true if you want to get the job result in sync (in addition to the result
+  # been sent to your callback). If set to false, result is sent to callback url only.
+  return_job_status: '<true | false>',
+  # Set to true to receive all of the updates you would otherwise have received in your
+  # callback as opposed to only the final result. You must set return_job_status to true to use this flag.
+  return_history: '<true | false>',
+  # Set to true to receive links to the selfie and the photo it was compared to.
+  # You must set return_job_status to true to use this flag.
+  return_image_links: '<true |false>',
+  signature: true
+}
+
+# Submit the job
+connection.submit_job(partner_params, image_details, id_info, options)

data/lib/smile-identity-core/constants/job_type.rb

@@ -25,5 +25,9 @@ module SmileIdentityCore
     # Performs due diligence by screening against global watchlists,
     # politically exposed persons lists, and adverse media publications
     AML = 10
+    # Verifies the authenticity of Document IDs and confirms their validity
+    # with an ID authority, and uses biometric checks to confirm they
+    # belong to the user.
+    ENHANCED_DOCUMENT_VERIFICATION = 11
   end
 end

data/lib/smile-identity-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module SmileIdentityCore
-  VERSION = '2.2.2'
+  VERSION = '2.2.3'
   SOURCE_SDK = 'Ruby'
 end

data/lib/smile-identity-core/web_api.rb

@@ -85,16 +85,18 @@ module SmileIdentityCore
       updated_id_info[:entered] = 'false' if !updated_id_info.key?(:entered) || id_info[:entered].empty?
 
       # if it's a boolean
-      updated_id_info[:entered] = id_info[:entered].to_s if !updated_id_info[:entered].nil? == updated_id_info[:entered]
+      updated_id_info[:entered] = id_info[:entered].to_s
 
       is_jt6 = @partner_params[:job_type].to_i == JobType::DOCUMENT_VERIFICATION
-      keys = if is_jt6
+      is_jt11 = @partner_params[:job_type].to_i == JobType::ENHANCED_DOCUMENT_VERIFICATION
+      keys = if is_jt6 || is_jt11
                %i[country]
              else
                %i[country id_type id_number]
              end
+      keys.push(:id_type) if is_jt11
 
-      if updated_id_info[:entered] == 'true' || is_jt6
+      if updated_id_info[:entered] == 'true' || is_jt6 || is_jt11
         keys.each do |key|
           raise ArgumentError, "Please make sure that #{key} is included in the id_info" if id_info[key].to_s.empty?
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Smile Identity
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ files:
 - examples/biometric_kyc.rb
 - examples/business_verification.rb
 - examples/document_verification.rb
+- examples/enhanced_document_verification.rb
 - examples/enhanced_kyc.rb
 - examples/example-project/Gemfile
 - examples/example-project/Gemfile.lock