didit-sdk 1.0.0

data/sig/didit/types/customization.rbs

@@ -0,0 +1,7 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    type customization_update_params = { ?color_primary: String, ?color_secondary: String, ?color_background: String, ?color_panel: String, ?color_panel_10: String, ?color_on_panel_1: String, ?color_on_panel_2: String, ?color_on_background: String, ?color_button_1: String, ?color_button_2: String, ?color_button_text_1: String, ?color_button_text_2: String, ?color_pill_text: String, ?border_radius_panel: Integer, ?border_radius_buttons: Integer, ?font_family: String, ?font_weight: String, ?app_public_name: String?, ?privacy_policy_url: String?, ?skip_welcome_screen: bool, ?disable_login_with_didit: bool, ?hide_progress_bar: bool, ?callback_seconds: Integer, ?delete_logo_square: bool, ?delete_logo_rectangular: bool, ?delete_logo_rectangular_dark: bool, ?delete_favicon: bool, ?image_square: Didit::upload, ?image_rectangular: Didit::upload, ?image_rectangular_dark: Didit::upload, ?image_favicon: Didit::upload }
+  end
+end

data/sig/didit/types/database_validation.rbs

@@ -0,0 +1,152 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module DatabaseValidationValidateParamsDocumentType
+      P: String
+      DL: String
+      ID: String
+      RP: String
+      SSC: String
+      HIC: String
+      WP: String
+      TC: String
+      VISA: String
+      PSC: String
+      BC: String
+      OTHER: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateParamsGender
+      M: String
+      F: String
+      X: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateParamsNoMatchAction
+      DECLINE: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateParamsPartialMatchAction
+      DECLINE: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationMatchType
+      FULL_MATCH: String
+      PARTIAL_MATCH: String
+      NO_MATCH: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationStatus
+      APPROVED: String
+      DECLINED: String
+      IN_REVIEW: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationValidationType
+      ONE_BY_ONE: String
+      TWO_BY_TWO: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1OutcomeCode
+      MATCH: String
+      PARTIAL_MATCH: String
+      NO_MATCH: String
+      DOCUMENT_NOT_FOUND: String
+      INVALID_DOCUMENT_FORMAT: String
+      INVALID_INPUT: String
+      MINOR_BLOCKED: String
+      DECEASED: String
+      BIOMETRIC_NO_MATCH: String
+      BIOMETRIC_IMAGE_UNUSABLE: String
+      INCONCLUSIVE: String
+      DOCUMENT_SUPERSEDED: String
+      REGISTRY_UNAVAILABLE: String
+      REGISTRY_ERROR: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1ValidationValue
+      FULL_MATCH: String
+      PARTIAL_MATCH: String
+      NO_MATCH: String
+
+      VALUES: Array[String]
+    end
+
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant2Value
+      FULL_MATCH: String
+      PARTIAL_MATCH: String
+      NO_MATCH: String
+
+      VALUES: Array[String]
+    end
+
+    class DatabaseValidationValidateResponse < Didit::Model
+      def request_id: () -> String?
+      def database_validation: () -> Didit::Types::DatabaseValidationValidateResponseDatabaseValidation?
+      def vendor_data: () -> String?
+      def metadata: () -> Hash[String, untyped]?
+      def created_at: () -> Time?
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidation < Didit::Model
+      def status: () -> String?
+      def issuing_state: () -> String?
+      def validation_type: () -> String?
+      def screened_data: () -> Hash[String, untyped]?
+      def match_type: () -> String?
+      def validations: () -> (Array[Didit::Types::DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1] | Hash[String, String])?
+      def warnings: () -> Array[Didit::Types::DatabaseValidationValidateResponseDatabaseValidationWarnings]?
+      def errors: () -> Array[Didit::Types::DatabaseValidationValidateResponseDatabaseValidationErrors]?
+      def services_used: () -> Array[String]?
+      def match_score: () -> Float?
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidationErrors < Didit::Model
+      def service_id: () -> String?
+      def code: () -> String?
+      def message: () -> String?
+      def retryable: () -> bool?
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1 < Didit::Model
+      def service_id: () -> String?
+      def service_name: () -> String?
+      def validation: () -> Hash[String, String]?
+      def outcome_code: () -> String?
+      def outcome_detail: () -> String?
+      def source_data: () -> Hash[String, untyped]?
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidationWarnings < Didit::Model
+      def feature: () -> String?
+      def risk: () -> String?
+      def additional_data: () -> Hash[String, untyped]?
+      def log_type: () -> String?
+      def short_description: () -> String?
+      def long_description: () -> String?
+    end
+
+    type database_validation_validate_params = { issuing_state: String, ?services: Array[String], ?validation_type: String, ?consent: bool, ?identification_number: String, ?first_name: String, ?last_name: String, ?middle_name: String, ?full_name: String, ?date_of_birth: Date | String, ?personal_number: String, ?tax_number: String, ?document_number: String, ?document_type: String, ?expiration_date: Date | String, ?date_of_issue: Date | String, ?nationality: String, ?gender: String, ?address: (Didit::Types::database_validation_validate_params_address_variant1 | String), ?address_element_1: String, ?address_element_2: String, ?address_element_3: String, ?address_element_4: String, ?address_element_5: String, ?postal_code: String, ?driver_license_number: String, ?driver_license_card_number: String, ?driver_license_state: String, ?driver_license_version: String, ?passport_number: String, ?passport_expiration_date: Date | String, ?passport_file_number: String, ?passport_issue_country: String, ?medicare_card_number: String, ?immi_card_number: String, ?immi_card_expiry_date: Date | String, ?citizenship_certificate_number: String, ?birth_registration_number: String, ?birth_registration_date: Date | String, ?birth_registration_state: String, ?marriage_certificate_number: String, ?change_of_name_certificate_number: String, ?first_partner_name: String, ?last_partner_name: String, ?voter_id: String, ?epic_card: String, ?pan: String, ?national_id: String, ?cic: String, ?identificador_ciudadano: String, ?ocr: String, ?voter_number: String, ?emission_number: String, ?bvn: String, ?bank_card_number: String, ?ssn: String, ?phone: String, ?landline: String, ?email: String, ?country_of_residence: String, ?partial_match_action: String, ?no_match_action: String, ?save_api_request: bool, ?vendor_data: String, ?metadata: (Hash[String | Symbol, untyped])?, ?selfie: Didit::upload }
+
+    type database_validation_validate_params_address_variant1 = { ?street_1: String, ?street_2: String, ?city: String, ?region: String, ?postal_code: String, ?country: String }
+  end
+end

