didit-sdk 1.0.0

data/lib/didit/types/customization.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/database_validation.rb

@@ -0,0 +1,177 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Type of document being validated: `P` passport, `DL` driver license, `ID` national ID, `RP` residence permit
+    # (plus `SSC`, `HIC`, `WP`, `TC`, `VISA`, `PSC`, `BC`, `OTHER`). Required by some services (e.g. ESP).
+    module DatabaseValidationValidateParamsDocumentType
+      P = "P"
+      DL = "DL"
+      ID = "ID"
+      RP = "RP"
+      SSC = "SSC"
+      HIC = "HIC"
+      WP = "WP"
+      TC = "TC"
+      VISA = "VISA"
+      PSC = "PSC"
+      BC = "BC"
+      OTHER = "OTHER"
+
+      VALUES = [P, DL, ID, RP, SSC, HIC, WP, TC, VISA, PSC, BC, OTHER].freeze
+    end
+
+    # Gender: `M`, `F`, or `X` (other/unknown). Required for Argentina's RENAPER validation (`arg_renaper`).
+    module DatabaseValidationValidateParamsGender
+      M = "M"
+      F = "F"
+      X = "X"
+
+      VALUES = [M, F, X].freeze
+    end
+
+    # What a `no_match` does to `database_validation.status`. Defaults to `DECLINE`.
+    module DatabaseValidationValidateParamsNoMatchAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # What a `partial_match` does to `database_validation.status`. Defaults to `NO_ACTION` (status stays `Approved`,
+    # with a warning).
+    module DatabaseValidationValidateParamsPartialMatchAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # Overall result aggregated across services with field-level comparisons: any `full_match` → `full_match`; else
+    # any `partial_match` → `partial_match`; else `no_match`. Outcome-only services, such as biometric criminal
+    # screening, can return `null`; inspect each item in `validations` for its `outcome_code`.
+    module DatabaseValidationValidateResponseDatabaseValidationMatchType
+      FULL_MATCH = "full_match"
+      PARTIAL_MATCH = "partial_match"
+      NO_MATCH = "no_match"
+
+      VALUES = [FULL_MATCH, PARTIAL_MATCH, NO_MATCH].freeze
+    end
+
+    # `Declined` when the overall `match_type` triggers a `DECLINE` action (`no_match_action` defaults to `DECLINE`,
+    # `partial_match_action` to `NO_ACTION`); `In Review` when no service produced a usable comparison, for example
+    # when the only selected service came back `REGISTRY_UNAVAILABLE` or `INCONCLUSIVE`; `Approved` otherwise. A
+    # request that selected several services can be `Approved` on one service's match while another was unavailable,
+    # so check `errors` and the per-service `outcome_code`s too.
+    module DatabaseValidationValidateResponseDatabaseValidationStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+      IN_REVIEW = "In Review"
+
+      VALUES = [APPROVED, DECLINED, IN_REVIEW].freeze
+    end
+
+    # Derived from the results: `two_by_two` when ≥2 distinct services produced a full match (on the identification
+    # number, on full name + date of birth together, or on the address without contradictions); `one_by_one`
+    # otherwise. (The request field of the same name is deprecated and ignored.)
+    module DatabaseValidationValidateResponseDatabaseValidationValidationType
+      ONE_BY_ONE = "one_by_one"
+      TWO_BY_TWO = "two_by_two"
+
+      VALUES = [ONE_BY_ONE, TWO_BY_TWO].freeze
+    end
+
+    # Vendor-neutral outcome of the registry lookup. `MATCH`/`PARTIAL_MATCH`/`NO_MATCH` describe the comparison;
+    # `DOCUMENT_NOT_FOUND` means the identifier is not in the registry; `INCONCLUSIVE` means the registry could not
+    # confirm either way (routed to review - NOT a no-match); `BIOMETRIC_NO_MATCH` is a definitive face mismatch while
+    # `BIOMETRIC_IMAGE_UNUSABLE` is a technical image problem (retake the selfie); `DECEASED`/`MINOR_BLOCKED` are
+    # registry-policy outcomes; `DOCUMENT_SUPERSEDED` means the identity matched but the edition of the document
+    # presented is not the one on file (a newer edition has been issued); `INVALID_DOCUMENT_FORMAT`/`INVALID_INPUT`
+    # mean the registry itself rejected the data it was sent; `REGISTRY_UNAVAILABLE`/`REGISTRY_ERROR` indicate
+    # upstream failures.
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1OutcomeCode
+      MATCH = "MATCH"
+      PARTIAL_MATCH = "PARTIAL_MATCH"
+      NO_MATCH = "NO_MATCH"
+      DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND"
+      INVALID_DOCUMENT_FORMAT = "INVALID_DOCUMENT_FORMAT"
+      INVALID_INPUT = "INVALID_INPUT"
+      MINOR_BLOCKED = "MINOR_BLOCKED"
+      DECEASED = "DECEASED"
+      BIOMETRIC_NO_MATCH = "BIOMETRIC_NO_MATCH"
+      BIOMETRIC_IMAGE_UNUSABLE = "BIOMETRIC_IMAGE_UNUSABLE"
+      INCONCLUSIVE = "INCONCLUSIVE"
+      DOCUMENT_SUPERSEDED = "DOCUMENT_SUPERSEDED"
+      REGISTRY_UNAVAILABLE = "REGISTRY_UNAVAILABLE"
+      REGISTRY_ERROR = "REGISTRY_ERROR"
+
+      VALUES = [MATCH, PARTIAL_MATCH, NO_MATCH, DOCUMENT_NOT_FOUND, INVALID_DOCUMENT_FORMAT, INVALID_INPUT, MINOR_BLOCKED, DECEASED, BIOMETRIC_NO_MATCH, BIOMETRIC_IMAGE_UNUSABLE, INCONCLUSIVE, DOCUMENT_SUPERSEDED, REGISTRY_UNAVAILABLE, REGISTRY_ERROR].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1ValidationValue
+      FULL_MATCH = "full_match"
+      PARTIAL_MATCH = "partial_match"
+      NO_MATCH = "no_match"
+
+      VALUES = [FULL_MATCH, PARTIAL_MATCH, NO_MATCH].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module DatabaseValidationValidateResponseDatabaseValidationValidationsVariant2Value
+      FULL_MATCH = "full_match"
+      PARTIAL_MATCH = "partial_match"
+      NO_MATCH = "no_match"
+
+      VALUES = [FULL_MATCH, PARTIAL_MATCH, NO_MATCH].freeze
+    end
+
+    class DatabaseValidationValidateResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :database_validation, "database_validation", "DatabaseValidationValidateResponseDatabaseValidation"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidation < Didit::Model
+      field :status, "status", :string
+      field :issuing_state, "issuing_state", :string
+      field :validation_type, "validation_type", :string
+      field :screened_data, "screened_data", :any
+      field :match_type, "match_type", :string
+      field :validations, "validations", [:union, [[:array, "DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1"], [:map, :string]]]
+      field :warnings, "warnings", [:array, "DatabaseValidationValidateResponseDatabaseValidationWarnings"]
+      field :errors, "errors", [:array, "DatabaseValidationValidateResponseDatabaseValidationErrors"]
+      field :services_used, "services_used", [:array, :string]
+      field :match_score, "match_score", :float
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidationErrors < Didit::Model
+      field :service_id, "service_id", :string
+      field :code, "code", :string
+      field :message, "message", :string
+      field :retryable, "retryable", :boolean
+    end
+
+    # Per-service validation result (returned when `save_api_request=true`, the default).
+    class DatabaseValidationValidateResponseDatabaseValidationValidationsVariant1 < Didit::Model
+      field :service_id, "service_id", :string
+      field :service_name, "service_name", :string
+      field :validation, "validation", [:map, :string]
+      field :outcome_code, "outcome_code", :string
+      field :outcome_detail, "outcome_detail", :string
+      field :source_data, "source_data", :any
+    end
+
+    class DatabaseValidationValidateResponseDatabaseValidationWarnings < Didit::Model
+      field :feature, "feature", :string
+      field :risk, "risk", :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/document_ai.rb

