smile-identity-core 2.2.2 → 2.2.5

data/examples/document_verification.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 
-# See https://docs.smileidentity.com/server-to-server/ruby/products/document-verification for
+# See https://docs.usesmileid.com/server-to-server/ruby/products/document-verification for
 # how to setup and retrieve configuation values for the WebApi class.
 
 # Initialize
@@ -17,7 +17,7 @@ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key
 partner_params = {
   user_id: '<put your unique ID for the user here>',
   job_id: '<put your unique job ID here>',
-  job_type: 6
+  job_type: 6,
 }
 
 # Create image list
@@ -33,27 +33,27 @@ partner_params = {
 image_details = [
   {
     image_type_id: '<0 | 2>',
-    image: '<full path to selfie image or base64image string>'
+    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: '<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>'
+    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>'
-  }
+    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
+  id_type: '<id type>', # The ID document type
 }
 
 # Set options for the job
@@ -67,7 +67,7 @@ options = {
   # 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
+  signature: true,
 }
 
 # Submit the job

data/examples/enhanced_document_verification.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'smile-identity-core'
+
+# See https://docs.usesmileid.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/examples/enhanced_kyc.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 
-# See https://docs.smileidentity.com/server-to-server/ruby/products/enhanced-kyc for
+# See https://docs.usesmileid.com/server-to-server/ruby/products/enhanced-kyc for
 # how to setup and retrieve configuation values for the IDApi class.
 
 # Initialize
@@ -16,7 +16,7 @@ connection = SmileIdentityCore::IDApi.new(partner_id, api_key, sid_server)
 partner_params = {
   job_id: '<put your unique job ID here>',
   user_id: '<put your unique ID for the user here>',
-  job_type: 5
+  job_type: 5,
 }
 
 # Create ID info
@@ -27,12 +27,12 @@ id_info = {
   id_type: '<id type>',
   id_number: '<valid id number>',
   dob: '<date of birth>', # yyyy-mm-dd
-  phone_number: '<phone number>'
+  phone_number: '<phone number>',
 }
 
 # Set the options for the job
 options = {
-  signature: true
+  signature: true,
 }
 
 # Submit the job

data/examples/example-project/README.md

@@ -1,6 +1,6 @@
 # Example Project
 
-This project is an example implementation of the Smile Identity Ruby SDK on the server side. The example implements [Enhanced KYC](https://docs.smileidentity.com/products/identity-lookup), [Biometric KYC](https://docs.smileidentity.com/products/biometric-kyc), [Document Verification](https://docs.smileidentity.com/products/document-verification) and [SmartSelfieTM Authentication](https://docs.smileidentity.com/products/biometric-authentication) job types.
+This project is an example implementation of the Smile Identity Ruby SDK on the server side. The example implements [Enhanced KYC](https://docs.usesmileid.com/products/identity-lookup), [Biometric KYC](https://docs.usesmileid.com/products/biometric-kyc), [Document Verification](https://docs.usesmileid.com/products/document-verification) and [SmartSelfieTM Authentication](https://docs.usesmileid.com/products/biometric-authentication) job types.
 
 ## Setup
 

data/examples/example-project/smart_bank.rb

@@ -11,11 +11,12 @@ class SmartBank
 
   def initialize
     # login to the Smile Identity portal to view your partner id
-    @partner_id = ENV['SMILE_PARTNER_ID']
-    # See https://docs.smileidentity.com/server-to-server/ruby/products/biometric-kyc#create-a-callback-endpoint
-    @default_callback = ENV['SMILE_JOB_CALLBACK_URL']
-    @api_key = ENV['SMILE_API_KEY'] # copy your API key from the Smile Identity portal
-    @sid_server = ENV['SMILE_SERVER_ENVIRONMENT'] # Use '0' for the sandbox server, use '1' for production server
+    @partner_id = ENV.fetch('SMILE_PARTNER_ID', nil)
+    # See https://docs.usesmileid.com/server-to-server/ruby/products/biometric-kyc#create-a-callback-endpoint
+    @default_callback = ENV.fetch('SMILE_JOB_CALLBACK_URL', nil)
+    @api_key = ENV.fetch('SMILE_API_KEY', nil) # copy your API key from the Smile Identity portal
+    # Use '0' for the sandbox server, use '1' for production server
+    @sid_server = ENV.fetch('SMILE_SERVER_ENVIRONMENT', nil)
     @user_id = SecureRandom.uuid # your unique ID for the user
     @job_id = SecureRandom.uuid # your unique job ID
   end
@@ -35,12 +36,12 @@ class SmartBank
       id_type: 'PASSPORT',
       id_number: 'G0000000',
       dob: '1992-12-07', # yyyy-mm-dd
-      phone_number: '00000000000'
+      phone_number: '00000000000',
     }
 
     # Set the options for the job
     options = {
-      signature: true
+      signature: true,
     }
 
     # Submit the job
@@ -57,13 +58,13 @@ class SmartBank
     image_details = [
       {
         image_type_id: SmileIdentityCore::ImageType::SELFIE_IMAGE_FILE,
-        image: '/path/to/selfie_image.jpeg'
+        image: '/path/to/selfie_image.jpeg',
       },
       { # 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: SmileIdentityCore::ImageType::LIVENESS_IMAGE_FILE,
-        image: '/path/to/liveness_image.jpeg'
-      }
+        image: '/path/to/liveness_image.jpeg',
+      },
     ]
 
     # Create ID number info
@@ -74,7 +75,7 @@ class SmartBank
       id_type: 'PASSPORT',
       id_number: 'G0000000',
       dob: '1992-12-07', # yyyy-mm-dd
-      entered: 'true' # must be a string
+      entered: 'true', # must be a string
     }
 
     # Submit the job