data/sig/didit/types/document_ai.rbs

@@ -0,0 +1,123 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module DocumentAiAnalyzeParamsDocumentAiDocumentTamperingAction
+      DECLINE: String
+      REVIEW: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeParamsDocumentAiMissingRequiredFieldsAction
+      DECLINE: String
+      REVIEW: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeParamsDocumentAiNameMismatchAction
+      DECLINE: String
+      REVIEW: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeParamsDocumentAiUnreadableDocumentAction
+      DECLINE: String
+      REVIEW: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeParamsDocumentAiUnsupportedFileAction
+      DECLINE: String
+      REVIEW: String
+      NO_ACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeResponseDocumentAiFieldsType
+      TEXT: String
+      NUMBER: String
+      DATE: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeResponseDocumentAiStatus
+      APPROVED: String
+      DECLINED: String
+      IN_REVIEW: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeResponseDocumentAiWarningsFeature
+      DOCUMENT_AI: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeResponseDocumentAiWarningsLogType
+      ERROR: String
+      WARNING: String
+      INFORMATION: String
+
+      VALUES: Array[String]
+    end
+
+    module DocumentAiAnalyzeResponseDocumentAiWarningsRisk
+      DOCUMENT_AI_UNREADABLE_DOCUMENT: String
+      DOCUMENT_AI_MISSING_REQUIRED_FIELDS: String
+      DOCUMENT_AI_SUSPECTED_MANIPULATION: String
+      DOCUMENT_AI_NAME_MISMATCH: String
+      DOCUMENT_AI_UNSUPPORTED_FILE: String
+
+      VALUES: Array[String]
+    end
+
+    class DocumentAiAnalyzeResponse < Didit::Model
+      def request_id: () -> String?
+      def document_ai: () -> Didit::Types::DocumentAiAnalyzeResponseDocumentAi?
+      def vendor_data: () -> String?
+      def metadata: () -> Hash[String, untyped]?
+      def created_at: () -> Time?
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAi < Didit::Model
+      def status: () -> String?
+      def extracted_data: () -> Hash[String, untyped]?
+      def detected_codes: () -> Array[Didit::Types::DocumentAIDetectedCode]?
+      def fields: () -> Array[Didit::Types::DocumentAiAnalyzeResponseDocumentAiFields]?
+      def name_match_score: () -> Float?
+      def name_on_document: () -> String?
+      def warnings: () -> Array[Didit::Types::DocumentAiAnalyzeResponseDocumentAiWarnings]?
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAiFields < Didit::Model
+      def key: () -> String?
+      def name: () -> String?
+      def instruction: () -> String?
+      def `type`: () -> String?
+      def required: () -> bool?
+      def is_full_name: () -> bool?
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAiWarnings < 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 document_ai_analyze_params = { document: Didit::upload, fields: String, ?expected_first_name: String, ?expected_last_name: String, ?expected_company_name: String, ?expected_company_country: String, ?document_ai_name_match_score_threshold: Integer, ?document_ai_unreadable_document_action: String, ?document_ai_missing_required_fields_action: String, ?document_ai_document_tampering_action: String, ?document_ai_name_mismatch_action: String, ?document_ai_unsupported_file_action: String, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped] }
+  end
+end

data/sig/didit/types/email.rbs

@@ -0,0 +1,112 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module EmailCheckCodeParamsBreachedEmailAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module EmailCheckCodeParamsDisposableEmailAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module EmailCheckCodeParamsDuplicatedEmailAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module EmailCheckCodeParamsEmailNoSocialPresenceAction
+      NO_ACTION: String
+      DECLINE: String
+
+      VALUES: Array[String]
+    end
+
+    module EmailSendCodeParamsOptionsLocale
+      EN: String
+      AR: String
+      BN: String
+      BG: String
+      BS: String
+      CA: String
+      CS: String
+      DA: String
+      DE: String
+      EL: String
+      ES: String
+      ET: String
+      FA: String
+      FI: String
+      FR: String
+      HE: String
+      HI: String
+      HR: String
+      HU: String
+      HY: String
+      ID: String
+      IT: String
+      JA: String
+      KA: String
+      KK: String
+      KO: String
+      KY: String
+      LT: String
+      LV: String
+      CNR: String
+      MK: String
+      MN: String
+      MS: String
+      NL: String
+      NO: String
+      PL: String
+      PT_BR: String
+      PT: String
+      RO: String
+      RU: String
+      SK: String
+      SL: String
+      SO: String
+      SQ: String
+      SR: String
+      SV: String
+      TH: String
+      TR: String
+      UK: String
+      UZ: String
+      VI: String
+      ZH_CN: String
+      ZH_TW: String
+      ZH: String
+
+      VALUES: Array[String]
+    end
+
+    module EmailSendCodeParamsSignalsDevicePlatform
+      ANDROID: String
+      IOS: String
+      IPADOS: String
+      TVOS: String
+      WEB: String
+
+      VALUES: Array[String]
+    end
+
+    type email_assess_risk_params = { email: String, ?country_code: String, ?signals: Didit::Types::risk_signals, ?vendor_data: String, ?metadata: (Hash[String | Symbol, untyped])?, ?enable_social: bool }
+
+    type email_check_code_params = { email: String, code: String, ?duplicated_email_action: String, ?breached_email_action: String, ?disposable_email_action: String, ?enable_social: bool, ?email_no_social_presence_action: String }
+
+    type email_send_code_params = { email: String, ?options: Didit::Types::email_send_code_params_options, ?signals: Didit::Types::email_send_code_params_signals, ?vendor_data: String, ?metadata: (Hash[String | Symbol, untyped])? }
+
+    type email_send_code_params_options = { ?code_size: Integer, ?alphanumeric_code: bool, ?locale: String, ?use_white_label_customization: bool }
+
+    type email_send_code_params_signals = { ?ip: String, ?device_id: String, ?device_platform: String, ?device_model: String, ?os_version: String, ?app_version: String, ?user_agent: String }
+  end
+end

