onfido 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33fdddb9562e1140c7c16bf631d5798829cb81ee6f06298f7192fe25207fa5d4
-  data.tar.gz: 18cfe6479b1ef8c5b35aa08a51e4a62d991a0f6e1b9ef2762ca2ad3dca212fce
+  metadata.gz: fb529a3e1878553b602345173a70d9eca693eed629ae5bda60cd68ddb04b21a0
+  data.tar.gz: '09845784b34ca211cfad3b3a26c394007d4c1feb992e705a59397bc5b09b90fc'
 SHA512:
-  metadata.gz: f60b7622ee0edd7db2c5c6c192b8b7adb01e7988b759b933fc43a51c5b7c34da2da86efd052c20eca075da5f1540903ef2b7ffc01e0b4c0f08144dd8c2c3b415
-  data.tar.gz: 47e2026d2a54c77c06ae23e99351873bcadac011ba797d023433de805119dc1048d6788510b2a757b258ba6eca2a1c05ac12b495c4d3c8dcceb8a1738e546a7b
+  metadata.gz: b69846bf32e944d33210bc7ad1ea53005c07beed23fe5fddabb4bed296fa09f07598d7e90b1d937bbe3132cfb9d04911b761537724d709790cdefa01312cb9dc
+  data.tar.gz: 753949e7b75eced4bb13d2fd3e0fa255865436c5bb81bbbb6b986c79a3b0ae2fbf91d3b91497e54a0d9254b0c19a7c0a0ddab8e25aa5b1943c4c033bf8cc792b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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):
+  - BIO-8421] Document two new number_of_ip_reuse_reports fields
+- Fix flaky timeline file spec
+
 ## v6.0.0 19th February 2026
 
 - Release based on Onfido OpenAPI spec version [v6.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v6.0.0):

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.1.0'
+gem 'onfido', '~> 6.2.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -31,6 +31,22 @@ end
 onfido_api = Onfido::DefaultApi.new
 ```
 
+You can also authenticate using OAuth2 client credentials instead of an API token:
+
+```ruby
+require 'onfido'
+
+Onfido.configure do |config|
+  config.set_oauth_credentials(ENV["ONFIDO_OAUTH_CLIENT_ID"], ENV["ONFIDO_OAUTH_CLIENT_SECRET"])
+  config.region = config.region[:EU]
+  config.timeout = 30
+end
+
+onfido_api = Onfido::DefaultApi.new
+```
+
+The client will automatically exchange credentials for an access token and refresh it when it expires.
+
 All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.
 
 ### Making a call to the API

data/lib/onfido/api/default_api.rb

@@ -63,7 +63,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.cancel_report",
@@ -143,7 +143,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.complete_task",
@@ -211,7 +211,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Applicant'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_applicant",
@@ -279,7 +279,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Check'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_check",
@@ -342,7 +342,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'TimelineFileReference'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_timeline_file",
@@ -410,7 +410,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WatchlistMonitor'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_watchlist_monitor",
@@ -478,7 +478,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Webhook'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_webhook",
@@ -546,7 +546,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WorkflowRun'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.create_workflow_run",
@@ -609,7 +609,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.delete_applicant",
@@ -678,7 +678,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.delete_passkey",
@@ -741,7 +741,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.delete_passkeys",
@@ -804,7 +804,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.delete_watchlist_monitor",
@@ -867,7 +867,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.delete_webhook",
@@ -938,7 +938,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_aes_document",
@@ -1001,7 +1001,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_check",
@@ -1064,7 +1064,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_document",
@@ -1127,7 +1127,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_document_video",
@@ -1190,7 +1190,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_evidence_folder",
@@ -1253,7 +1253,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_id_photo",
@@ -1316,7 +1316,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_live_photo",
@@ -1379,7 +1379,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_live_video",
@@ -1442,7 +1442,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_live_video_frame",
@@ -1505,7 +1505,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_motion_capture",
@@ -1568,7 +1568,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_motion_capture_frame",
@@ -1631,7 +1631,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_nfc_face",
@@ -1702,7 +1702,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_qes_document",
@@ -1773,7 +1773,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_ses_document",
@@ -1836,7 +1836,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_signed_evidence_file",
@@ -1899,7 +1899,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.download_signing_document",
@@ -1967,7 +1967,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Extraction'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.extract",
@@ -2031,7 +2031,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'AddressesList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_addresses",
@@ -2094,7 +2094,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Applicant'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_applicant",
@@ -2157,7 +2157,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Array<ApplicantConsent>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_applicant_consents",
@@ -2220,7 +2220,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Check'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_check",
@@ -2283,7 +2283,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Document'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_document",
@@ -2346,7 +2346,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'IdPhoto'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_id_photo",
@@ -2409,7 +2409,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'LivePhoto'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_live_photo",
@@ -2472,7 +2472,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'LiveVideo'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_live_video",
@@ -2535,7 +2535,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'MotionCapture'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_motion_capture",
@@ -2604,7 +2604,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Passkey'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_passkey",
@@ -2667,7 +2667,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Report'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_report",
@@ -2730,7 +2730,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'SigningDocument'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_signing_document",
@@ -2799,7 +2799,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Task'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_task",
@@ -2868,7 +2868,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'File'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_timeline_file",
@@ -2931,7 +2931,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WatchlistMonitor'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_watchlist_monitor",
@@ -2994,7 +2994,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Webhook'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_webhook",
@@ -3057,7 +3057,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WorkflowRun'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.find_workflow_run",
@@ -3120,7 +3120,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.force_report_creation_from_watchlist_monitor",
@@ -3188,7 +3188,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'SdkToken'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.generate_sdk_token",
@@ -3254,7 +3254,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'ApplicantsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_applicants",
@@ -3318,7 +3318,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'ChecksList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_checks",
@@ -3382,7 +3382,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'DocumentsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_documents",
@@ -3446,7 +3446,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'IdPhotosList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_id_photos",
@@ -3510,7 +3510,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'LivePhotosList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_live_photos",
@@ -3574,7 +3574,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'LiveVideosList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_live_videos",
@@ -3638,7 +3638,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'MotionCapturesList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_motion_captures",
@@ -3701,7 +3701,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'PasskeysList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_passkeys",
@@ -3764,7 +3764,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'RepeatAttemptsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_repeat_attempts",
@@ -3828,7 +3828,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'ReportsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_reports",
@@ -3892,7 +3892,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'SigningDocumentsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_signing_documents",
@@ -3955,7 +3955,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Array<TaskItem>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_tasks",
@@ -4018,7 +4018,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_watchlist_monitor_matches",
@@ -4085,7 +4085,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WatchlistMonitorsList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_watchlist_monitors",
@@ -4142,7 +4142,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WebhooksList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_webhooks",
@@ -4224,7 +4224,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Array<WorkflowRun>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.list_workflow_runs",
@@ -4281,7 +4281,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'String'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.ping",
@@ -4349,7 +4349,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'ResultsFeedback'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.post_results_feedback",
@@ -4417,7 +4417,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.resend_webhooks",
@@ -4480,7 +4480,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.restore_applicant",
@@ -4543,7 +4543,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.resume_check",
@@ -4606,7 +4606,7 @@ module Onfido
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.resume_report",
@@ -4680,7 +4680,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Applicant'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.update_applicant",
@@ -4760,7 +4760,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Passkey'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.update_passkey",
@@ -4834,7 +4834,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'WatchlistMonitorMatchesList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.update_watchlist_monitor_match",
@@ -4908,7 +4908,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Webhook'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.update_webhook",
@@ -5010,7 +5010,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'Document'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.upload_document",
@@ -5078,7 +5078,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'IdPhoto'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.upload_id_photo",
@@ -5149,7 +5149,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'LivePhoto'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.upload_live_photo",
@@ -5225,7 +5225,7 @@ module Onfido
       return_type = opts[:debug_return_type] || 'SigningDocument'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Token']
+      auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials', 'Token']
 
       new_options = opts.merge(
         :operation => :"DefaultApi.upload_signing_document",

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.1.0"
+      @user_agent = "onfido-ruby/6.2.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/configuration.rb

@@ -10,6 +10,8 @@ Generator version: 7.16.0
 =end
 
 require 'faraday/follow_redirects'
+require 'uri'
+require 'json'
 
 module Onfido
   class Configuration
@@ -74,6 +76,14 @@ module Onfido
     # @return [Proc]
     attr_accessor :access_token_getter
 
+    # Defines the OAuth2 client ID for client credentials flow.
+    # @return [String]
+    attr_accessor :oauth_client_id
+
+    # Defines the OAuth2 client secret for client credentials flow.
+    # @return [String]
+    attr_accessor :oauth_client_secret
+
     # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
     # HTTP responses with return type `File` will be returned as a stream of binary data.
     # Default to false.
@@ -188,6 +198,7 @@ module Onfido
       @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
+      @oauth_mutex = Mutex.new 
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
       use( Faraday::FollowRedirects::Middleware ) 
@@ -232,6 +243,7 @@ module Onfido
     end
 
     def api_token=(api_token)
+      raise ArgumentError, 'Cannot set API token when OAuth credentials are already configured' if @oauth_client_id 
       @api_key = {'Token' => "Token token=#{api_token}"}
     end
 
@@ -248,6 +260,64 @@ module Onfido
       @timeout = timeout
     end
 
+    # Sets OAuth2 client credentials for authentication.
+    # The client will automatically exchange credentials for an access token
+    # and refresh it when expired. This is mutually exclusive with api_token.
+    #
+    # @param client_id [String] OAuth2 client ID
+    # @param client_secret [String] OAuth2 client secret
+    def set_oauth_credentials(client_id, client_secret)
+      raise ArgumentError, 'OAuth client ID must not be nil or empty' if client_id.nil? || client_id.empty?
+      raise ArgumentError, 'OAuth client secret must not be nil or empty' if client_secret.nil? || client_secret.empty?
+      raise ArgumentError, 'Cannot set OAuth credentials when API token is already configured' if @api_key&.key?('Token') 
+
+      @oauth_client_id = client_id
+      @oauth_client_secret = client_secret
+      @oauth_access_token = nil
+      @oauth_token_expires_at = nil
+    end
+
+    private
+
+    def fetch_oauth_access_token
+      @oauth_mutex.synchronize do
+        return @oauth_access_token if @oauth_access_token && @oauth_token_expires_at && Time.now.to_f < @oauth_token_expires_at
+
+        conn = Faraday.new(
+          url: base_url,
+          ssl: { ca_file: ssl_ca_file, verify: ssl_verify, verify_mode: ssl_verify_mode,
+                 client_cert: ssl_client_cert, client_key: ssl_client_key },
+          proxy: proxy
+        ) do |f|
+          configure_middleware(f)
+          f.adapter(Faraday.default_adapter)
+          configure_connection(f)
+        end
+
+        response = conn.post('oauth/token') do |req|
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.options.timeout = timeout
+          req.body = URI.encode_www_form(
+            'client_id' => @oauth_client_id,
+            'client_secret' => @oauth_client_secret
+          )
+        end
+
+        unless response.success?
+          raise "OAuth token exchange failed with status #{response.status}: #{response.body}"
+        end
+
+        data = JSON.parse(response.body)
+        @oauth_access_token = data['access_token']
+        expires_in = data['expires_in'].to_i
+        @oauth_token_expires_at = Time.now.to_f + (expires_in - 30)
+
+        @oauth_access_token
+      end
+    end
+
+    public
+
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
     def api_key_with_prefix(param_name, param_alias = nil)
@@ -273,6 +343,17 @@ module Onfido
 
     # Returns Auth Settings hash for api client.
     def auth_settings
+      if @oauth_client_id && !@oauth_client_id.empty?
+        return {
+          'Token' =>
+            {
+              type: 'bearer',
+              in: 'header',
+              key: 'Authorization',
+              value: "Bearer #{fetch_oauth_access_token}"
+            },
+        }
+      end
       {
         'Token' =>
           {
@@ -281,6 +362,13 @@ module Onfido
             key: 'Authorization',
             value: api_key_with_prefix('Token')
           },
+        'OAuth2ClientCredentials' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
       }
     end
 

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.16.0
 =end
 
 module Onfido
-  VERSION = '6.1.0'
+  VERSION = '6.2.0'
 end

data/spec/shared_contexts/with_onfido.rb

@@ -8,7 +8,19 @@ RSpec.shared_context 'with onfido' do
   end
 
   Onfido.configure do |config|
-    config.api_token = ENV['ONFIDO_API_TOKEN']
-    config.region = config.region[:EU]
+    if ENV['ONFIDO_OAUTH_CLIENT_ID'] && !ENV['ONFIDO_OAUTH_CLIENT_ID'].empty?
+      config.set_oauth_credentials(ENV['ONFIDO_OAUTH_CLIENT_ID'], ENV['ONFIDO_OAUTH_CLIENT_SECRET'])
+    else
+      config.api_token = ENV['ONFIDO_API_TOKEN']
+    end
+
+    if ENV['ONFIDO_BASE_PATH'] && !ENV['ONFIDO_BASE_PATH'].empty?
+      uri = URI(ENV['ONFIDO_BASE_PATH'])
+      config.scheme = uri.scheme
+      config.host = uri.host
+      config.base_path = uri.path
+    else
+      config.region = config.region[:EU]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-06 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -509,39 +509,39 @@ specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
 - spec/classic_webhook_event_verifier_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/media/sample_signing_document.pdf
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/webhook_spec.rb
+- spec/integrations/address_picker_spec.rb
+- spec/integrations/signing_document_spec.rb
+- spec/integrations/extraction_spec.rb
+- spec/integrations/document_spec.rb
+- spec/integrations/workflow_run_spec.rb
+- spec/integrations/motion_capture_spec.rb
+- spec/integrations/passkey_spec.rb
 - spec/integrations/advanced_electronic_signature_spec.rb
-- spec/integrations/applicant_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
 - spec/integrations/tasks_spec.rb
-- spec/integrations/workflow_run_spec.rb
-- spec/integrations/document_spec.rb
 - spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/passkey_spec.rb
-- spec/integrations/live_photo_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/check_spec.rb
 - spec/integrations/report_spec.rb
-- spec/integrations/address_picker_spec.rb
+- spec/integrations/applicant_spec.rb
+- spec/integrations/live_video_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
 - spec/integrations/sdk_token_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/check_spec.rb
-- spec/integrations/extraction_spec.rb
-- spec/integrations/motion_capture_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_signing_document.pdf
-- spec/integrations/media/sample_photo.png
+- spec/integrations/live_photo_spec.rb
 - spec/integrations/report_schema_spec.rb
-- spec/integrations/signing_document_spec.rb
-- spec/integrations/live_video_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/media/studio_webhook_event_with_object_in_output.json
 - spec/media/studio_webhook_event_with_list_in_output.json
-- spec/shared_contexts/with_onfido.rb
+- spec/media/studio_webhook_event_with_object_in_output.json
 - spec/shared_contexts/with_signing_document.rb
-- spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_check.rb
+- spec/shared_contexts/with_live_photo.rb
+- spec/shared_contexts/with_onfido.rb
 - spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb