onfido 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb529a3e1878553b602345173a70d9eca693eed629ae5bda60cd68ddb04b21a0
-  data.tar.gz: '09845784b34ca211cfad3b3a26c394007d4c1feb992e705a59397bc5b09b90fc'
+  metadata.gz: e12865830296f564d8b260c71944db655a54ea3e936d49e884604c1dac5f5004
+  data.tar.gz: 7924185844e0d402651d07fb9dfb05cb82564d1aa73dfc511629ca64cc41f36f
 SHA512:
-  metadata.gz: b69846bf32e944d33210bc7ad1ea53005c07beed23fe5fddabb4bed296fa09f07598d7e90b1d937bbe3132cfb9d04911b761537724d709790cdefa01312cb9dc
-  data.tar.gz: 753949e7b75eced4bb13d2fd3e0fa255865436c5bb81bbbb6b986c79a3b0ae2fbf91d3b91497e54a0d9254b0c19a7c0a0ddab8e25aa5b1943c4c033bf8cc792b
+  metadata.gz: 874496bd9bab433e899eef7f4d688853c67fc907ac1fbee6059788a905a6b0090d84ab07b990fe24c77e498f1f0a590899aa5f6638ecf4945c0d0ec93fef4e3f
+  data.tar.gz: 613aa1333a9c2314a9adf1d30e112e94280d04f45e13d5339a4de2bbde351d2971d3816e8b6a5c38c572d376906af2e0386ea34614b774e9c92746213d0aa3dd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v6.2.0 21st May 2026
+
+- Release based on Onfido OpenAPI spec version [v6.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.1.0):
+  - Add Oauth2ClientCredentials support
+  - Fix ruby oauth token exchange url
+
 ## v6.1.0 6th May 2026
 
 - Release based on Onfido OpenAPI spec version [v6.0.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.0.1):

data/README.md

@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem 'onfido', '~> 6.2.0'
+gem 'onfido', '~> 6.3.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):

data/lib/onfido/api/default_api.rb