data/sig/didit/types/face_match.rbs

@@ -0,0 +1,86 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module FaceMatchCompareResponseFaceMatchStatus
+      APPROVED: String
+      DECLINED: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceMatchCompareResponseFaceMatchWarningsFeature
+      FACEMATCH: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceMatchCompareResponseFaceMatchWarningsLogType
+      ERROR: String
+      WARNING: String
+      INFORMATION: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceMatchCompareResponseFaceMatchWarningsRisk
+      NO_REFERENCE_IMAGE: String
+      LOW_FACE_MATCH_SIMILARITY: String
+
+      VALUES: Array[String]
+    end
+
+    class FaceMatchCompareResponse < Didit::Model
+      def request_id: () -> String?
+      def face_match: () -> Didit::Types::FaceMatchCompareResponseFaceMatch?
+      def vendor_data: () -> String?
+      def metadata: () -> Hash[String, untyped]?
+      def created_at: () -> Time?
+    end
+
+    class FaceMatchCompareResponseFaceMatch < Didit::Model
+      def status: () -> String?
+      def score: () -> Float?
+      def user_image: () -> Didit::Types::FaceMatchCompareResponseFaceMatchUserImage?
+      def ref_image: () -> Didit::Types::FaceMatchCompareResponseFaceMatchRefImage?
+      def warnings: () -> Array[Didit::Types::FaceMatchCompareResponseFaceMatchWarnings]?
+    end
+
+    class FaceMatchCompareResponseFaceMatchRefImage < Didit::Model
+      def entities: () -> Array[Didit::Types::FaceMatchCompareResponseFaceMatchRefImageEntities]?
+      def best_angle: () -> Integer?
+    end
+
+    class FaceMatchCompareResponseFaceMatchRefImageEntities < Didit::Model
+      def bbox: () -> Array[Integer]?
+      def confidence: () -> Float?
+      def age: () -> Float?
+      def gender: () -> String?
+      def race: () -> String?
+    end
+
+    class FaceMatchCompareResponseFaceMatchUserImage < Didit::Model
+      def entities: () -> Array[Didit::Types::FaceMatchCompareResponseFaceMatchUserImageEntities]?
+      def best_angle: () -> Integer?
+    end
+
+    class FaceMatchCompareResponseFaceMatchUserImageEntities < Didit::Model
+      def bbox: () -> Array[Integer]?
+      def confidence: () -> Float?
+      def age: () -> Float?
+      def gender: () -> String?
+      def race: () -> String?
+    end
+
+    class FaceMatchCompareResponseFaceMatchWarnings < 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 face_match_compare_params = { user_image: Didit::upload, ref_image: Didit::upload, ?face_match_score_decline_threshold: Float | Integer, ?rotate_image: bool, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped] }
+  end
+end

data/sig/didit/types/face_search.rbs

