didit-sdk 1.0.0

data/sig/didit/types/id_verification.rbs

@@ -0,0 +1,196 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module IdVerificationVerifyParamsCriticalFieldOcclusionAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyParamsDocumentOrPersonalNumberFormatMismatchAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyParamsExpirationDateNotDetectedAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyParamsInconsistentDataAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyParamsInvalidMrzAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyParamsPreferredCharacters
+      LATIN: String
+      NON_LATIN: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyResponseIdVerificationStatus
+      APPROVED: String
+      DECLINED: String
+      IN_REVIEW: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyResponseIdVerificationWarningsFeature
+      ID_VERIFICATION: String
+
+      VALUES: Array[String]
+    end
+
+    module IdVerificationVerifyResponseIdVerificationWarningsLogType
+      ERROR: String
+      WARNING: String
+      INFORMATION: String
+
+      VALUES: Array[String]
+    end
+
+    class IdVerificationVerifyResponse < Didit::Model
+      def request_id: () -> String?
+      def id_verification: () -> Didit::Types::IdVerificationVerifyResponseIdVerification?
+      def vendor_data: () -> String?
+      def metadata: () -> Hash[String, untyped]?
+      def created_at: () -> Time?
+    end
+
+    class IdVerificationVerifyResponseIdVerification < Didit::Model
+      def status: () -> String?
+      def document_type: () -> String?
+      def document_subtype: () -> String?
+      def document_number: () -> String?
+      def personal_number: () -> String?
+      def portrait_image: () -> String?
+      def front_image: () -> String?
+      def back_image: () -> String?
+      def front_image_camera_front: () -> String?
+      def back_image_camera_front: () -> String?
+      def front_image_camera_front_face_match_score: () -> Float?
+      def back_image_camera_front_face_match_score: () -> Float?
+      def front_image_quality_score: () -> Didit::Types::IdVerificationVerifyResponseIdVerificationFrontImageQualityScore?
+      def back_image_quality_score: () -> Didit::Types::IdVerificationVerifyResponseIdVerificationBackImageQualityScore?
+      def date_of_birth: () -> Date?
+      def age: () -> Integer?
+      def expiration_date: () -> Date?
+      def date_of_issue: () -> Date?
+      def issuing_state: () -> String?
+      def issuing_state_name: () -> String?
+      def first_name: () -> String?
+      def last_name: () -> String?
+      def full_name: () -> String?
+      def gender: () -> String?
+      def address: () -> String?
+      def formatted_address: () -> String?
+      def place_of_birth: () -> String?
+      def marital_status: () -> String?
+      def nationality: () -> String?
+      def extra_fields: () -> Hash[String, untyped]?
+      def mrz: () -> Didit::Types::IdVerificationVerifyResponseIdVerificationMrz?
+      def parsed_address: () -> Didit::Types::IdVerificationVerifyResponseIdVerificationParsedAddress?
+      def warnings: () -> Array[Didit::Types::IdVerificationVerifyResponseIdVerificationWarnings]?
+      def barcodes: () -> Array[Didit::Types::IdVerificationVerifyResponseIdVerificationBarcodes]?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationBackImageQualityScore < Didit::Model
+      def focus_score: () -> Float?
+      def brightness_score: () -> Float?
+      def brightness_issue: () -> String?
+      def is_document_fully_visible: () -> bool?
+      def resolution_score: () -> Float?
+      def overall_score: () -> Float?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationBarcodes < Didit::Model
+      def `type`: () -> String?
+      def position: () -> Hash[String, untyped]?
+      def data: () -> String?
+      def data_raw: () -> String?
+      def side: () -> String?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationFrontImageQualityScore < Didit::Model
+      def focus_score: () -> Float?
+      def brightness_score: () -> Float?
+      def brightness_issue: () -> String?
+      def is_document_fully_visible: () -> bool?
+      def resolution_score: () -> Float?
+      def overall_score: () -> Float?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationMrz < Didit::Model
+      def surname: () -> String?
+      def name: () -> String?
+      def country: () -> String?
+      def nationality: () -> String?
+      def birth_date: () -> String?
+      def expiry_date: () -> String?
+      def sex: () -> String?
+      def document_type: () -> String?
+      def document_number: () -> String?
+      def optional_data: () -> String?
+      def optional_data_2: () -> String?
+      def birth_date_hash: () -> String?
+      def expiry_date_hash: () -> String?
+      def document_number_hash: () -> String?
+      def final_hash: () -> String?
+      def personal_number: () -> String?
+      def warnings: () -> Array[String]?
+      def errors: () -> Array[String]?
+      def mrz_type: () -> String?
+      def mrz_string: () -> String?
+      def mrz_key: () -> String?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationParsedAddress < Didit::Model
+      def street_1: () -> String?
+      def street_2: () -> String?
+      def city: () -> String?
+      def region: () -> String?
+      def country: () -> String?
+      def postal_code: () -> String?
+      def address_type: () -> String?
+      def formatted_address: () -> String?
+      def raw_results: () -> Hash[String, untyped]?
+      def document_location: () -> Didit::Types::IdVerificationVerifyResponseIdVerificationParsedAddressDocumentLocation?
+      def label: () -> String?
+      def is_verified: () -> bool?
+      def category: () -> String?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationParsedAddressDocumentLocation < Didit::Model
+      def latitude: () -> Float?
+      def longitude: () -> Float?
+    end
+
+    class IdVerificationVerifyResponseIdVerificationWarnings < Didit::Model
+      def risk: () -> String?
+      def feature: () -> String?
+      def additional_data: () -> Hash[String, untyped]?
+      def log_type: () -> String?
+      def short_description: () -> String?
+      def long_description: () -> String?
+    end
+
+    type id_verification_verify_params = { front_image: Didit::upload, ?front_image_password: String, ?back_image: Didit::upload, ?back_image_password: String, ?perform_document_liveness: bool, ?minimum_age: Integer?, ?expiration_date_not_detected_action: String, ?invalid_mrz_action: String, ?inconsistent_data_action: String, ?critical_field_occlusion_action: String, ?document_or_personal_number_format_mismatch_action: String, ?preferred_characters: String, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped] }
+  end
+end