@@ -91,27 +92,27 @@ class SmartBank
     image_details = [
       {
         image_type_id: SmileIdentityCore::ImageType::SELFIE_IMAGE_FILE,
-        image: '/path/to/selfie_image.jpeg'
+        image: '/path/to/selfie_image.jpeg',
       },
       { # 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: SmileIdentityCore::ImageType::LIVENESS_IMAGE_FILE,
-        image: '/path/to/liveness_image.jpeg'
+        image: '/path/to/liveness_image.jpeg',
       },
       {
         image_type_id: SmileIdentityCore::ImageType::ID_CARD_IMAGE_FILE,
-        image: '/path/to/front_document_image.jpeg'
+        image: '/path/to/front_document_image.jpeg',
       },
       { # Optional, only use if you're uploading the back of the id document image
         image_type_id: SmileIdentityCore::ImageType::ID_CARD_BACK_IMAGE_FILE,
-        image: '/path/to/back_document_image.jpeg'
-      }
+        image: '/path/to/back_document_image.jpeg',
+      },
     ]
 
     # The ID Document Information
     id_info = {
       country: 'GH', # The country where ID document was issued
-      id_type: 'PASSPORT' # The ID document type
+      id_type: 'PASSPORT', # The ID document type
     }
 
     # Submit the job
@@ -128,20 +129,20 @@ class SmartBank
     partner_params = {
       user_id: '512c9c37-a689-4959-a620-bed75fb41344', # previously registered user's user_id
       job_id: SecureRandom.uuid, # new unique job ID
-      job_type: SmileIdentityCore::JobType::SMART_SELFIE_REGISTRATION
+      job_type: SmileIdentityCore::JobType::SMART_SELFIE_REGISTRATION,
     }
 
     # Create image list
     image_details = [
       {
         image_type_id: SmileIdentityCore::ImageType::SELFIE_IMAGE_FILE,
-        image: '/path/to/selfie_image.jpeg'
+        image: '/path/to/selfie_image.jpeg',
       },
       { # 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: SmileIdentityCore::ImageType::LIVENESS_IMAGE_FILE,
-        image: '/path/to/liveness_image.jpeg'
-      }
+        image: '/path/to/liveness_image.jpeg',
+      },
     ]
 
     # Submit the job
@@ -154,7 +155,7 @@ class SmartBank
     {
       user_id: user_id,
       job_id: job_id,
-      job_type: job_type
+      job_type: job_type,
     }
   end
 
@@ -175,7 +176,7 @@ class SmartBank
       # 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,
-      signature: true
+      signature: true,
     }
   end
 end
@@ -187,7 +188,7 @@ enhanced_kyc_response['success'] # => true
 enhanced_kyc_response['result']['PartnerParams']['job_id'] # job_id
 enhanced_kyc_response['result']['PartnerParams']['user_id'] # user_id
 enhanced_kyc_response['result']['PartnerParams']['job_type'] # => 5
-# See https://docs.smileidentity.com/products/for-individuals-kyc/identity-lookup#return-values
+# See https://docs.usesmileid.com/products/for-individuals-kyc/identity-lookup#return-values
 # for the full JSON response interpretation
 
 # Biometric KYC
@@ -212,5 +213,5 @@ smart_selfie_auth_response['result']['PartnerParams']['user_id'] # user_id
 smart_selfie_auth_response['result']['PartnerParams']['job_type'] # => 2
 
 # All jobs submitted with a selfie has the same return values, result codes and texts. For example
-# see https://docs.smileidentity.com/products/for-individuals-kyc/biometric-kyc#return-values.
+# see https://docs.usesmileid.com/products/for-individuals-kyc/biometric-kyc#return-values.
 # Save the returned user_id and job_id in your DB as you would need them later when you call other services.

data/examples/get_web_token.rb

@@ -3,7 +3,7 @@
 require 'smile-identity-core'
 require 'random/formatter'
 
-# See https://docs.smileidentity.com/server-to-server/ruby/products/biometric-kyc for
+# See https://docs.usesmileid.com/server-to-server/ruby/products/biometric-kyc for
 # how to setup and retrieve configuation values for the WebApi class.
 
 # Initialize
@@ -19,7 +19,7 @@ request_params = {
   user_id: '<your unique user id>',
   job_id: '<your unique job id>',
   product: '<smile identity product type>',
-  callback_url: '<your callback url>'
+  callback_url: '<your callback url>',
 }
 
 # Get web token

data/examples/smart_selfie_authentication.rb

@@ -2,7 +2,7 @@
 
 require 'smile-identity-core'
 
-# See https://docs.smileidentity.com/server-to-server/ruby/products/smartselfie-tm-authentication for
+# See https://docs.usesmileid.com/server-to-server/ruby/products/smartselfie-tm-authentication for
 # how to setup and retrieve configuation values for the WebApi class.
 
 # Initialize
@@ -17,7 +17,7 @@ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key
 partner_params = {
   user_id: '<put previously registered user"s user_id here>',
   job_id: '<put your unique job ID here>',
-  job_type: 2
+  job_type: 2,
 }
 
 # Create image list
@@ -29,13 +29,13 @@ partner_params = {
 image_details = [
   {
     image_type_id: '<0 | 2>',
-    image: '<full path to selfie image or base64image string>'
+    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: '<full path to liveness image or base64 image string>',
+  },
 ]
 
 # Set options for the job
@@ -49,7 +49,7 @@ options = {
   # 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
+  signature: true,
 }
 
 # Submit the job

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

@@ -8,7 +8,7 @@ module SmileIdentityCore
   ##
   # The AML Check product allows you to perform due diligence on your customers by screening them against
   # global watchlists, politically exposed persons lists, and adverse media publications.
-  # For more info visit https://docs.smileidentity.com/products/for-individuals-kyc/aml-check
+  # For more info visit https://docs.usesmileid.com/products/for-individuals-kyc/aml-check
   class AmlCheck
     include Validations
 
@@ -33,6 +33,7 @@ module SmileIdentityCore
     # @option opts [Array] :countries An array that takes the customer’s known nationalities in 2-character
     # (ISO 3166-1 alpha-2) format e.g. Nigeria is NG, Kenya is KE, etc
     # @option opts [boolean] :search_existing_user If you intend to re-use the name and year of birth
+    # @option opts [boolean] :strict_match If you want to perform a strict match on the serach criteria.
     # of a user’s previous KYC job
     # @option opts [Hash] :optional_info Any optional data, this will be returned
     # in partner_params.
@@ -51,6 +52,7 @@ module SmileIdentityCore
     def build_payload
       @payload = generate_signature
       @payload.merge!(@params)
+      @payload[:strict_match] = true unless @params.key?(:strict_match)
       add_partner_info
       add_sdk_info
       @payload
@@ -73,8 +75,8 @@ module SmileIdentityCore
 
     def submit_requests
       request = Typhoeus::Request.new("#{@url}/aml", method: 'POST',
-                                                     headers: { 'Content-Type' => 'application/json' },
-                                                     body: build_payload.to_json)
+        headers: { 'Content-Type' => 'application/json' },
+        body: build_payload.to_json)
 
       request.on_complete do |response|
         return response.body if response.success?

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

@@ -8,7 +8,7 @@ module SmileIdentityCore
   ##
   # The business verification product lets you search the business registration or
   # tax information (available in Nigeria only) of a business from one of our supported countries.
-  # For more info visit https://docs.smileidentity.com/products/for-businesses-kyb/business-verification
+  # For more info visit https://docs.usesmileid.com/products/for-businesses-kyb/business-verification
   class BusinessVerification
     include Validations
 
@@ -85,7 +85,7 @@ module SmileIdentityCore
         "#{@url}/business_verification",
         method: 'POST',
         headers: { 'Content-Type' => 'application/json' },
-        body: build_payload.to_json
+        body: build_payload.to_json,
       )
 
       request.on_complete do |response|

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