@@ -0,0 +1,112 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module FaceSearchSearchParamsSearchType
+      MOST_SIMILAR: String
+      BLOCKLISTED_OR_APPROVED: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceSearchSearchResponseFaceSearchMatchesSource
+      SESSION: String
+      IMPORTED: String
+      LIST_ENTRY: String
+      RETAINED_TEMPLATE: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceSearchSearchResponseFaceSearchStatus
+      APPROVED: String
+      DECLINED: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceSearchSearchResponseFaceSearchWarningsFeature
+      LIVENESS: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceSearchSearchResponseFaceSearchWarningsLogType
+      ERROR: String
+      WARNING: String
+      INFORMATION: String
+
+      VALUES: Array[String]
+    end
+
+    module FaceSearchSearchResponseFaceSearchWarningsRisk
+      MULTIPLE_FACES_DETECTED: String
+      FACE_IN_BLOCKLIST: String
+      POSSIBLE_FACE_IN_BLOCKLIST: String
+      DUPLICATED_FACE: String
+      POSSIBLE_DUPLICATED_FACE: String
+
+      VALUES: Array[String]
+    end
+
+    class FaceSearchSearchResponse < Didit::Model
+      def request_id: () -> String?
+      def face_search: () -> Didit::Types::FaceSearchSearchResponseFaceSearch?
+      def vendor_data: () -> String?
+      def metadata: () -> Hash[String, untyped]?
+      def created_at: () -> Time?
+    end
+
+    class FaceSearchSearchResponseFaceSearch < Didit::Model
+      def status: () -> String?
+      def total_matches: () -> Integer?
+      def matches: () -> Array[Didit::Types::FaceSearchSearchResponseFaceSearchMatches]?
+      def user_image: () -> Didit::Types::FaceSearchSearchResponseFaceSearchUserImage?
+      def warnings: () -> Array[Didit::Types::FaceSearchSearchResponseFaceSearchWarnings]?
+    end
+
+    class FaceSearchSearchResponseFaceSearchMatches < Didit::Model
+      def session_id: () -> String?
+      def session_number: () -> Integer?
+      def similarity_percentage: () -> Float?
+      def source: () -> String?
+      def vendor_data: () -> String?
+      def vendor_user_id: () -> String?
+      def biometric_template_id: () -> String?
+      def verification_date: () -> Time?
+      def user_details: () -> Didit::Types::FaceSearchSearchResponseFaceSearchMatchesUserDetails?
+      def match_image_url: () -> String?
+      def status: () -> String?
+      def is_blocklisted: () -> bool?
+      def is_allowlisted: () -> bool?
+      def api_service: () -> String?
+    end
+
+    class FaceSearchSearchResponseFaceSearchMatchesUserDetails < Didit::Model
+      def full_name: () -> String?
+      def document_type: () -> String?
+      def document_number: () -> String?
+    end
+
+    class FaceSearchSearchResponseFaceSearchUserImage < Didit::Model
+      def entities: () -> Array[Didit::Types::FaceSearchSearchResponseFaceSearchUserImageEntities]?
+      def best_angle: () -> Integer?
+    end
+
+    class FaceSearchSearchResponseFaceSearchUserImageEntities < Didit::Model
+      def bbox: () -> Array[Integer]?
+      def confidence: () -> Float?
+    end
+
+    class FaceSearchSearchResponseFaceSearchWarnings < 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 face_search_search_params = { user_image: Didit::upload, ?search_type: String, ?rotate_image: bool, ?save_api_request: bool, ?vendor_data: String, ?metadata: Hash[String | Symbol, untyped] }
+  end
+end

data/sig/didit/types/fraud_checks.rbs

@@ -0,0 +1,9 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    type fraud_checks_create_params = { ?client_reference: String, ?profile: String, ?profile_version: String, subject: Didit::Types::fraud_check_subject_request, ?context: Didit::Types::fraud_check_context_request, ?checks: Didit::Types::fraud_check_module_selection_request, ?vendor_data: String, ?metadata: untyped }
+
+    type fraud_checks_plan_params = { ?client_reference: String, ?profile: String, ?profile_version: String, subject: Didit::Types::fraud_check_subject_request, ?context: Didit::Types::fraud_check_context_request, ?checks: Didit::Types::fraud_check_module_selection_request, ?vendor_data: String, ?metadata: untyped }
+  end
+end