@@ -0,0 +1,135 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What to do when PDF/EXIF forensics suspect manipulation - modified after digital signing, known PDF editor,
+    # overlay-text manipulation, suspicious re-export, image anomalies (`DOCUMENT_AI_SUSPECTED_MANIPULATION`).
+    module DocumentAiAnalyzeParamsDocumentAiDocumentTamperingAction
+      DECLINE = "DECLINE"
+      REVIEW = "REVIEW"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, REVIEW, NO_ACTION].freeze
+    end
+
+    # What to do when at least one `required` field could not be read (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`;
+    # `additional_data.missing_fields` lists them).
+    module DocumentAiAnalyzeParamsDocumentAiMissingRequiredFieldsAction
+      DECLINE = "DECLINE"
+      REVIEW = "REVIEW"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, REVIEW, NO_ACTION].freeze
+    end
+
+    # What to do when `name_match_score` is below the threshold (`DOCUMENT_AI_NAME_MISMATCH`).
+    module DocumentAiAnalyzeParamsDocumentAiNameMismatchAction
+      DECLINE = "DECLINE"
+      REVIEW = "REVIEW"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, REVIEW, NO_ACTION].freeze
+    end
+
+    # What to do when no field could be read from the document (`DOCUMENT_AI_UNREADABLE_DOCUMENT`).
+    module DocumentAiAnalyzeParamsDocumentAiUnreadableDocumentAction
+      DECLINE = "DECLINE"
+      REVIEW = "REVIEW"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, REVIEW, NO_ACTION].freeze
+    end
+
+    # What to do when the upload is empty or not a processable file (`DOCUMENT_AI_UNSUPPORTED_FILE`).
+    module DocumentAiAnalyzeParamsDocumentAiUnsupportedFileAction
+      DECLINE = "DECLINE"
+      REVIEW = "REVIEW"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, REVIEW, NO_ACTION].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module DocumentAiAnalyzeResponseDocumentAiFieldsType
+      TEXT = "text"
+      NUMBER = "number"
+      DATE = "date"
+
+      VALUES = [TEXT, NUMBER, DATE].freeze
+    end
+
+    # `Approved` when no warning resolves to a decline or review; `Declined` when at least one risk maps to `DECLINE`;
+    # otherwise `In Review` when at least one maps to `REVIEW`. The `warnings` list explains why.
+    module DocumentAiAnalyzeResponseDocumentAiStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+      IN_REVIEW = "In Review"
+
+      VALUES = [APPROVED, DECLINED, IN_REVIEW].freeze
+    end
+
+    # Feature that raised the warning. Always `DOCUMENT_AI` on this endpoint.
+    module DocumentAiAnalyzeResponseDocumentAiWarningsFeature
+      DOCUMENT_AI = "DOCUMENT_AI"
+
+      VALUES = [DOCUMENT_AI].freeze
+    end
+
+    # Severity derived from the configured action: `error` (DECLINE), `warning` (REVIEW), `information` (NO_ACTION).
+    module DocumentAiAnalyzeResponseDocumentAiWarningsLogType
+      ERROR = "error"
+      WARNING = "warning"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, WARNING, INFORMATION].freeze
+    end
+
+    # Machine-readable risk code. Each one is governed by the matching `document_ai_*_action` request option.
+    module DocumentAiAnalyzeResponseDocumentAiWarningsRisk
+      DOCUMENT_AI_UNREADABLE_DOCUMENT = "DOCUMENT_AI_UNREADABLE_DOCUMENT"
+      DOCUMENT_AI_MISSING_REQUIRED_FIELDS = "DOCUMENT_AI_MISSING_REQUIRED_FIELDS"
+      DOCUMENT_AI_SUSPECTED_MANIPULATION = "DOCUMENT_AI_SUSPECTED_MANIPULATION"
+      DOCUMENT_AI_NAME_MISMATCH = "DOCUMENT_AI_NAME_MISMATCH"
+      DOCUMENT_AI_UNSUPPORTED_FILE = "DOCUMENT_AI_UNSUPPORTED_FILE"
+
+      VALUES = [DOCUMENT_AI_UNREADABLE_DOCUMENT, DOCUMENT_AI_MISSING_REQUIRED_FIELDS, DOCUMENT_AI_SUSPECTED_MANIPULATION, DOCUMENT_AI_NAME_MISMATCH, DOCUMENT_AI_UNSUPPORTED_FILE].freeze
+    end
+
+    class DocumentAiAnalyzeResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :document_ai, "document_ai", "DocumentAiAnalyzeResponseDocumentAi"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAi < Didit::Model
+      field :status, "status", :string
+      field :extracted_data, "extracted_data", :any
+      field :detected_codes, "detected_codes", [:array, "DocumentAIDetectedCode"]
+      field :fields, "fields", [:array, "DocumentAiAnalyzeResponseDocumentAiFields"]
+      field :name_match_score, "name_match_score", :float
+      field :name_on_document, "name_on_document", :string
+      field :warnings, "warnings", [:array, "DocumentAiAnalyzeResponseDocumentAiWarnings"]
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAiFields < Didit::Model
+      field :key, "key", :string
+      field :name, "name", :string
+      field :instruction, "instruction", :string
+      field :type, "type", :string
+      field :required, "required", :boolean
+      field :is_full_name, "is_full_name", :boolean
+    end
+
+    class DocumentAiAnalyzeResponseDocumentAiWarnings < 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/email.rb

@@ -0,0 +1,116 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What to do when the address appears in known data breaches (`email.is_breached`). `DECLINE` flips the final
+    # `status` to `Declined`; `NO_ACTION` records the risk in `email.warnings`.
+    module EmailCheckCodeParamsBreachedEmailAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when the domain belongs to a disposable/temporary-mail provider (`email.is_disposable`). `DECLINE`
+    # flips the final `status` to `Declined`; `NO_ACTION` records the risk in `email.warnings`.
+    module EmailCheckCodeParamsDisposableEmailAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # What to do when the same address was already used and approved by a different user (only previously Approved
+    # verifications count) (different `vendor_data`) of your application. `DECLINE` flips the final `status` to
+    # `Declined`; `NO_ACTION` records the risk in `email.warnings` and fills `email.matches`.
+    module EmailCheckCodeParamsDuplicatedEmailAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # Action when the social footprint check finds the address registered on none of the platforms it covers. Only
+    # NO_ACTION and DECLINE are accepted on this endpoint; REVIEW is available on the workflow configuration key of
+    # the same name.
+    module EmailCheckCodeParamsEmailNoSocialPresenceAction
+      NO_ACTION = "NO_ACTION"
+      DECLINE = "DECLINE"
+
+      VALUES = [NO_ACTION, DECLINE].freeze
+    end
+
+    # Language of the OTP email template. Defaults to `en`. Unsupported values return `400` listing all supported
+    # locales.
+    module EmailSendCodeParamsOptionsLocale
+      EN = "en"
+      AR = "ar"
+      BN = "bn"
+      BG = "bg"
+      BS = "bs"
+      CA = "ca"
+      CS = "cs"
+      DA = "da"
+      DE = "de"
+      EL = "el"
+      ES = "es"
+      ET = "et"
+      FA = "fa"
+      FI = "fi"
+      FR = "fr"
+      HE = "he"
+      HI = "hi"
+      HR = "hr"
+      HU = "hu"
+      HY = "hy"
+      ID = "id"
+      IT = "it"
+      JA = "ja"
+      KA = "ka"
+      KK = "kk"
+      KO = "ko"
+      KY = "ky"
+      LT = "lt"
+      LV = "lv"
+      CNR = "cnr"
+      MK = "mk"
+      MN = "mn"
+      MS = "ms"
+      NL = "nl"
+      NO = "no"
+      PL = "pl"
+      PT_BR = "pt-BR"
+      PT = "pt"
+      RO = "ro"
+      RU = "ru"
+      SK = "sk"
+      SL = "sl"
+      SO = "so"
+      SQ = "sq"
+      SR = "sr"
+      SV = "sv"
+      TH = "th"
+      TR = "tr"
+      UK = "uk"
+      UZ = "uz"
+      VI = "vi"
+      ZH_CN = "zh-CN"
+      ZH_TW = "zh-TW"
+      ZH = "zh"
+
+      VALUES = [EN, AR, BN, BG, BS, CA, CS, DA, DE, EL, ES, ET, FA, FI, FR, HE, HI, HR, HU, HY, ID, IT, JA, KA, KK, KO, KY, LT, LV, CNR, MK, MN, MS, NL, NO, PL, PT_BR, PT, RO, RU, SK, SL, SO, SQ, SR, SV, TH, TR, UK, UZ, VI, ZH_CN, ZH_TW, ZH].freeze
+    end
+
+    # Platform of the end user's device.
+    module EmailSendCodeParamsSignalsDevicePlatform
+      ANDROID = "android"
+      IOS = "ios"
+      IPADOS = "ipados"
+      TVOS = "tvos"
+      WEB = "web"
+
+      VALUES = [ANDROID, IOS, IPADOS, TVOS, WEB].freeze
+    end
+  end
+end

data/lib/didit/types/face_match.rb

@@ -0,0 +1,93 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # `Approved` when the similarity score is strictly above `face_match_score_decline_threshold` and a score could be
+    # computed; `Declined` otherwise (a warning explains why).
+    module FaceMatchCompareResponseFaceMatchStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, DECLINED].freeze
+    end
+
+    # Feature that raised the warning. Always `FACEMATCH` on this endpoint.
+    module FaceMatchCompareResponseFaceMatchWarningsFeature
+      FACEMATCH = "FACEMATCH"
+
+      VALUES = [FACEMATCH].freeze
+    end
+
+    # Severity. `error` warnings drive `status` to `Declined`; `warning` and `information` entries are advisory and
+    # never decline on their own.
+    module FaceMatchCompareResponseFaceMatchWarningsLogType
+      ERROR = "error"
+      WARNING = "warning"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, WARNING, INFORMATION].freeze
+    end
+
+    # Machine-readable risk code.
+    module FaceMatchCompareResponseFaceMatchWarningsRisk
+      NO_REFERENCE_IMAGE = "NO_REFERENCE_IMAGE"
+      LOW_FACE_MATCH_SIMILARITY = "LOW_FACE_MATCH_SIMILARITY"
+
+      VALUES = [NO_REFERENCE_IMAGE, LOW_FACE_MATCH_SIMILARITY].freeze
+    end
+
+    class FaceMatchCompareResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :face_match, "face_match", "FaceMatchCompareResponseFaceMatch"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class FaceMatchCompareResponseFaceMatch < Didit::Model
+      field :status, "status", :string
+      field :score, "score", :float
+      field :user_image, "user_image", "FaceMatchCompareResponseFaceMatchUserImage"
+      field :ref_image, "ref_image", "FaceMatchCompareResponseFaceMatchRefImage"
+      field :warnings, "warnings", [:array, "FaceMatchCompareResponseFaceMatchWarnings"]
+    end
+
+    # Face-detection results for the reference image, same shape as `user_image`.
+    class FaceMatchCompareResponseFaceMatchRefImage < Didit::Model
+      field :entities, "entities", [:array, "FaceMatchCompareResponseFaceMatchRefImageEntities"]
+      field :best_angle, "best_angle", :integer
+    end
+
+    class FaceMatchCompareResponseFaceMatchRefImageEntities < Didit::Model
+      field :bbox, "bbox", [:array, :integer]
+      field :confidence, "confidence", :float
+      field :age, "age", :float
+      field :gender, "gender", :string
+      field :race, "race", :string
+    end
+
+    # Face-detection results for the analyzed images.
+    class FaceMatchCompareResponseFaceMatchUserImage < Didit::Model
+      field :entities, "entities", [:array, "FaceMatchCompareResponseFaceMatchUserImageEntities"]
+      field :best_angle, "best_angle", :integer
+    end
+
+    class FaceMatchCompareResponseFaceMatchUserImageEntities < Didit::Model
+      field :bbox, "bbox", [:array, :integer]
+      field :confidence, "confidence", :float
+      field :age, "age", :float
+      field :gender, "gender", :string
+      field :race, "race", :string
+    end
+
+    class FaceMatchCompareResponseFaceMatchWarnings < 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/face_search.rb

@@ -0,0 +1,129 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Search policy. `most_similar` (default) ranks every enrolled face in your application by similarity.
+    # `blocklisted_or_approved` restricts candidates to blocklisted faces, allowlisted faces, faces from approved
+    # sessions, and imported user-profile faces - with blocklisted entries ranked first.
+    module FaceSearchSearchParamsSearchType
+      MOST_SIMILAR = "most_similar"
+      BLOCKLISTED_OR_APPROVED = "blocklisted_or_approved"
+
+      VALUES = [MOST_SIMILAR, BLOCKLISTED_OR_APPROVED].freeze
+    end
+
+    # Where the matched face was enrolled from: `session` - a verification session or a saved standalone API call;
+    # `imported` - a face uploaded directly to a User profile; `list_entry` - a face attached to one of your lists;
+    # `retained_template` - an image-free biometric template stored on a User, listed under
+    # `/v3/biometric-templates/`.
+    module FaceSearchSearchResponseFaceSearchMatchesSource
+      SESSION = "session"
+      IMPORTED = "imported"
+      LIST_ENTRY = "list_entry"
+      RETAINED_TEMPLATE = "retained_template"
+
+      VALUES = [SESSION, IMPORTED, LIST_ENTRY, RETAINED_TEMPLATE].freeze
+    end
+
+    # `Declined` only when a `FACE_IN_BLOCKLIST` or `POSSIBLE_FACE_IN_BLOCKLIST` warning fired. Duplicate matches and
+    # multiple-face warnings never decline.
+    module FaceSearchSearchResponseFaceSearchStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, DECLINED].freeze
+    end
+
+    # Feature that raised the warning. Always `LIVENESS` on this endpoint.
+    module FaceSearchSearchResponseFaceSearchWarningsFeature
+      LIVENESS = "LIVENESS"
+
+      VALUES = [LIVENESS].freeze
+    end
+
+    # Severity. `error` warnings drive `status` to `Declined`; `warning` and `information` entries are advisory and
+    # never decline on their own.
+    module FaceSearchSearchResponseFaceSearchWarningsLogType
+      ERROR = "error"
+      WARNING = "warning"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, WARNING, INFORMATION].freeze
+    end
+
+    # Machine-readable risk code.
+    module FaceSearchSearchResponseFaceSearchWarningsRisk
+      MULTIPLE_FACES_DETECTED = "MULTIPLE_FACES_DETECTED"
+      FACE_IN_BLOCKLIST = "FACE_IN_BLOCKLIST"
+      POSSIBLE_FACE_IN_BLOCKLIST = "POSSIBLE_FACE_IN_BLOCKLIST"
+      DUPLICATED_FACE = "DUPLICATED_FACE"
+      POSSIBLE_DUPLICATED_FACE = "POSSIBLE_DUPLICATED_FACE"
+
+      VALUES = [MULTIPLE_FACES_DETECTED, FACE_IN_BLOCKLIST, POSSIBLE_FACE_IN_BLOCKLIST, DUPLICATED_FACE, POSSIBLE_DUPLICATED_FACE].freeze
+    end
+
+    class FaceSearchSearchResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :face_search, "face_search", "FaceSearchSearchResponseFaceSearch"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class FaceSearchSearchResponseFaceSearch < Didit::Model
+      field :status, "status", :string
+      field :total_matches, "total_matches", :integer
+      field :matches, "matches", [:array, "FaceSearchSearchResponseFaceSearchMatches"]
+      field :user_image, "user_image", "FaceSearchSearchResponseFaceSearchUserImage"
+      field :warnings, "warnings", [:array, "FaceSearchSearchResponseFaceSearchWarnings"]
+    end
+
+    class FaceSearchSearchResponseFaceSearchMatches < Didit::Model
+      field :session_id, "session_id", :string
+      field :session_number, "session_number", :integer
+      field :similarity_percentage, "similarity_percentage", :float
+      field :source, "source", :string
+      field :vendor_data, "vendor_data", :string
+      field :vendor_user_id, "vendor_user_id", :string
+      field :biometric_template_id, "biometric_template_id", :string
+      field :verification_date, "verification_date", :datetime
+      field :user_details, "user_details", "FaceSearchSearchResponseFaceSearchMatchesUserDetails"
+      field :match_image_url, "match_image_url", :string
+      field :status, "status", :string
+      field :is_blocklisted, "is_blocklisted", :boolean
+      field :is_allowlisted, "is_allowlisted", :boolean
+      field :api_service, "api_service", :string
+    end
+
+    # Identity data extracted during the matched session's document verification. `null` when the matched session has
+    # no document data (e.g. liveness-only sessions) and always `null` for `retained_template` matches. For `source:
+    # imported` matches it is populated from the User profile instead: `full_name` set,
+    # `document_type`/`document_number` null.
+    class FaceSearchSearchResponseFaceSearchMatchesUserDetails < Didit::Model
+      field :full_name, "full_name", :string
+      field :document_type, "document_type", :string
+      field :document_number, "document_number", :string
+    end
+
+    # Face-detection results for the submitted image. Entries here carry only `bbox` and `confidence`.
+    class FaceSearchSearchResponseFaceSearchUserImage < Didit::Model
+      field :entities, "entities", [:array, "FaceSearchSearchResponseFaceSearchUserImageEntities"]
+      field :best_angle, "best_angle", :integer
+    end
+
+    class FaceSearchSearchResponseFaceSearchUserImageEntities < Didit::Model
+      field :bbox, "bbox", [:array, :integer]
+      field :confidence, "confidence", :float
+    end
+
+    class FaceSearchSearchResponseFaceSearchWarnings < 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/fraud_checks.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