usesmileid 12.0.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b3aa92d6b398bde9e998a5e5b128c688a94ac72331b7f5be584df7008286458
-  data.tar.gz: f44668a9c23b92c59708176ba20153ef729b3f840431a3fd2fd32fab8121efa4
+  metadata.gz: 896bc049c137997c9de0181582b1bb2564e96fbba5bbbac64b640363e7f472b2
+  data.tar.gz: 7f8bda781a38427a40550e95af93dc0286523b2b41e30a0cc37ef482b6752b8b
 SHA512:
-  metadata.gz: 2f3017edcda29325e2b49d5a6824d20f6c649538044e840f2a6b08aea08d44d65fa9e8e07c821544519181726d9a3fa3853ee796c6216808c18169f094d65a5e
-  data.tar.gz: 146f765cb0b59e9aa473718c614ae3287fd94e064e51bca8f546755c09e1b3f4f60c22816c538041aeb01750c1728da2b9b3b3c65d0238edbe74a3a88106b289
+  metadata.gz: e0e6772c8b7f6466b8807943dbda2cc72e8e52564ffe745faf9b9bc5cb2623dd43ecae662fab88974ecb98ae780fd713cacc11014bd23157e458b10c5709f17f
+  data.tar.gz: 94a7ac44229e2d2e43c722a2113a72d589db9a8242ca5f4ec7b1febd7828f35841d15fe1183c713bd91468e45d569f1403a6f392d7f96b13d82e8f00a6ee7fc8

data/CHANGELOG.md

@@ -7,41 +7,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Changed
-
-- Renamed the gem from `smile-identity-core` to `smileid`. The require path
-  (`require "smileid"`) and the `SmileID` module are unchanged.
-- Set the version to 12.0.0, aligning the server SDKs with the V12 mobile
-  SDKs.
-- `base_url` must now be an absolute https URL with no query or fragment,
-  validated at construction. There is no allow-insecure option.
-- `default_callback_url` (at construction) and per-request `callback_url`
-  values (entry operations and replay) must be https; insecure values raise
-  a validation error before any request is sent.
-- `job_id` and `user_id` path parameters are URL-encoded as single path
-  segments before interpolation.
-- Multipart filenames and content types are sanitized against header
-  injection on every input path, including caller-supplied content types.
-  Filenames have control characters stripped and quotes encoded; content
-  types must be a valid media type.
+## [12.1.0] - 2026-10-01
 
 ### Added
 
-- `SmileID::Errors::UnexpectedResponseError`, raised when a 2xx success
-  response body is not the expected JSON object.
+- Residency Document Verification: `documents.verify_residency`.
 
-### Added
+## [12.0.0] - 2026-08-20
+
+First public release.
+
+### Products
+
+- Enhanced KYC, Biometric KYC, Document Verification and Enhanced Document
+  Verification.
+- SmartSelfie enrollment, authentication and compare.
+
+### Verifications
+
+- Job status retrieval, plus a `wait_until_complete` helper that polls until
+  a job reaches a terminal decision.
+- Callback replay.
+- User fraud reporting, with `flag_fraud` / `clear_fraud` convenience
+  wrappers.
+
+### Client
+
+- Sandbox and production environments, with a `base_url` override for other
+  hosts. `base_url` and callback URLs must be https, checked before any
+  request is sent.
+- Internal JWT authentication, cached and refreshed automatically on 401.
+- Automatic retries with backoff for idempotent calls.
+- Typed errors under `SmileID::Errors`, keyed on HTTP status.
+- Bank codes, supported ID types and supported documents lookups.
 
-- Full V3 API coverage: enhanced KYC, document verification, enhanced document
-  verification, biometric KYC, biometric enrollment, authentication and compare,
-  verification status with a `wait_until_complete` polling helper, callback
-  replay, fraud reporting (with `flag_fraud` / `clear_fraud` wrappers), and the
-  four services endpoints.
-- Internal JWT authentication with a thread-safe cache and a single automatic
-  refresh on 401.
-- Typed error hierarchy under `SmileID::Errors`, covering both API error body
-  shapes.
-- Automatic retries with exponential backoff and `Retry-After` support for
-  idempotent calls only.
-- Consent builder and client-side validation for user details and fraud
-  reports.
+[Unreleased]: https://github.com/smileidentity/smileid-sdk-ruby/compare/v12.1.0...HEAD
+[12.1.0]: https://github.com/smileidentity/smileid-sdk-ruby/compare/v12.0.0...v12.1.0
+[12.0.0]: https://github.com/smileidentity/smileid-sdk-ruby/releases/tag/v12.0.0

data/README.md