@@ -2176,6 +2176,75 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Retrieve biometric token
+    # Returns a biometric token's details. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param [Hash] opts the optional parameters
+    # @return [BiometricTokenResponse]
+    def find_biometric_token(user_id, token_uuid, opts = {})
+      data, _status_code, _headers = find_biometric_token_with_http_info(user_id, token_uuid, opts)
+      data
+    end
+
+    # Retrieve biometric token
+    # Returns a biometric token's details. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BiometricTokenResponse, Integer, Hash)>] BiometricTokenResponse data, response status code and response headers
+    def find_biometric_token_with_http_info(user_id, token_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.find_biometric_token ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.find_biometric_token"
+      end
+      # verify the required parameter 'token_uuid' is set
+      if @api_client.config.client_side_validation && token_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.find_biometric_token"
+      end
+      # resource path
+      local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BiometricTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.find_biometric_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#find_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a Check
     # Retrieves a single check. Returns a check object. 
     # @param check_id [String] 
@@ -3207,6 +3276,138 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Invalidate biometric token
+    # Invalidates a biometric token. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param [Hash] opts the optional parameters
+    # @return [InvalidatedBiometricTokenResponse]
+    def invalidate_biometric_token(user_id, token_uuid, opts = {})
+      data, _status_code, _headers = invalidate_biometric_token_with_http_info(user_id, token_uuid, opts)
+      data
+    end
+
+    # Invalidate biometric token
+    # Invalidates a biometric token. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvalidatedBiometricTokenResponse, Integer, Hash)>] InvalidatedBiometricTokenResponse data, response status code and response headers
+    def invalidate_biometric_token_with_http_info(user_id, token_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.invalidate_biometric_token ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.invalidate_biometric_token"
+      end
+      # verify the required parameter 'token_uuid' is set
+      if @api_client.config.client_side_validation && token_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.invalidate_biometric_token"
+      end
+      # resource path
+      local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvalidatedBiometricTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.invalidate_biometric_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#invalidate_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Invalidate biometric tokens
+    # Invalidates every biometric token associated with the supplied customer user ID. 
+    # @param user_id [String] Customer user ID whose biometric tokens will be invalidated.
+    # @param [Hash] opts the optional parameters
+    # @return [InvalidatedBiometricTokensResponse]
+    def invalidate_biometric_tokens(user_id, opts = {})
+      data, _status_code, _headers = invalidate_biometric_tokens_with_http_info(user_id, opts)
+      data
+    end
+
+    # Invalidate biometric tokens
+    # Invalidates every biometric token associated with the supplied customer user ID. 
+    # @param user_id [String] Customer user ID whose biometric tokens will be invalidated.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InvalidatedBiometricTokensResponse, Integer, Hash)>] InvalidatedBiometricTokensResponse data, response status code and response headers
+    def invalidate_biometric_tokens_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.invalidate_biometric_tokens ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.invalidate_biometric_tokens"
+      end
+      # resource path
+      local_var_path = '/biometric_tokens/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InvalidatedBiometricTokensResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.invalidate_biometric_tokens",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#invalidate_biometric_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Applicants
     # Lists all applicants you've created, sorted by creation date in descending order. 
     # @param [Hash] opts the optional parameters
@@ -3273,6 +3474,69 @@ module Onfido
       return data, status_code, headers
     end
 
+    # List biometric tokens
+    # Returns the biometric tokens associated with the supplied customer user ID. 
+    # @param user_id [String] Customer user ID that owns the biometric tokens.
+    # @param [Hash] opts the optional parameters
+    # @return [BiometricTokensResponse]
+    def list_biometric_tokens(user_id, opts = {})
+      data, _status_code, _headers = list_biometric_tokens_with_http_info(user_id, opts)
+      data
+    end
+
+    # List biometric tokens
+    # Returns the biometric tokens associated with the supplied customer user ID. 
+    # @param user_id [String] Customer user ID that owns the biometric tokens.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BiometricTokensResponse, Integer, Hash)>] BiometricTokensResponse data, response status code and response headers
+    def list_biometric_tokens_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.list_biometric_tokens ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.list_biometric_tokens"
+      end
+      # resource path
+      local_var_path = '/biometric_tokens/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BiometricTokensResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.list_biometric_tokens",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#list_biometric_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve Checks
     # Retrieves a single check. Returns a check object. 
     # @param applicant_id [String] 
@@ -3974,6 +4238,75 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Retrieve watchlist mesh alert risks
+    # Retrieves the detailed risks associated with a watchlist mesh alert. 
+    # @param alert_id [String] The unique identifier of the alert whose risks you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to retrieve. (default to 1)
+    # @option opts [Integer] :per_page The number of risks to return per page. (default to 25)
+    # @return [Array<WatchlistMeshAlertRisk>]
+    def list_watchlist_mesh_alert_risks(alert_id, opts = {})
+      data, _status_code, _headers = list_watchlist_mesh_alert_risks_with_http_info(alert_id, opts)
+      data
+    end
+
+    # Retrieve watchlist mesh alert risks
+    # Retrieves the detailed risks associated with a watchlist mesh alert. 
+    # @param alert_id [String] The unique identifier of the alert whose risks you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page of results to retrieve. (default to 1)
+    # @option opts [Integer] :per_page The number of risks to return per page. (default to 25)
+    # @return [Array<(Array<WatchlistMeshAlertRisk>, Integer, Hash)>] Array<WatchlistMeshAlertRisk> data, response status code and response headers
+    def list_watchlist_mesh_alert_risks_with_http_info(alert_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.list_watchlist_mesh_alert_risks ...'
+      end
+      # verify the required parameter 'alert_id' is set
+      if @api_client.config.client_side_validation && alert_id.nil?
+        fail ArgumentError, "Missing the required parameter 'alert_id' when calling DefaultApi.list_watchlist_mesh_alert_risks"
+      end
+      # resource path
+      local_var_path = '/complyadvantage_watchlists/alerts/{alert_id}/risks'.sub('{' + 'alert_id' + '}', CGI.escape(alert_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<WatchlistMeshAlertRisk>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.list_watchlist_mesh_alert_risks",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#list_watchlist_mesh_alert_risks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List matches (BETA)
     # List match IDs on this monitor, as well as their enabled/disabled status 
     # @param monitor_id [String] 
@@ -4699,6 +5032,86 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Update biometric token
+    # Updates a biometric token's status. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param biometric_token_updater [BiometricTokenUpdater] Biometric token update payload.
+    # @param [Hash] opts the optional parameters
+    # @return [UpdatedBiometricTokenResponse]
+    def update_biometric_token(user_id, token_uuid, biometric_token_updater, opts = {})
+      data, _status_code, _headers = update_biometric_token_with_http_info(user_id, token_uuid, biometric_token_updater, opts)
+      data
+    end
+
+    # Update biometric token
+    # Updates a biometric token&#39;s status. 
+    # @param user_id [String] Customer user ID that owns the biometric token.
+    # @param token_uuid [String] Biometric token UUID.
+    # @param biometric_token_updater [BiometricTokenUpdater] Biometric token update payload.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UpdatedBiometricTokenResponse, Integer, Hash)>] UpdatedBiometricTokenResponse data, response status code and response headers
+    def update_biometric_token_with_http_info(user_id, token_uuid, biometric_token_updater, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.update_biometric_token ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.update_biometric_token"
+      end
+      # verify the required parameter 'token_uuid' is set
+      if @api_client.config.client_side_validation && token_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'token_uuid' when calling DefaultApi.update_biometric_token"
+      end
+      # verify the required parameter 'biometric_token_updater' is set
+      if @api_client.config.client_side_validation && biometric_token_updater.nil?
+        fail ArgumentError, "Missing the required parameter 'biometric_token_updater' when calling DefaultApi.update_biometric_token"
+      end
+      # resource path
+      local_var_path = '/biometric_tokens/{user_id}/{token_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'token_uuid' + '}', CGI.escape(token_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(biometric_token_updater)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UpdatedBiometricTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.update_biometric_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#update_biometric_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update passkey
     # Updates a passkey's state. 
     # @param username [String] Username that owns the passkey.

data/lib/onfido/api_client.rb

@@ -35,7 +35,7 @@ module Onfido
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/6.2.0"
+      @user_agent = "onfido-ruby/6.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -142,7 +142,11 @@ module Onfido
         form_params.each do |key, value|
           case value
           when ::File, ::Tempfile
-            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
+            mime = Marcel::MimeType.for(Pathname.new(value.path))
+            if mime == 'application/octet-stream'
+              mime = Marcel::MimeType.for(extension: File.extname(value.path).delete_prefix('.')) || mime
+            end
+            data[key] = Faraday::FilePart.new(value.path, mime)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value