data/sig/didit/types/id_wallets.rbs

@@ -0,0 +1,55 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    type id_wallets_start_audkenni_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_bankid_cz_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_bankid_no_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_bankid_se_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_buypass_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_connectid_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, ?authorisation_server_id: String, return_url: String, ?device: String }
+
+    type id_wallets_start_diia_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_eparaksts_mobile_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_eudi_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_franceconnect_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_frejaid_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_ftn_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_govbr_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_govuk_wallet_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_idcard_ee_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_idin_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_itsme_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_mitid_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_mobile_id_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, country: String, personal_code: String, phone_number: String }
+
+    type id_wallets_start_mojeid_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_oneid_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_personalausweis_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_smart_id_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, country: String, personal_code: String }
+
+    type id_wallets_start_uae_pass_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+
+    type id_wallets_start_vipps_params = { ?vendor_data: String?, ?metadata: (Hash[String | Symbol, untyped])?, ?sandbox_scenario: String, ?country: String, return_url: String, ?device: String }
+  end
+end

data/sig/didit/types/investigator.rbs

@@ -0,0 +1,212 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module InvestigatorExportActivityParamsGroup
+      AGENT: String
+      DECISIONS: String
+      OVERRIDES: String
+      AUTONOMY: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorExportActivityParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListActivityParamsGroup
+      AGENT: String
+      DECISIONS: String
+      OVERRIDES: String
+      AUTONOMY: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListActivityParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListGuardrailsResponseResultsKey
+      SANCTIONS_TO_PERSON: String
+      NO_TIPPING_OFF: String
+      NO_PROTECTED_CHARACTERISTICS: String
+      NEVER_FILES_REPORTS: String
+      EVERY_DECISION_LOGGED: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListQueueParamsConfidence
+      HIGH: String
+      MODERATE: String
+      LOW: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListQueueParamsQueue
+      KYC: String
+      KYB: String
+      AML: String
+      TRANSACTIONS: String
+      CASES: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListQueueParamsRecommendation
+      APPROVE: String
+      DECLINE: String
+      ESCALATE: String
+      REQUEST: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorListQueueParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorOverrideRunParamsAction
+      APPROVE: String
+      DECLINE: String
+      ESCALATE: String
+      REQUEST: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorOverrideRunParamsCategory
+      MISSING_CONTEXT: String
+      NEEDS_INFORMATION: String
+      POLICY_DIFFERS: String
+      EVIDENCE_MISREAD: String
+      OTHER: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorRetrieveDashboardParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorRetrievePerformanceParamsPeriod
+      V_7: String
+      V_30: String
+      V_90: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorRetrievePerformanceParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorRetrieveSummaryParamsScope
+      ALL: String
+      IDENTITY: String
+      TRANSACTIONS: String
+
+      VALUES: Array[String]
+    end
+
+    module InvestigatorUpdateSettingsParamsStage
+      NONE: String
+      SHADOW: String
+      LIVE: String
+
+      VALUES: Array[String]
+    end
+
+    class InvestigatorListActivityResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def counts: () -> Hash[String, untyped]?
+      def actors: () -> Array[untyped]?
+      def results: () -> Array[Hash[String, untyped]]?
+    end
+
+    class InvestigatorListGuardrailsResponse < Didit::Model
+      def results: () -> Array[Didit::Types::InvestigatorListGuardrailsResponseResults]?
+    end
+
+    class InvestigatorListGuardrailsResponseResults < Didit::Model
+      def key: () -> String?
+      def title: () -> String?
+      def description: () -> String?
+      def locked: () -> bool?
+    end
+
+    class InvestigatorListQueueResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def counts: () -> Hash[String, untyped]?
+      def results: () -> Array[Didit::Types::InvestigatorQueueRow]?
+    end
+
+    class InvestigatorRetrieveDashboardResponse < Didit::Model
+      def stage: () -> String?
+      def window_days: () -> Integer?
+      def reviews: () -> Integer?
+      def decided: () -> Integer?
+      def automated: () -> Integer?
+      def automation_rate: () -> Float?
+      def hours_saved: () -> Float?
+    end
+
+    class InvestigatorRetrievePerformanceResponse < Didit::Model
+      def period: () -> Integer?
+      def start: () -> Date?
+      def `end`: () -> Date?
+      def investigated: () -> Integer?
+    end
+
+    class InvestigatorRetrieveSummaryResponse < Didit::Model
+      def stage: () -> String?
+      def last_report_at: () -> Time?
+      def prepared_today: () -> Integer?
+      def ready_to_accept: () -> Integer?
+      def open: () -> Integer?
+      def decided_today: () -> Integer?
+      def automation_rate_month: () -> Float?
+      def preparing: () -> Integer?
+    end
+
+    class InvestigatorRetrieveTransactionResponse < Didit::Model
+      def transaction_id: () -> String?
+      def investigator: () -> Didit::Types::InvestigatorBlock?
+    end
+
+    type investigator_accept_run_params = { ?narrative: String, ?send_email: bool, ?email_address: String, ?email_language: String }
+
+    type investigator_batch_accept_runs_params = { run_ids: Array[String] }
+
+    type investigator_override_run_params = { action: String, category: String, reason: String, ?send_email: bool, ?email_address: String, ?email_language: String }
+
+    type investigator_update_settings_params = { ?stage: String, ?monthly_spend_limit: String? }
+  end
+end

data/sig/didit/types/ip.rbs

@@ -0,0 +1,7 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    type ip_assess_risk_params = { ip_address: String, ?claimed_country: String, ?user_agent: String, ?vendor_data: String, ?metadata: (Hash[String | Symbol, untyped])? }
+  end
+end