@@ -6,7 +6,7 @@ module SmileIdentityCore
   module ENV
     SID_SERVER_MAPPING = {
       '0' => 'https://testapi.smileidentity.com/v1',
-      '1' => 'https://api.smileidentity.com/v1'
+      '1' => 'https://api.smileidentity.com/v1',
     }.freeze
 
     TEST = '0'
@@ -15,10 +15,10 @@ module SmileIdentityCore
     module_function
 
     def determine_url(sid_server)
-      if sid_server.to_s !~ URI::DEFAULT_PARSER.make_regexp
-        SID_SERVER_MAPPING[sid_server.to_s] || sid_server
-      else
+      if sid_server.to_s =~ URI::DEFAULT_PARSER.make_regexp
         sid_server
+      else
+        SID_SERVER_MAPPING[sid_server.to_s] || sid_server
       end
     end
   end

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/id_api.rb

@@ -25,8 +25,8 @@ module SmileIdentityCore
 
       if partner_params[:job_type] == JobType::BUSINESS_VERIFICATION
         return SmileIdentityCore::BusinessVerification
-               .new(@partner_id, @api_key, @url)
-               .submit_job(partner_params, id_info)
+            .new(@partner_id, @api_key, @url)
+            .submit_job(partner_params, id_info)
       end
 
       options = symbolize_keys(options || {})
@@ -46,7 +46,7 @@ module SmileIdentityCore
         "#{@url}/#{endpoint}",
         method: 'POST',
         headers: { 'Content-Type' => 'application/json' },
-        body: configure_json
+        body: configure_json,
       )
 
       request.on_complete do |response|
@@ -63,14 +63,14 @@ module SmileIdentityCore
 
     def configure_json
       signature_generator.generate_signature(Time.now.to_s)
-                         .merge(@id_info)
-                         .merge(
-                           partner_id: @partner_id,
-                           partner_params: @partner_params,
-                           source_sdk: SmileIdentityCore::SOURCE_SDK,
-                           source_sdk_version: SmileIdentityCore::VERSION
-                         )
-                         .to_json
+        .merge(@id_info)
+        .merge(
+          partner_id: @partner_id,
+          partner_params: @partner_params,
+          source_sdk: SmileIdentityCore::SOURCE_SDK,
+          source_sdk_version: SmileIdentityCore::VERSION,
+        )
+        .to_json
     end
 
     def signature_generator

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

@@ -19,7 +19,7 @@ module SmileIdentityCore
       @signature = Base64.strict_encode64(hmac.digest)
       {
         signature: @signature,
-        timestamp: timestamp.to_s
+        timestamp: timestamp.to_s,
       }
     end
 

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

@@ -17,7 +17,7 @@ module SmileIdentityCore
       options[:return_image_links] ||= false
 
       query_job_status(configure_job_query(user_id, job_id,
-                                           options).merge(@signature_connection.generate_signature(Time.now.to_s)))
+        options).merge(@signature_connection.generate_signature(Time.now.to_s)))
     end
 
     private
@@ -29,9 +29,9 @@ module SmileIdentityCore
     def query_job_status(request_json_data)
       request = Typhoeus::Request.new(
         "#{@url}/job_status",
-        headers: { 'Content-Type': 'application/json', 'Accept': 'application/json' },
+        headers: { 'Content-Type': 'application/json', Accept: 'application/json' },
         method: :post,
-        body: request_json_data.to_json
+        body: request_json_data.to_json,
       )
 
       request.on_complete do |response|
@@ -47,8 +47,6 @@ module SmileIdentityCore
         raise 'Unable to confirm validity of the job_status response' unless valid
 
         return body
-      rescue StandardError => e
-        raise e
       end
 
       request.run
@@ -62,7 +60,7 @@ module SmileIdentityCore
         image_links: options[:return_image_links],
         history: options[:return_history],
         source_sdk: SmileIdentityCore::SOURCE_SDK,
-        source_sdk_version: SmileIdentityCore::VERSION
+        source_sdk_version: SmileIdentityCore::VERSION,
       }
     end
   end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SmileIdentityCore
-  module Validations   # :nodoc:
+  module Validations # :nodoc:
     def validate_partner_params(partner_params)
       raise ArgumentError, 'Please ensure that you send through partner params' if partner_params.nil?
 
@@ -10,7 +10,7 @@ module SmileIdentityCore
       %i[user_id job_id job_type].each do |key|
         if partner_params[key].to_s.empty?
           raise ArgumentError,
-                "Please make sure that #{key} is included in the partner params"
+            "Please make sure that #{key} is included in the partner params"
         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.5'
   SOURCE_SDK = 'Ruby'
 end