didit-sdk 1.0.0

data/lib/didit/types/id_verification.rb

@@ -0,0 +1,231 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What to do when a critical printed field was physically covered on the capture
+    # (`CRITICAL_FIELD_OCCLUSION_DETECTED`) - an identity number, a name, the date of birth, or the expiry date.
+    # Declines by default, like this endpoint's other document-integrity risks: covering the numbers a report is
+    # reconciled against is what a redacted document looks like. The value read for a covered field is dropped from
+    # the extraction either way, so the matching `*_NOT_DETECTED` warning usually accompanies it. `REVIEW` is not
+    # supported on this endpoint and returns `400`.
+    module IdVerificationVerifyParamsCriticalFieldOcclusionAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when a number does not match the format its issuing authority uses for that document type
+    # (`DOCUMENT_NUMBER_FORMAT_MISMATCH`, `PERSONAL_NUMBER_FORMAT_MISMATCH`). Default `NO_ACTION`, which reports the
+    # warning without changing the status. `REVIEW` is not supported on this endpoint and returns `400`.
+    module IdVerificationVerifyParamsDocumentOrPersonalNumberFormatMismatchAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when no expiration date can be read (`EXPIRATION_DATE_NOT_DETECTED`). Default `NO_ACTION` because
+    # many identity documents print no expiry date. Note: a *detected and past* expiry date always declines
+    # (`DOCUMENT_EXPIRED`), regardless of this option.
+    module IdVerificationVerifyParamsExpirationDateNotDetectedAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when extracted data is internally inconsistent: `DATA_INCONSISTENT`,
+    # `MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME` (visual zone disagrees with the MRZ), or
+    # `DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS`.
+    module IdVerificationVerifyParamsInconsistentDataAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when the extracted MRZ fails check-digit validation (`MRZ_VALIDATION_FAILED`). A missing MRZ raises
+    # no warning on this endpoint. Only relevant for documents that carry an MRZ. `REVIEW` is not supported on this
+    # endpoint and returns `400`.
+    module IdVerificationVerifyParamsInvalidMrzAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # Preferred script for name/address fields on documents that print both Latin and non-Latin text (Arabic,
+    # Cyrillic, CJK, …). `latin` returns transliterated/Latin values; `non_latin` prefers the native script.
+    module IdVerificationVerifyParamsPreferredCharacters
+      LATIN = "latin"
+      NON_LATIN = "non_latin"
+
+      VALUES = [LATIN, NON_LATIN].freeze
+    end
+
+    # `Approved` when no warning resolves to a decline and the requested document-liveness check produced a usable
+    # result; `In Review` when that requested check produced no usable result (`DOCUMENT_LIVENESS_NOT_COMPUTED`);
+    # `Declined` when a warning resolves to a decline - the `warnings` list explains why.
+    module IdVerificationVerifyResponseIdVerificationStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+      IN_REVIEW = "In Review"
+
+      VALUES = [APPROVED, DECLINED, IN_REVIEW].freeze
+    end
+
+    # Feature that raised the warning. Always `ID_VERIFICATION` on this endpoint.
+    module IdVerificationVerifyResponseIdVerificationWarningsFeature
+      ID_VERIFICATION = "ID_VERIFICATION"
+
+      VALUES = [ID_VERIFICATION].freeze
+    end
+
+    # Severity. `error` warnings drive `status` to `Declined`; `warning` (only `DOCUMENT_LIVENESS_NOT_COMPUTED`, when
+    # the requested forgery check produced no usable score) drives `status` to `In Review`; `information` entries are
+    # advisory and never change the status.
+    module IdVerificationVerifyResponseIdVerificationWarningsLogType
+      ERROR = "error"
+      WARNING = "warning"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, WARNING, INFORMATION].freeze
+    end
+
+    class IdVerificationVerifyResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :id_verification, "id_verification", "IdVerificationVerifyResponseIdVerification"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class IdVerificationVerifyResponseIdVerification < Didit::Model
+      field :status, "status", :string
+      field :document_type, "document_type", :string
+      field :document_subtype, "document_subtype", :string
+      field :document_number, "document_number", :string
+      field :personal_number, "personal_number", :string
+      field :portrait_image, "portrait_image", :string
+      field :front_image, "front_image", :string
+      field :back_image, "back_image", :string
+      field :front_image_camera_front, "front_image_camera_front", :string
+      field :back_image_camera_front, "back_image_camera_front", :string
+      field :front_image_camera_front_face_match_score, "front_image_camera_front_face_match_score", :float
+      field :back_image_camera_front_face_match_score, "back_image_camera_front_face_match_score", :float
+      field :front_image_quality_score, "front_image_quality_score", "IdVerificationVerifyResponseIdVerificationFrontImageQualityScore"
+      field :back_image_quality_score, "back_image_quality_score", "IdVerificationVerifyResponseIdVerificationBackImageQualityScore"
+      field :date_of_birth, "date_of_birth", :date
+      field :age, "age", :integer
+      field :expiration_date, "expiration_date", :date
+      field :date_of_issue, "date_of_issue", :date
+      field :issuing_state, "issuing_state", :string
+      field :issuing_state_name, "issuing_state_name", :string
+      field :first_name, "first_name", :string
+      field :last_name, "last_name", :string
+      field :full_name, "full_name", :string
+      field :gender, "gender", :string
+      field :address, "address", :string
+      field :formatted_address, "formatted_address", :string
+      field :place_of_birth, "place_of_birth", :string
+      field :marital_status, "marital_status", :string
+      field :nationality, "nationality", :string
+      field :extra_fields, "extra_fields", :any
+      field :mrz, "mrz", "IdVerificationVerifyResponseIdVerificationMrz"
+      field :parsed_address, "parsed_address", "IdVerificationVerifyResponseIdVerificationParsedAddress"
+      field :warnings, "warnings", [:array, "IdVerificationVerifyResponseIdVerificationWarnings"]
+      field :barcodes, "barcodes", [:array, "IdVerificationVerifyResponseIdVerificationBarcodes"]
+    end
+
+    # Capture-quality diagnostics for the uploaded image (`null` when the side was not provided or scoring failed).
+    # All scores are 0-100.
+    class IdVerificationVerifyResponseIdVerificationBackImageQualityScore < Didit::Model
+      field :focus_score, "focus_score", :float
+      field :brightness_score, "brightness_score", :float
+      field :brightness_issue, "brightness_issue", :string
+      field :is_document_fully_visible, "is_document_fully_visible", :boolean
+      field :resolution_score, "resolution_score", :float
+      field :overall_score, "overall_score", :float
+    end
+
+    class IdVerificationVerifyResponseIdVerificationBarcodes < Didit::Model
+      field :type, "type", :string
+      field :position, "position", :any
+      field :data, "data", :string
+      field :data_raw, "data_raw", :string
+      field :side, "side", :string
+    end
+
+    # Capture-quality diagnostics for the uploaded image (`null` when the side was not provided or scoring failed).
+    # All scores are 0-100.
+    class IdVerificationVerifyResponseIdVerificationFrontImageQualityScore < Didit::Model
+      field :focus_score, "focus_score", :float
+      field :brightness_score, "brightness_score", :float
+      field :brightness_issue, "brightness_issue", :string
+      field :is_document_fully_visible, "is_document_fully_visible", :boolean
+      field :resolution_score, "resolution_score", :float
+      field :overall_score, "overall_score", :float
+    end
+
+    # Parsed machine-readable zone. An **empty object** (`{}`) when the document has no MRZ or it could not be read -
+    # also check the `warnings` list in that case. Dates inside the MRZ use the raw `YYMMDD` format.
+    class IdVerificationVerifyResponseIdVerificationMrz < Didit::Model
+      field :surname, "surname", :string
+      field :name, "name", :string
+      field :country, "country", :string
+      field :nationality, "nationality", :string
+      field :birth_date, "birth_date", :string
+      field :expiry_date, "expiry_date", :string
+      field :sex, "sex", :string
+      field :document_type, "document_type", :string
+      field :document_number, "document_number", :string
+      field :optional_data, "optional_data", :string
+      field :optional_data_2, "optional_data_2", :string
+      field :birth_date_hash, "birth_date_hash", :string
+      field :expiry_date_hash, "expiry_date_hash", :string
+      field :document_number_hash, "document_number_hash", :string
+      field :final_hash, "final_hash", :string
+      field :personal_number, "personal_number", :string
+      field :warnings, "warnings", [:array, :string]
+      field :errors, "errors", [:array, :string]
+      field :mrz_type, "mrz_type", :string
+      field :mrz_string, "mrz_string", :string
+      field :mrz_key, "mrz_key", :string
+    end
+
+    # Structured, geocoded breakdown of `address`. `null` when the document carries no address or it could not be
+    # parsed.
+    class IdVerificationVerifyResponseIdVerificationParsedAddress < Didit::Model
+      field :street_1, "street_1", :string
+      field :street_2, "street_2", :string
+      field :city, "city", :string
+      field :region, "region", :string
+      field :country, "country", :string
+      field :postal_code, "postal_code", :string
+      field :address_type, "address_type", :string
+      field :formatted_address, "formatted_address", :string
+      field :raw_results, "raw_results", :any
+      field :document_location, "document_location", "IdVerificationVerifyResponseIdVerificationParsedAddressDocumentLocation"
+      field :label, "label", :string
+      field :is_verified, "is_verified", :boolean
+      field :category, "category", :string
+    end
+
+    # Geocoded coordinates of the document address.
+    class IdVerificationVerifyResponseIdVerificationParsedAddressDocumentLocation < Didit::Model
+      field :latitude, "latitude", :float
+      field :longitude, "longitude", :float
+    end
+
+    class IdVerificationVerifyResponseIdVerificationWarnings < Didit::Model
+      field :risk, "risk", :string
+      field :feature, "feature", :string
+      field :additional_data, "additional_data", :any
+      field :log_type, "log_type", :string
+      field :short_description, "short_description", :string
+      field :long_description, "long_description", :string
+    end
+  end
+end

data/lib/didit/types/id_wallets.rb

@@ -0,0 +1,8 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+
+  end
+end

data/lib/didit/types/investigator.rb

@@ -0,0 +1,221 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Known values of an open enum: the API may send others.
+    module InvestigatorExportActivityParamsGroup
+      AGENT = "agent"
+      DECISIONS = "decisions"
+      OVERRIDES = "overrides"
+      AUTONOMY = "autonomy"
+
+      VALUES = [AGENT, DECISIONS, OVERRIDES, AUTONOMY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorExportActivityParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListActivityParamsGroup
+      AGENT = "agent"
+      DECISIONS = "decisions"
+      OVERRIDES = "overrides"
+      AUTONOMY = "autonomy"
+
+      VALUES = [AGENT, DECISIONS, OVERRIDES, AUTONOMY].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListActivityParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListGuardrailsResponseResultsKey
+      SANCTIONS_TO_PERSON = "sanctions_to_person"
+      NO_TIPPING_OFF = "no_tipping_off"
+      NO_PROTECTED_CHARACTERISTICS = "no_protected_characteristics"
+      NEVER_FILES_REPORTS = "never_files_reports"
+      EVERY_DECISION_LOGGED = "every_decision_logged"
+
+      VALUES = [SANCTIONS_TO_PERSON, NO_TIPPING_OFF, NO_PROTECTED_CHARACTERISTICS, NEVER_FILES_REPORTS, EVERY_DECISION_LOGGED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListQueueParamsConfidence
+      HIGH = "high"
+      MODERATE = "moderate"
+      LOW = "low"
+
+      VALUES = [HIGH, MODERATE, LOW].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListQueueParamsQueue
+      KYC = "kyc"
+      KYB = "kyb"
+      AML = "aml"
+      TRANSACTIONS = "transactions"
+      CASES = "cases"
+
+      VALUES = [KYC, KYB, AML, TRANSACTIONS, CASES].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListQueueParamsRecommendation
+      APPROVE = "approve"
+      DECLINE = "decline"
+      ESCALATE = "escalate"
+      REQUEST = "request"
+
+      VALUES = [APPROVE, DECLINE, ESCALATE, REQUEST].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorListQueueParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorOverrideRunParamsAction
+      APPROVE = "approve"
+      DECLINE = "decline"
+      ESCALATE = "escalate"
+      REQUEST = "request"
+
+      VALUES = [APPROVE, DECLINE, ESCALATE, REQUEST].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorOverrideRunParamsCategory
+      MISSING_CONTEXT = "missing_context"
+      NEEDS_INFORMATION = "needs_information"
+      POLICY_DIFFERS = "policy_differs"
+      EVIDENCE_MISREAD = "evidence_misread"
+      OTHER = "other"
+
+      VALUES = [MISSING_CONTEXT, NEEDS_INFORMATION, POLICY_DIFFERS, EVIDENCE_MISREAD, OTHER].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorRetrieveDashboardParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorRetrievePerformanceParamsPeriod
+      V_7 = "7"
+      V_30 = "30"
+      V_90 = "90"
+
+      VALUES = [V_7, V_30, V_90].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorRetrievePerformanceParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorRetrieveSummaryParamsScope
+      ALL = "all"
+      IDENTITY = "identity"
+      TRANSACTIONS = "transactions"
+
+      VALUES = [ALL, IDENTITY, TRANSACTIONS].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module InvestigatorUpdateSettingsParamsStage
+      NONE = "none"
+      SHADOW = "shadow"
+      LIVE = "live"
+
+      VALUES = [NONE, SHADOW, LIVE].freeze
+    end
+
+    class InvestigatorListActivityResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :counts, "counts", :any
+      field :actors, "actors", [:array, :any]
+      field :results, "results", [:array, :any]
+    end
+
+    class InvestigatorListGuardrailsResponse < Didit::Model
+      field :results, "results", [:array, "InvestigatorListGuardrailsResponseResults"]
+    end
+
+    class InvestigatorListGuardrailsResponseResults < Didit::Model
+      field :key, "key", :string
+      field :title, "title", :string
+      field :description, "description", :string
+      field :locked, "locked", :boolean
+    end
+
+    class InvestigatorListQueueResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :counts, "counts", :any
+      field :results, "results", [:array, "InvestigatorQueueRow"]
+    end
+
+    class InvestigatorRetrieveDashboardResponse < Didit::Model
+      field :stage, "stage", :string
+      field :window_days, "window_days", :integer
+      field :reviews, "reviews", :integer
+      field :decided, "decided", :integer
+      field :automated, "automated", :integer
+      field :automation_rate, "automation_rate", :float
+      field :hours_saved, "hours_saved", :float
+    end
+
+    class InvestigatorRetrievePerformanceResponse < Didit::Model
+      field :period, "period", :integer
+      field :start, "start", :date
+      field :end, "end", :date
+      field :investigated, "investigated", :integer
+    end
+
+    class InvestigatorRetrieveSummaryResponse < Didit::Model
+      field :stage, "stage", :string
+      field :last_report_at, "last_report_at", :datetime
+      field :prepared_today, "prepared_today", :integer
+      field :ready_to_accept, "ready_to_accept", :integer
+      field :open, "open", :integer
+      field :decided_today, "decided_today", :integer
+      field :automation_rate_month, "automation_rate_month", :float
+      field :preparing, "preparing", :integer
+    end
+
+    class InvestigatorRetrieveTransactionResponse < Didit::Model
+      field :transaction_id, "transaction_id", :string
+      field :investigator, "investigator", "InvestigatorBlock"
+    end
+  end
+end

data/lib/didit/types/ip.rb

@@ -0,0 +1,8 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+
+  end
+end