didit-sdk 1.0.0

data/lib/didit/resources/customization.rb

@@ -0,0 +1,153 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +customization+ resource.
+    class Customization < Didit::Resource
+      # Get branding customization
+      #
+      # Returns the white-label branding for the application resolved from the API key: colors, fonts, border radii,
+      # logo URLs and UI/UX options. Custom domain and white-label email settings are managed only in the Business
+      # Console and are not part of this response.
+      #
+      # +GET /v3/customization/+
+      #
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::BrandingCustomization]
+      def retrieve(request_options: nil)
+        @client.request(
+          :get,
+          "/v3/customization/",
+          response: Types::BrandingCustomization,
+          request_options: request_options
+        )
+      end
+
+      # Update branding customization
+      #
+      # Partial update of the application's white-label branding. Send `application/json` to change colors, fonts,
+      # radii and UI options, or `multipart/form-data` to upload logo images. Only the fields you include are changed.
+      # Custom domain and white-label email cannot be set through this endpoint - use the Business Console for those.
+      #
+      # +PATCH /v3/customization/+
+      #
+      # @param color_primary [String] Headers / primary text color.
+      # @param color_secondary [String] Paragraph / secondary text color.
+      # @param color_background [String] Page background color.
+      # @param color_panel [String] Panel / accent color.
+      # @param color_panel_10 [String] Panel color at 10% opacity.
+      # @param color_on_panel_1 [String] Support text color on panels.
+      # @param color_on_panel_2 [String] Pill / badge color on panels.
+      # @param color_on_background [String] Text color on background.
+      # @param color_button_1 [String] Primary button color.
+      # @param color_button_2 [String] Secondary button color.
+      # @param color_button_text_1 [String] Primary button text color.
+      # @param color_button_text_2 [String] Secondary button text color.
+      # @param color_pill_text [String] Text color for pills, inputs and selectors.
+      # @param border_radius_panel [Integer] Panel corner radius in pixels.
+      # @param border_radius_buttons [Integer] Button corner radius in pixels.
+      # @param font_family [String] Google Font family name (e.g. `Inter`, `AR One Sans`).
+      # @param font_weight [String] Font weight available for the selected family (e.g. `regular`, `500`, `700`).
+      # @param app_public_name [String, nil] Public name shown in the verification flow.
+      # @param privacy_policy_url [String, nil] Privacy policy URL shown to the end user.
+      # @param skip_welcome_screen [Boolean] Skip the initial welcome screen.
+      # @param disable_login_with_didit [Boolean] Continue as guest instead of showing the login-with-Didit screen.
+      #   Cannot be set back to `false` while a custom domain is configured (400).
+      # @param hide_progress_bar [Boolean] Hide the progress bar during the flow.
+      # @param callback_seconds [Integer] Delay (seconds) before redirecting to the callback URL.
+      # @param delete_logo_square [Boolean] When `true`, removes the current square logo.
+      # @param delete_logo_rectangular [Boolean] When `true`, removes the current rectangular logo.
+      # @param delete_logo_rectangular_dark [Boolean] When `true`, removes the current dark-mode logo, and
+      #   `logo_rectangular_dark` then reads `null`. If the same multipart request also uploads
+      #   `image_rectangular_dark`, the upload wins.
+      # @param delete_favicon [Boolean] When `true`, removes the current favicon.
+      # @param image_square [Pathname, IO, String, Didit::FilePart] Square logo (1:1 aspect ratio). PNG, JPG or WebP,
+      #   at least 512 px on the long side, at most **1 MB**.
+      # @param image_rectangular [Pathname, IO, String, Didit::FilePart] Rectangular logo (2:1 aspect ratio). PNG, JPG
+      #   or WebP, at least 512 px on the long side, at most **1 MB**.
+      # @param image_rectangular_dark [Pathname, IO, String, Didit::FilePart] Rectangular logo for dark mode (2:1
+      #   aspect ratio), shown on a dark background. PNG, JPG or WebP, at least 512 px on the long side, at most **1
+      #   MB**. Returned as `logo_rectangular_dark`.
+      # @param image_favicon [Pathname, IO, String, Didit::FilePart] Favicon image. Max **500 KB**.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::BrandingCustomization]
+      def update(
+        color_primary: OMIT,
+        color_secondary: OMIT,
+        color_background: OMIT,
+        color_panel: OMIT,
+        color_panel_10: OMIT,
+        color_on_panel_1: OMIT,
+        color_on_panel_2: OMIT,
+        color_on_background: OMIT,
+        color_button_1: OMIT,
+        color_button_2: OMIT,
+        color_button_text_1: OMIT,
+        color_button_text_2: OMIT,
+        color_pill_text: OMIT,
+        border_radius_panel: OMIT,
+        border_radius_buttons: OMIT,
+        font_family: OMIT,
+        font_weight: OMIT,
+        app_public_name: OMIT,
+        privacy_policy_url: OMIT,
+        skip_welcome_screen: OMIT,
+        disable_login_with_didit: OMIT,
+        hide_progress_bar: OMIT,
+        callback_seconds: OMIT,
+        delete_logo_square: OMIT,
+        delete_logo_rectangular: OMIT,
+        delete_logo_rectangular_dark: OMIT,
+        delete_favicon: OMIT,
+        image_square: OMIT,
+        image_rectangular: OMIT,
+        image_rectangular_dark: OMIT,
+        image_favicon: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :patch,
+          "/v3/customization/",
+          body: {
+            "color_primary" => color_primary,
+            "color_secondary" => color_secondary,
+            "color_background" => color_background,
+            "color_panel" => color_panel,
+            "color_panel_10" => color_panel_10,
+            "color_on_panel_1" => color_on_panel_1,
+            "color_on_panel_2" => color_on_panel_2,
+            "color_on_background" => color_on_background,
+            "color_button_1" => color_button_1,
+            "color_button_2" => color_button_2,
+            "color_button_text_1" => color_button_text_1,
+            "color_button_text_2" => color_button_text_2,
+            "color_pill_text" => color_pill_text,
+            "border_radius_panel" => border_radius_panel,
+            "border_radius_buttons" => border_radius_buttons,
+            "font_family" => font_family,
+            "font_weight" => font_weight,
+            "app_public_name" => app_public_name,
+            "privacy_policy_url" => privacy_policy_url,
+            "skip_welcome_screen" => skip_welcome_screen,
+            "disable_login_with_didit" => disable_login_with_didit,
+            "hide_progress_bar" => hide_progress_bar,
+            "callback_seconds" => callback_seconds,
+            "delete_logo_square" => delete_logo_square,
+            "delete_logo_rectangular" => delete_logo_rectangular,
+            "delete_logo_rectangular_dark" => delete_logo_rectangular_dark,
+            "delete_favicon" => delete_favicon,
+            "image_square" => image_square,
+            "image_rectangular" => image_rectangular,
+            "image_rectangular_dark" => image_rectangular_dark,
+            "image_favicon" => image_favicon
+          },
+          encoding: :auto,
+          file_fields: %w[image_favicon image_rectangular image_rectangular_dark image_square],
+          response: Types::BrandingCustomization,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/didit/resources/database_validation.rb

@@ -0,0 +1,327 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +database_validation+ resource.
+    class DatabaseValidation < Didit::Resource
+      # Database Validation (standalone)
+      #
+      # Validate a person's identity data against official government and registry sources - CPF in Brazil, RENAPER in
+      # Argentina, DNI registries in Spain and Peru, INE in Mexico, and 100+ more services across 60+ countries.
+      #
+      # **Service selection.** Each country exposes one or more catalog services identified by a `service_id` (e.g.
+      # `bra_cpf`, `arg_renaper`, `pan_cedula_sib`). Pin the services you want with the `services` array - if you omit
+      # it, exactly **one** default service runs (the longest-established live service for the country). Sending
+      # `services` also switches the response to the extended shape with `services_used` and `match_score`. Discover
+      # services, their required fields, and prices via `GET /v1/organization/database-validation-countries/` (a
+      # catalog endpoint not documented in this spec) or the Business Console workflow editor. Some services are
+      # flagged `requires_consent=true` in the catalog and demand `consent=true`; others require onboarding for your
+      # organization before they can be called.
+      #
+      # **Input fields.** `identification_number` is a universal field that maps to the right country-specific field
+      # automatically (see its description). Country format rules are enforced before any provider is called (e.g. BRA
+      # CPF must be exactly 11 digits) and format failures are never billed. Biometric services need a `selfie` upload
+      # (multipart only); Argentina RENAPER additionally requires `gender`.
+      #
+      # **Results.** Each service returns a field-by-field `validation` map plus a vendor-neutral `outcome_code`
+      # (`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`). Note the distinctions: `NO_MATCH` is a
+      # definitive mismatch, `INCONCLUSIVE` means the registry could not confirm either way (review, not decline), and
+      # `BIOMETRIC_IMAGE_UNUSABLE` is a technical selfie problem (retake), unlike the definitive `BIOMETRIC_NO_MATCH`.
+      # The overall `match_type` aggregates across services (any full → `full_match`, else any partial →
+      # `partial_match`, else `no_match`) and `no_match_action`/`partial_match_action` translate it into the final
+      # `status`. `validation_type` is derived: `two_by_two` when two or more distinct services produced a full match
+      # (on the identification number, on full name + date of birth together, or on the address without
+      # contradictions), else `one_by_one`.
+      #
+      # **Persistence.** `save_api_request` defaults to **true**: the result is stored as a session (`request_id`
+      # works with `GET /v3/session/{sessionId}/decision/`), appears in the console, and fires a `status.updated`
+      # webhook. It also controls the `validations` shape - per-service objects when saved, a merged `{field: match}`
+      # map when not.
+      #
+      # **Billing.** Per-service: each service that returns a billable result is charged its own catalog price. Failed
+      # or skipped services are not billed, and requests rejected with `400` cost nothing. The pre-flight balance
+      # check covers the sum of the selected services' prices (`403` when short).
+      #
+      # **Failures.** When no selected service returns a usable result, the API returns `400` with `validation_errors`
+      # if every unanswered attempt explicitly refused the input (`provider_rejected_input`, `retryable: false`).
+      # Correct the input before trying again. Otherwise it returns `502` with `validation_errors`
+      # (`empty_provider_response`, `retryable: true`), including mixed input rejection and unavailable fallback
+      # attempts; nothing is billed (a session is still recorded with status `Not Finished` when
+      # `save_api_request=true`). When only some services fail, the `200` response carries their failures in
+      # `database_validation.errors`.
+      #
+      # **Sandbox.** Keys from sandbox applications skip the registry calls and billing and return a static
+      # `full_match` response - the sandbox payload always includes `services_used` and `match_score: 100` regardless
+      # of how `services` was sent, so don't validate the live extended-shape gating or the 0.0-1.0 `match_score`
+      # fraction against sandbox responses.
+      #
+      # Send the request as `application/json`, or as `multipart/form-data` when uploading a `selfie`.
+      #
+      # +POST /v3/database-validation/+
+      #
+      # @param issuing_state [String] ISO 3166-1 **alpha-3** country code of the registry to validate against (e.g.
+      #   `BRA`, `ESP`, `COL`). Determines which services are available. Unsupported codes return `400` with the full
+      #   list of valid options.
+      # @param services [Array<String>] Catalog `service_id`s to run for this country (e.g. `["bra_cpf"]`). Also
+      #   accepts a single string or a comma-separated/JSON-encoded string. **If omitted or empty, exactly one default
+      #   service runs** - the longest-established live service for the country; newer, biometric, and pay-as-you-go
+      #   services must be named explicitly. Sending `services` switches the response to the extended shape (adds
+      #   `servi...
+      # @param validation_type [String] DEPRECATED. Accepted for backward compatibility but ignored - the response
+      #   `validation_type` is now derived from how many services full-matched. Use `services` to pin specific services.
+      # @param consent [Boolean] Set to `true` when the end user has explicitly consented to the selected validation
+      #   services. Required for services flagged `requires_consent=true` in the catalog - without it those services
+      #   return `400` with `services_requiring_consent`.
+      # @param identification_number [String] Universal identification number - automatically mapped to the correct
+      #   country-specific field, so you can use it instead of `personal_number`/`tax_number`/`document_number`:
+      #   ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 digits), CHL→personal_number
+      #   (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 digits),
+      #   ECU→personal...
+      # @param first_name [String] The individual's first name. Required by some services/countries.
+      # @param last_name [String] The individual's last name. Required by some services/countries.
+      # @param middle_name [String] Middle name, used by some country services (AUS, NZL, …).
+      # @param full_name [String] Full name - some services accept this in lieu of first/last name (e.g. CHN services,
+      #   which match the native-script name).
+      # @param date_of_birth [Date, String] Date of birth, `YYYY-MM-DD`. Required by many services.
+      # @param personal_number [String] Government-issued unique personal identifier. Used by: CHL (RUT), COL
+      #   (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Consider
+      #   `identification_number` instead.
+      # @param tax_number [String] Tax identification number. Used by: BRA (CPF, 11 digits). Consider
+      #   `identification_number` instead.
+      # @param document_number [String] Document number. Used by: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI),
+      #   SLV (DUI), VEN (Cédula). Consider `identification_number` instead.
+      # @param document_type [String] 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).
+      # @param expiration_date [Date, String] Document expiration date, `YYYY-MM-DD`. Required for ESP (Spain)
+      #   validation.
+      # @param date_of_issue [Date, String] Document issue date, `YYYY-MM-DD` (fecha de expedición). Required for COL
+      #   (Colombia) cédula validation.
+      # @param nationality [String] Nationality as ISO 3166-1 alpha-3. Required by some services.
+      # @param gender [String] Gender: `M`, `F`, or `X` (other/unknown). Required for Argentina's RENAPER validation
+      #   (`arg_renaper`).
+      # @param address [Hash, String] Residential address. Prefer the structured object `{"street_1":"123 Main
+      #   St","street_2":"Apt 4B","city":"Springfield","region":"IL","postal_code":"62701","country":"US"}`; a complete
+      #   single-line string is still accepted. Required by address-verification services; when a service defines
+      #   address requirements, missing parts return `400` with `address_fields_required_by`.
+      # @param address_element_1 [String] Street address including street number and type. If omitted, derived from
+      #   `address`.
+      # @param address_element_2 [String] Apartment, unit, building, floor, or extra address line. Only send when you
+      #   have it explicitly.
+      # @param address_element_3 [String] City, suburb, district, locality, or neighborhood. If omitted, derived from
+      #   `address`.
+      # @param address_element_4 [String] State, province, region, or town. If omitted, derived from `address`.
+      # @param address_element_5 [String] Postcode or postal code. `postal_code` is accepted as an alias.
+      # @param postal_code [String] Postal code for address-based services (alias of `address_element_5`).
+      # @param driver_license_number [String] Driver licence number for government document-verification services
+      #   (AUS, NZL, IND).
+      # @param driver_license_card_number [String] Physical driver licence card number, where required separately from
+      #   the licence number (AUS).
+      # @param driver_license_state [String] Driver licence state or territory of issue (AUS).
+      # @param driver_license_version [String] Driver licence version code (NZL).
+      # @param passport_number [String] Passport number for government passport-verification services (AUS, NZL, IND,
+      #   CHN).
+      # @param passport_expiration_date [Date, String] Passport expiry date, `YYYY-MM-DD`, for passport-verification
+      #   services.
+      # @param passport_file_number [String] Passport file number (IND).
+      # @param passport_issue_country [String] Issuing country of the passport (ISO 3166-1 alpha-3) for
+      #   passport-verification services.
+      # @param medicare_card_number [String] Medicare card number (AUS).
+      # @param immi_card_number [String] Australian ImmiCard number.
+      # @param immi_card_expiry_date [Date, String] Australian ImmiCard expiry date.
+      # @param citizenship_certificate_number [String] Citizenship certificate number (AUS).
+      # @param birth_registration_number [String] Birth-certificate registration number (AUS).
+      # @param birth_registration_date [Date, String] Birth-certificate registration date (AUS).
+      # @param birth_registration_state [String] Birth-certificate registration state (AUS).
+      # @param marriage_certificate_number [String] Marriage certificate number (AUS).
+      # @param change_of_name_certificate_number [String] Change-of-name certificate number (AUS).
+      # @param first_partner_name [String] First name of the partner on a marriage certificate (AUS).
+      # @param last_partner_name [String] Last name of the partner on a marriage certificate (AUS).
+      # @param voter_id [String] Voter registration number (IND EPIC, IRL).
+      # @param epic_card [String] India EPIC voter card number.
+      # @param pan [String] India PAN (Permanent Account Number).
+      # @param national_id [String] National ID number (CHN, MYS, KEN, KHM, NGA, ZAF, …).
+      # @param cic [String] Mexican INE/IFE Código de Identificación de Credencial (CIC), 9 digits. Used by the MEX
+      #   INE credential-validity service (`mex_ine_vigencia`).
+      # @param identificador_ciudadano [String] Mexican INE Identificador del Ciudadano (9 digits). Used with `cic`
+      #   for modern INE models (E/F/G/H) in `mex_ine_vigencia`.
+      # @param ocr [String] Mexican INE OCR number (13 digits, back of card). Used with `cic` for Model D in
+      #   `mex_ine_vigencia`.
+      # @param voter_number [String] Mexican INE Clave de Elector (18 chars). Used with `emission_number` for legacy
+      #   IFE models (A/B/C) in `mex_ine_vigencia`.
+      # @param emission_number [String] Mexican INE Número de Emisión. Used with `voter_number` for legacy IFE models
+      #   (A/B/C) in `mex_ine_vigencia`.
+      # @param bvn [String] Nigerian Bank Verification Number.
+      # @param bank_card_number [String] Bank card number (CHN bank-card verification).
+      # @param ssn [String] Social Security Number (USA).
+      # @param phone [String] Phone number for phone-verification services.
+      # @param landline [String] Landline number for phone-verification services.
+      # @param email [String] Email address for identity-verification services.
+      # @param country_of_residence [String] ISO 3166-1 alpha-2 country of residence. Used by global
+      #   identity-enrichment services (e.g. `glb_identity_enrichment`) to focus the lookup.
+      # @param partial_match_action [String] What a `partial_match` does to `database_validation.status`. Defaults to
+      #   `NO_ACTION` (status stays `Approved`, with a warning).
+      # @param no_match_action [String] What a `no_match` does to `database_validation.status`. Defaults to `DECLINE`.
+      # @param save_api_request [Boolean] Persist the validation as a session (console visibility, decision endpoint,
+      #   `status.updated` webhook). Also changes the `validations` response shape: per-service objects when `true`
+      #   (default), a merged field map when `false`.
+      # @param vendor_data [String] Your identifier for the validated user; echoed back and stored with the session.
+      # @param metadata [Hash, nil] Free-form JSON stored with the request and echoed back.
+      # @param selfie [Pathname, IO, String, Didit::FilePart] Selfie image (`jpg`, `jpeg`, `png`, `webp`; max 2 MB -
+      #   images are compressed to ~1.5 MB before upload to the registry) for biometric validation services, e.g.
+      #   Argentina RENAPER (`arg_renaper`) and Panama SIB (`pan_cedula_sib`, `pan_cedula_sib_plus`). Required whenever
+      #   a selected service lists it as a required field. Only available via `multipart/form-data`.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::DatabaseValidationValidateResponse]
+      def validate(
+        issuing_state:,
+        services: OMIT,
+        validation_type: OMIT,
+        consent: OMIT,
+        identification_number: OMIT,
+        first_name: OMIT,
+        last_name: OMIT,
+        middle_name: OMIT,
+        full_name: OMIT,
+        date_of_birth: OMIT,
+        personal_number: OMIT,
+        tax_number: OMIT,
+        document_number: OMIT,
+        document_type: OMIT,
+        expiration_date: OMIT,
+        date_of_issue: OMIT,
+        nationality: OMIT,
+        gender: OMIT,
+        address: OMIT,
+        address_element_1: OMIT,
+        address_element_2: OMIT,
+        address_element_3: OMIT,
+        address_element_4: OMIT,
+        address_element_5: OMIT,
+        postal_code: OMIT,
+        driver_license_number: OMIT,
+        driver_license_card_number: OMIT,
+        driver_license_state: OMIT,
+        driver_license_version: OMIT,
+        passport_number: OMIT,
+        passport_expiration_date: OMIT,
+        passport_file_number: OMIT,
+        passport_issue_country: OMIT,
+        medicare_card_number: OMIT,
+        immi_card_number: OMIT,
+        immi_card_expiry_date: OMIT,
+        citizenship_certificate_number: OMIT,
+        birth_registration_number: OMIT,
+        birth_registration_date: OMIT,
+        birth_registration_state: OMIT,
+        marriage_certificate_number: OMIT,
+        change_of_name_certificate_number: OMIT,
+        first_partner_name: OMIT,
+        last_partner_name: OMIT,
+        voter_id: OMIT,
+        epic_card: OMIT,
+        pan: OMIT,
+        national_id: OMIT,
+        cic: OMIT,
+        identificador_ciudadano: OMIT,
+        ocr: OMIT,
+        voter_number: OMIT,
+        emission_number: OMIT,
+        bvn: OMIT,
+        bank_card_number: OMIT,
+        ssn: OMIT,
+        phone: OMIT,
+        landline: OMIT,
+        email: OMIT,
+        country_of_residence: OMIT,
+        partial_match_action: OMIT,
+        no_match_action: OMIT,
+        save_api_request: OMIT,
+        vendor_data: OMIT,
+        metadata: OMIT,
+        selfie: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :post,
+          "/v3/database-validation/",
+          body: {
+            "issuing_state" => issuing_state,
+            "services" => services,
+            "validation_type" => validation_type,
+            "consent" => consent,
+            "identification_number" => identification_number,
+            "first_name" => first_name,
+            "last_name" => last_name,
+            "middle_name" => middle_name,
+            "full_name" => full_name,
+            "date_of_birth" => date_of_birth,
+            "personal_number" => personal_number,
+            "tax_number" => tax_number,
+            "document_number" => document_number,
+            "document_type" => document_type,
+            "expiration_date" => expiration_date,
+            "date_of_issue" => date_of_issue,
+            "nationality" => nationality,
+            "gender" => gender,
+            "address" => address,
+            "address_element_1" => address_element_1,
+            "address_element_2" => address_element_2,
+            "address_element_3" => address_element_3,
+            "address_element_4" => address_element_4,
+            "address_element_5" => address_element_5,
+            "postal_code" => postal_code,
+            "driver_license_number" => driver_license_number,
+            "driver_license_card_number" => driver_license_card_number,
+            "driver_license_state" => driver_license_state,
+            "driver_license_version" => driver_license_version,
+            "passport_number" => passport_number,
+            "passport_expiration_date" => passport_expiration_date,
+            "passport_file_number" => passport_file_number,
+            "passport_issue_country" => passport_issue_country,
+            "medicare_card_number" => medicare_card_number,
+            "immi_card_number" => immi_card_number,
+            "immi_card_expiry_date" => immi_card_expiry_date,
+            "citizenship_certificate_number" => citizenship_certificate_number,
+            "birth_registration_number" => birth_registration_number,
+            "birth_registration_date" => birth_registration_date,
+            "birth_registration_state" => birth_registration_state,
+            "marriage_certificate_number" => marriage_certificate_number,
+            "change_of_name_certificate_number" => change_of_name_certificate_number,
+            "first_partner_name" => first_partner_name,
+            "last_partner_name" => last_partner_name,
+            "voter_id" => voter_id,
+            "epic_card" => epic_card,
+            "pan" => pan,
+            "national_id" => national_id,
+            "cic" => cic,
+            "identificador_ciudadano" => identificador_ciudadano,
+            "ocr" => ocr,
+            "voter_number" => voter_number,
+            "emission_number" => emission_number,
+            "bvn" => bvn,
+            "bank_card_number" => bank_card_number,
+            "ssn" => ssn,
+            "phone" => phone,
+            "landline" => landline,
+            "email" => email,
+            "country_of_residence" => country_of_residence,
+            "partial_match_action" => partial_match_action,
+            "no_match_action" => no_match_action,
+            "save_api_request" => save_api_request,
+            "vendor_data" => vendor_data,
+            "metadata" => metadata,
+            "selfie" => selfie
+          },
+          encoding: :auto,
+          file_fields: %w[selfie],
+          response: Types::DatabaseValidationValidateResponse,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/didit/resources/document_ai.rb

@@ -0,0 +1,145 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +document_ai+ resource.
+    class DocumentAi < Didit::Resource
+      # Document AI (custom field extraction + tamper checks)
+      #
+      # Extract the fields **you** define from any supporting document - payslips, proof of funds, source-of-wealth
+      # letters, tax statements, contracts, invoices - in one call. Send the file plus a `fields` definition (key,
+      # name, extraction instruction, type) and get back typed values (`text`, `number`, `date` as `YYYY-MM-DD`), an
+      # optional name-match score against the expected person or company, PDF/EXIF tamper signals, an
+      # `Approved`/`Declined`/`In Review` `status`, and a `warnings` list explaining every issue found. This is the
+      # server-to-server counterpart of the hosted Document AI workflow step (see
+      # `/core-technology/document-ai/overview`); it uses Didit's default extraction model and does not expose
+      # provider selection.
+      #
+      # **Latency.** Extraction is LLM-based: typical calls take **5-15 seconds**, multi-page PDFs up to **~30
+      # seconds**. Configure a client timeout of **at least 45 seconds** and do not retry before the call completes.
+      #
+      # **Request format.** `multipart/form-data` only. `fields` is **one JSON-encoded array string** (1-30 items, at
+      # most 16 KB); bracket-style form arrays are rejected with `400`. Each item is `{key, name, instruction, type,
+      # required, is_full_name}` - `key` is the JSON key you get back (`^[a-z0-9_]{1,64}$`, unique), `instruction`
+      # tells the model what to read, `type` is `text` (default) | `number` | `date`, `required` raises
+      # `DOCUMENT_AI_MISSING_REQUIRED_FIELDS` when the value cannot be read, and at most one field may set
+      # `is_full_name: true` to mark the value compared against the expected name.
+      #
+      # **Name matching.** Pass `expected_first_name` + `expected_last_name` (person) **or** `expected_company_name`
+      # (+ optional `expected_company_country`) - not both. The value of the `is_full_name` field (or, when none is
+      # marked, the first text field whose key looks like a name) is compared fuzzily; `name_match_score` (0-100) and
+      # `name_on_document` are always returned when both sides exist, and a score below
+      # `document_ai_name_match_score_threshold` (default 80) adds `DOCUMENT_AI_NAME_MISMATCH`, governed by
+      # `document_ai_name_mismatch_action`.
+      #
+      # **Decision logic.** Each risk maps to a configurable action: `DECLINE` → `status: "Declined"`, `REVIEW` →
+      # `status: "In Review"`, `NO_ACTION` → informational only. Defaults mirror the workflow step: unreadable
+      # document `REVIEW`, missing required fields `REVIEW`, suspected manipulation `DECLINE`, name mismatch
+      # `NO_ACTION`, unsupported file `REVIEW`. A document that cannot be processed at all returns `400`; a readable
+      # but problematic document returns `200` with `Declined`/`In Review` - always inspect `document_ai.status` and
+      # `document_ai.warnings`, not just the HTTP code.
+      #
+      # **Billing.** Each `200` response consumes one Document AI API credit - **$0.20 per document** at list, paid
+      # from your plan credit or top-up balance. When the organization's balance cannot cover the call, the endpoint
+      # returns `403` before any processing. Sandbox API keys return a deterministic mock response and are not
+      # charged.
+      #
+      # **Persistence.** With `save_api_request=true` (default) the call is stored as an API-type session: the
+      # document, the extracted values, the field definitions and the name-match snapshot are kept, the session shows
+      # up in the Business Console, and `request_id` works with `GET /v3/session/{sessionId}/decision/`.
+      #
+      # +POST /v3/document-ai/+
+      #
+      # @param document [Pathname, IO, String, Didit::FilePart] The document to read. Allowed extensions: `tiff`,
+      #   `jpg`, `jpeg`, `png`, `pdf`, `webp`, `zip`. Maximum upload size: **30 MB** (larger files are rejected with
+      #   `400`). Multi-page PDFs are supported (expect higher latency); encrypted PDFs are rejected with `400`. Images
+      #   are automatically compressed before processing.
+      # @param fields [String] One JSON-encoded array string with **1-30** field definitions (maximum 16 KB). Each
+      #   item: `key` (required, `^[a-z0-9_]{1,64}$`, unique - the key returned in `extracted_data`), `name` (≤100
+      #   chars, shown in messages), `instruction` (≤500 chars, what the model should read), `type` (`text` default |
+      #   `number` | `date`), `required` (boolean, default `false`), `is_full_name` (boolean, default `false`, a...
+      # @param expected_first_name [String] First name to verify against the document's name field (fuzzy match,
+      #   transliteration-aware). Use together with `expected_last_name`; cannot be combined with
+      #   `expected_company_name`.
+      # @param expected_last_name [String] Last name to verify against the document's name field, combined with
+      #   `expected_first_name` for `name_match_score`.
+      # @param expected_company_name [String] Company name to verify against the document's name field (for business
+      #   documents). Cannot be combined with `expected_first_name` / `expected_last_name` (no example value on purpose
+      #   - the generated request sample uses the person fields; swap them for this one when verifying a business
+      #   document).
+      # @param expected_company_country [String] Optional ISO 3166-1 alpha-2 country code (two ASCII letters, e.g.
+      #   `FR`) that tunes company-name normalization for `expected_company_name`. Only used with
+      #   `expected_company_name`.
+      # @param document_ai_name_match_score_threshold [Integer] Minimum `name_match_score` (0-100) to consider the
+      #   name matched. A lower score adds `DOCUMENT_AI_NAME_MISMATCH`, governed by `document_ai_name_mismatch_action`.
+      # @param document_ai_unreadable_document_action [String] What to do when no field could be read from the
+      #   document (`DOCUMENT_AI_UNREADABLE_DOCUMENT`).
+      # @param document_ai_missing_required_fields_action [String] What to do when at least one `required` field could
+      #   not be read (`DOCUMENT_AI_MISSING_REQUIRED_FIELDS`; `additional_data.missing_fields` lists them).
+      # @param document_ai_document_tampering_action [String] 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`).
+      # @param document_ai_name_mismatch_action [String] What to do when `name_match_score` is below the threshold
+      #   (`DOCUMENT_AI_NAME_MISMATCH`).
+      # @param document_ai_unsupported_file_action [String] What to do when the upload is empty or not a processable
+      #   file (`DOCUMENT_AI_UNSUPPORTED_FILE`).
+      # @param save_api_request [Boolean] When `true` (default), persists the call as an API-type session - visible in
+      #   the Business Console, retrievable via `GET /v3/session/{sessionId}/decision/` using the returned `request_id`,
+      #   with the uploaded document, the extracted values, the field definitions and the name-match snapshot stored.
+      #   When `false`, nothing is stored and `request_id` is a transient UUID for response correlation only; the...
+      # @param vendor_data [String] Optional opaque string (your internal user id, email, UUID…) stored on the
+      #   persisted session and echoed back in the response. Use it to correlate API calls with your own records and to
+      #   filter sessions later.
+      # @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
+      #   back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
+      #   `metadata={"flow":"onboarding"}`) - it is parsed into an object.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::DocumentAiAnalyzeResponse]
+      def analyze(
+        document:,
+        fields:,
+        expected_first_name: OMIT,
+        expected_last_name: OMIT,
+        expected_company_name: OMIT,
+        expected_company_country: OMIT,
+        document_ai_name_match_score_threshold: OMIT,
+        document_ai_unreadable_document_action: OMIT,
+        document_ai_missing_required_fields_action: OMIT,
+        document_ai_document_tampering_action: OMIT,
+        document_ai_name_mismatch_action: OMIT,
+        document_ai_unsupported_file_action: OMIT,
+        save_api_request: OMIT,
+        vendor_data: OMIT,
+        metadata: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :post,
+          "/v3/document-ai/",
+          body: {
+            "document" => document,
+            "fields" => fields,
+            "expected_first_name" => expected_first_name,
+            "expected_last_name" => expected_last_name,
+            "expected_company_name" => expected_company_name,
+            "expected_company_country" => expected_company_country,
+            "document_ai_name_match_score_threshold" => document_ai_name_match_score_threshold,
+            "document_ai_unreadable_document_action" => document_ai_unreadable_document_action,
+            "document_ai_missing_required_fields_action" => document_ai_missing_required_fields_action,
+            "document_ai_document_tampering_action" => document_ai_document_tampering_action,
+            "document_ai_name_mismatch_action" => document_ai_name_mismatch_action,
+            "document_ai_unsupported_file_action" => document_ai_unsupported_file_action,
+            "save_api_request" => save_api_request,
+            "vendor_data" => vendor_data,
+            "metadata" => metadata
+          },
+          encoding: :multipart,
+          file_fields: %w[document],
+          response: Types::DocumentAiAnalyzeResponse,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end