@@ -142,6 +142,26 @@ accepted = smile.documents.verify_enhanced(
 )
 ```
 
+### Residency document verification
+
+Same shape as enhanced document verification, plus the `visa` endorsed in the
+passport (JPEG or PNG). `id_type` is optional and defaults to `PASSPORT`, the
+only value accepted. The visa details arrive in
+`additional_documents` on the callback.
+
+```ruby
+accepted = smile.documents.verify_residency(
+  selfie_image: "selfie.jpg",
+  liveness_images: ["live1.jpg", "live2.jpg", "live3.jpg",
+                    "live4.jpg", "live5.jpg", "live6.jpg"],
+  document: "passport.jpg",
+  visa: "visa.jpg",
+  country: "ZA",
+  user_details: user_details,
+  consent: consent
+)
+```
+
 ### Biometric KYC
 
 ```ruby

data/lib/usesmileid/client/resources.rb

@@ -55,7 +55,8 @@ module SmileID
       end
     end
 
-    # POST /v3/document_verification and /v3/enhanced_document_verification
+    # POST /v3/document_verification, /v3/enhanced_document_verification and
+    # /v3/residency_document_verification
     class Documents < Base
       def verify(selfie_image:, liveness_images:, document:, consent:, country:, user_details:,
                  document_back: nil, id_type: nil, callback_url: nil,
@@ -87,6 +88,29 @@ module SmileID
                                                                user_id_header: user_id, timeout: timeout))
       end
 
+      # POST /v3/residency_document_verification. The document is a passport
+      # and the visa endorsed in it is read as well, so id_type defaults to, and must be, PASSPORT.
+      def verify_residency(selfie_image:, liveness_images:, document:, visa:, consent:,
+                           country:, user_details:, id_type: 'PASSPORT', document_back: nil,
+                           callback_url: nil, partner_params: nil, metadata: nil, user_id: nil, timeout: nil)
+        id_type = 'PASSPORT' if id_type.to_s.empty?
+        unless id_type.to_s == 'PASSPORT'
+          raise Errors::ValidationError.new('id_type must be PASSPORT for residency document verification')
+        end
+        if visa.nil? || (visa.respond_to?(:empty?) && visa.empty?)
+          raise Errors::ValidationError.new('visa is required for residency document verification')
+        end
+
+        form = document_form(
+          selfie_image: selfie_image, liveness_images: liveness_images, document: document,
+          document_back: document_back, consent: consent, country: country, id_type: id_type,
+          user_details: user_details, callback_url: callback_url,
+          partner_params: partner_params, metadata: metadata
+        ).merge('visa' => visa)
+        accepted(@client.call(:residency_document_verification, form: form,
+                                                                user_id_header: user_id, timeout: timeout))
+      end
+
       private
 
       def document_form(selfie_image:, liveness_images:, document:, document_back:, consent:,

data/lib/usesmileid/generated/operations.rb

@@ -33,6 +33,11 @@ module SmileID
           partner_id_header: true, body_kind: :multipart, idempotent: false,
           success_statuses: [202]
         ),
+        residency_document_verification: Operation.new(
+          http_method: :post, path: '/v3/residency_document_verification', authenticated: true,
+          partner_id_header: true, body_kind: :multipart, idempotent: false,
+          success_statuses: [202]
+        ),
         biometric_kyc: Operation.new(
           http_method: :post, path: '/v3/biometric_kyc', authenticated: true,
           partner_id_header: true, body_kind: :multipart, idempotent: false,

data/lib/usesmileid/helpers/multipart.rb

@@ -21,7 +21,7 @@ module SmileID
       # Fields serialized as JSON parts.
       JSON_PART_FIELDS = %w[consent user_details partner_params metadata].freeze
       # Single binary fields.
-      BINARY_FIELDS = %w[selfie_image document document_back comparison_image].freeze
+      BINARY_FIELDS = %w[selfie_image document document_back visa comparison_image].freeze
       # Repeated binary fields.
       BINARY_ARRAY_FIELDS = %w[liveness_images].freeze
 
@@ -29,13 +29,14 @@ module SmileID
         'selfie_image' => 'image/jpeg',
         'document' => 'image/jpeg',
         'document_back' => 'image/jpeg',
+        'visa' => 'image/jpeg',
         'comparison_image' => 'image/jpeg',
         'liveness_images' => 'image/jpeg'
       }.freeze
 
-      # Only document and document_back may be PNG (spec section 5.3 rule 3);
+      # Only document, document_back and visa may be PNG (spec section 5.3 rule 3);
       # selfie, liveness and comparison images are always image/jpeg.
-      PNG_CAPABLE_FIELDS = %w[document document_back].freeze
+      PNG_CAPABLE_FIELDS = %w[document document_back visa].freeze
       PNG_MAGIC = "\x89PNG".b.freeze
 
       # RFC 6838 type/subtype tokens — anything else is rejected before send.
@@ -45,6 +46,7 @@ module SmileID
         'selfie_image' => 'selfie.jpg',
         'document' => 'document.jpg',
         'document_back' => 'document_back.jpg',
+        'visa' => 'visa.jpg',
         'comparison_image' => 'comparison.jpg'
       }.freeze
 

data/lib/usesmileid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmileID
-  VERSION = '12.0.0'
+  VERSION = '12.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usesmileid
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.0
 platform: ruby
 authors:
 - Smile Identity
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-20 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday