verisec 1.0.0

data/lib/verisec/generated/resources.rb

@@ -0,0 +1,1800 @@
+# frozen_string_literal: true
+
+# Generated by script/generate from spec/openapi.json. Do not edit by hand.
+
+module VeriSec
+  class Client
+    # `client.face`: `face.analyze`, `face.detect`, `face.count`, `face.attributes`, `face.ppe`,
+    # `face.emotion`, `face.crop`, `face.redact`, `face.match`, `face.verify`, `face.similarity`,
+    # `face.search`, `face.dedupe`, `face.watchlist`, `face.cluster`, `face.age`, `face.quality` (Face).
+    #
+    # @return [VeriSec::Resources::Face]
+    attr_reader :face
+
+    # `client.age`: `age.verify`, `age.verifyLive` (Face).
+    #
+    # @return [VeriSec::Resources::Age]
+    attr_reader :age
+
+    # `client.photo`: `photo.compliance`, `photo.policy`, `photo.gate`, `photo.autofix`, `photo.bestFrame`
+    # (Face).
+    #
+    # @return [VeriSec::Resources::Photo]
+    attr_reader :photo
+
+    # `client.liveness`: `liveness.check`, `liveness.antispoof`, `liveness.gate` (Face).
+    #
+    # @return [VeriSec::Resources::Liveness]
+    attr_reader :liveness
+
+    # `client.identity`: `identity.verify` (Face workflows).
+    #
+    # @return [VeriSec::Resources::Identity]
+    attr_reader :identity
+
+    # `client.face_login`: `faceLogin.authenticate` (Face workflows).
+    #
+    # @return [VeriSec::Resources::FaceLogin]
+    attr_reader :face_login
+
+    # `client.fraud`: `fraud.signupCheck` (Face workflows).
+    #
+    # @return [VeriSec::Resources::Fraud]
+    attr_reader :fraud
+
+    # `client.proctor`: `proctor.check` (Face workflows).
+    #
+    # @return [VeriSec::Resources::Proctor]
+    attr_reader :proctor
+
+    # `client.age_gate`: `ageGate.checkout` (Face workflows).
+    #
+    # @return [VeriSec::Resources::AgeGate]
+    attr_reader :age_gate
+
+    # `client.kiosk`: `kiosk.photo` (Face workflows).
+    #
+    # @return [VeriSec::Resources::Kiosk]
+    attr_reader :kiosk
+
+    # `client.documents`: `documents.read`, `documents.classify`, `documents.mrz`, `documents.portrait`,
+    # `documents.authenticity`, `documents.fields` (Document).
+    #
+    # @return [VeriSec::Resources::Documents]
+    attr_reader :documents
+
+    # `client.proof_of_address`: `proofOfAddress.analyze` (Document).
+    #
+    # @return [VeriSec::Resources::ProofOfAddress]
+    attr_reader :proof_of_address
+
+    # `client.mrz`: `mrz.read`, `mrz.recognize`, `mrz.parse` (MRZ).
+    #
+    # @return [VeriSec::Resources::Mrz]
+    attr_reader :mrz
+
+    # `client.email`: `email.verify`, `email.footprint` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Email]
+    attr_reader :email
+
+    # `client.osint`: `osint.username`, `osint.web` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Osint]
+    attr_reader :osint
+
+    # `client.phone`: `phone.lookup`, `phone.otp.send`, `phone.otp.check` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Phone]
+    attr_reader :phone
+
+    # `client.screening`: `screening.ip`, `screening.sanctions`, `screening.crypto` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Screening]
+    attr_reader :screening
+
+    # `client.ip`: `ip.analyze` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Ip]
+    attr_reader :ip
+
+    # `client.contact`: `contact.dossier` (Contact & risk).
+    #
+    # @return [VeriSec::Resources::Contact]
+    attr_reader :contact
+
+    # `client.cheques`: `cheques.read`, `cheques.micr`, `cheques.micrLine`, `cheques.amount`, `cheques.date`,
+    # `cheques.parties`, `cheques.bank` (Cheques).
+    #
+    # @return [VeriSec::Resources::Cheques]
+    attr_reader :cheques
+
+    # `client.banks`: `banks.lookup` (Banks).
+    #
+    # @return [VeriSec::Resources::Banks]
+    attr_reader :banks
+
+    # `client.cards`: `cards.read`, `cards.number`, `cards.expiry`, `cards.check`, `cards.fingerprint`
+    # (Cards).
+    #
+    # @return [VeriSec::Resources::Cards]
+    attr_reader :cards
+
+    # `client.bin`: `bin.lookup` (BIN).
+    #
+    # @return [VeriSec::Resources::Bin]
+    attr_reader :bin
+
+    private
+
+    def build_resources
+      @face = Resources::Face.new(@transport)
+      @age = Resources::Age.new(@transport)
+      @photo = Resources::Photo.new(@transport)
+      @liveness = Resources::Liveness.new(@transport)
+      @identity = Resources::Identity.new(@transport)
+      @face_login = Resources::FaceLogin.new(@transport)
+      @fraud = Resources::Fraud.new(@transport)
+      @proctor = Resources::Proctor.new(@transport)
+      @age_gate = Resources::AgeGate.new(@transport)
+      @kiosk = Resources::Kiosk.new(@transport)
+      @documents = Resources::Documents.new(@transport)
+      @proof_of_address = Resources::ProofOfAddress.new(@transport)
+      @mrz = Resources::Mrz.new(@transport)
+      @email = Resources::Email.new(@transport)
+      @osint = Resources::Osint.new(@transport)
+      @phone = Resources::Phone.new(@transport)
+      @screening = Resources::Screening.new(@transport)
+      @ip = Resources::Ip.new(@transport)
+      @contact = Resources::Contact.new(@transport)
+      @cheques = Resources::Cheques.new(@transport)
+      @banks = Resources::Banks.new(@transport)
+      @cards = Resources::Cards.new(@transport)
+      @bin = Resources::Bin.new(@transport)
+    end
+  end
+
+  module Resources
+    # `client.face`: `face.analyze`, `face.detect`, `face.count`, `face.attributes`, `face.ppe`,
+    # `face.emotion`, `face.crop`, `face.redact`, `face.match`, `face.verify`, `face.similarity`,
+    # `face.search`, `face.dedupe`, `face.watchlist`, `face.cluster`, `face.age`, `face.quality` (Face).
+    class Face < Resource
+      # Face Analyze: `POST /v1/face/analyze`.
+      #
+      # The all-in-one detection call. For every face it returns the box, the tilt, 5 landmarks, an aligned
+      # crop, the attributes you pick and the quality checks you define.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceAnalyzeParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Boolean] :onlyCentralFace Only the central face. Off returns every face in the image.
+      #   (default false)
+      # @option params [Hash] :crop Keys: `type` [String, Integer] (one of "", 0, 1, 2, 3, 4; default 1)
+      #   Aligned crop. An aligned crop of each face at this shape.
+      # @option params [Array<String>] :attributes Attributes to return. Any of the 13 attributes. (default
+      #   ["Age", "EyeRight", "EyeLeft", "Mouth", "Emotion", "Smile", "Glasses", "HeadCovering",
+      #   "ForeheadCovering", "MedicalMask", "Occlusion", "StrongMakeup", "Headphones"])
+      # @option params [Array<Object>] :qualityChecks Your quality checks. A check passes when its value is
+      #   within your range. (default [{"name"=>"Yaw", "range"=>[-5, 5]}, {"name"=>"BlurLevel", "range"=>[0,
+      #   0.15]}])
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceAnalyze] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def analyze(request_options: nil, **params)
+        _json(:post, "/v1/face/analyze", params, Types::FaceAnalyze, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Face Detect: `POST /v1/face/detect`.
+      #
+      # Just the faces: each box, its tilt, 5 landmarks, and the count. No attributes, no quality.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceDetectParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Image. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Boolean] :onlyCentralFace Only the central face. Off returns every face. (default
+      #   false)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceDetect] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def detect(request_options: nil, **params)
+        _json(:post, "/v1/face/detect", params, Types::FaceDetect, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Face Count: `POST /v1/face/count`.
+      #
+      # Confirms an image holds exactly the number of faces you expect, for a capture gate.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceCountParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Image. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Integer] :expected Expected faces. ok is true only when the count equals this.
+      #   (default 1; 0 to 100)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceCount] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def count(request_options: nil, **params)
+        _json(:post, "/v1/face/count", params, Types::FaceCount, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Face Attributes: `POST /v1/face/attributes`.
+      #
+      # The attributes you choose, per face. Age is a range; eyes and mouth are open/closed; emotion is a
+      # label; the rest are yes/no, each with a confidence.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceAttributesParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String>] :attributes (required) Attributes to return.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceAttributes] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def attributes(request_options: nil, **params)
+        _json(:post, "/v1/face/attributes", params, Types::FaceAttributes, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Mask & Glasses (PPE): `POST /v1/face/ppe`.
+      #
+      # Mask, glasses, head and forehead covering, headphones and occlusion, flattened so each item is one
+      # yes/no value per face.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FacePpeParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String>] :items (required) Items to check.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FacePpe] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def ppe(request_options: nil, **params)
+        _json(:post, "/v1/face/ppe", params, Types::FacePpe, envelope: :data, images: { fields: ["image"] },
+              request_options: request_options)
+      end
+
+      # Emotion: `POST /v1/face/emotion`.
+      #
+      # The dominant expression of each face. Send one image for per-face results, or a list of frames for a
+      # per-frame breakdown plus the overall dominant emotion.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceEmotionParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image Face image. One image. Or send frames
+      #   instead. The image as base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :frames Frames. 1 to 10 images of
+      #   the same scene, in order. (each entry an image)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceEmotion] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def emotion(request_options: nil, **params)
+        _json(:post, "/v1/face/emotion", params, Types::FaceEmotion, envelope: :data,
+              images: { fields: ["image"], lists: [{ name: "frames", item_label: "frame" }] },
+              request_options: request_options)
+      end
+
+      # Smart Crop: `POST /v1/face/crop`.
+      #
+      # An aligned, straightened crop of the face at the shape you choose (square for an avatar, 4:5 for a
+      # document).
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceCropParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Image. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Integer] :type Crop shape. (one of 0, 1, 2, 3, 4; default 3)
+      # @option params [Boolean] :onlyCentralFace Only the central face. (default true)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceCrop] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def crop(request_options: nil, **params)
+        _json(:post, "/v1/face/crop", params, Types::FaceCrop, envelope: :data, images: { fields: ["image"] },
+              request_options: request_options)
+      end
+
+      # Face Redact: `POST /v1/face/redact`.
+      #
+      # The image back with every face hidden, blurred, pixelated or boxed out, plus where each face was.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceRedactParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Image. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :mode How to hide faces. (one of "blur", "pixelate", "box"; default "blur")
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceRedact] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def redact(request_options: nil, **params)
+        _json(:post, "/v1/face/redact", params, Types::FaceRedact, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Face Match: `POST /v1/face/match`.
+      #
+      # Compares the faces across two images: every face found in each, with a similarity for each pair. The
+      # 1:1 building block.
+      #
+      # Price: 0.2 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceMatchParams), under the API's names
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :images (required) Images. Exactly
+      #   two images. (exactly 2 items; each entry an image or a Hash with `data`; `index` is filled in)
+      # @option params [Hash] :crop Keys: `type` [String, Integer] (one of "", 0, 1, 2, 3, 4; default "")
+      #   Aligned crop. Adds an aligned crop of every face.
+      # @option params [Integer] :limitComparePerImageTypes Compare limit. A cap on comparisons per image
+      #   type. (1 to 10)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceMatch] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def match(request_options: nil, **params)
+        _json(:post, "/v1/face/match", params, Types::FaceMatch, envelope: :data,
+              images: { lists: [{ name: "images", image_key: "data", index_key: "index", item_label: "image" }] },
+              request_options: request_options)
+      end
+
+      # Face Verify (1:1): `POST /v1/face/verify`.
+      #
+      # A 1:1 decision: the similarity of two faces, and whether it clears your threshold.
+      #
+      # Price: 0.2 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceVerifyParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image1 (required) First face. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String, Pathname, IO, VeriSec::Image] :image2 (required) Second face. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Numeric] :threshold Threshold. match is true at or above this similarity. (default
+      #   0.75; 0 to 1)
+      # @option params [String] :livenessTransactionId Liveness transaction. Links the first face to a passed
+      #   liveness session.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceVerify] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def verify(request_options: nil, **params)
+        _json(:post, "/v1/face/verify", params, Types::FaceVerify, envelope: :data,
+              images: { fields: ["image1", "image2"] }, request_options: request_options)
+      end
+
+      # Similarity Score: `POST /v1/face/similarity`.
+      #
+      # Only the raw numbers: similarity and distance between two faces. No threshold, no decision.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceSimilarityParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image1 (required) First face. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String, Pathname, IO, VeriSec::Image] :image2 (required) Second face. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceSimilarity] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def similarity(request_options: nil, **params)
+        _json(:post, "/v1/face/similarity", params, Types::FaceSimilarity, envelope: :data,
+              images: { fields: ["image1", "image2"] }, request_options: request_options)
+      end
+
+      # Face Search (1:N): `POST /v1/face/search`.
+      #
+      # One face against a gallery you send. Returns the gallery faces at or above your threshold, highest
+      # similarity first.
+      #
+      # Price: 0.3 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceSearchParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :probe (required) Face to find. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :gallery (required) Gallery. 1 to
+      #   10 faces, each with your own id. (1 to 10 items; each entry an image or a Hash with `image`; `id`
+      #   defaults to "face-1", …)
+      # @option params [Integer] :topK Top matches. (default 3; 1 to 10)
+      # @option params [Numeric] :threshold Threshold. Only faces at or above this similarity are matches.
+      #   (default 0.75; 0 to 1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceSearch] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def search(request_options: nil, **params)
+        _json(:post, "/v1/face/search", params, Types::FaceSearch, envelope: :data,
+              images: { fields: ["probe"], lists: [{ name: "gallery", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+
+      # Duplicate Check: `POST /v1/face/dedupe`.
+      #
+      # Whether a new face already exists in your set: the closest existing face and if it clears the
+      # duplicate threshold.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceDedupeParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :candidate (required) New face. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :existing (required) Existing
+      #   faces. 1 to 10 faces, each with your own id. (1 to 10 items; each entry an image or a Hash with
+      #   `image`; `id` defaults to "face-1", …)
+      # @option params [Numeric] :threshold Threshold. A duplicate at or above this similarity. (default 0.8;
+      #   0 to 1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceDedupe] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def dedupe(request_options: nil, **params)
+        _json(:post, "/v1/face/dedupe", params, Types::FaceDedupe, envelope: :data,
+              images: { fields: ["candidate"], lists: [{ name: "existing", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+
+      # Watchlist Screening: `POST /v1/face/watchlist`.
+      #
+      # A face against your own labelled list (blocked, VIP, staff). Returns a hit and the matched entry with
+      # its label.
+      #
+      # Price: 0.3 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceWatchlistParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :probe (required) Face to check. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :list (required) Your list. 1 to 10
+      #   faces, each with your own id and a label. (1 to 10 items; each entry an image or a Hash with
+      #   `image`; `id` defaults to "face-1", …)
+      # @option params [Numeric] :threshold Threshold. A hit at or above this similarity. (default 0.8; 0 to
+      #   1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceWatchlist] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def watchlist(request_options: nil, **params)
+        _json(:post, "/v1/face/watchlist", params, Types::FaceWatchlist, envelope: :data,
+              images: { fields: ["probe"], lists: [{ name: "list", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+
+      # Face Cluster: `POST /v1/face/cluster`.
+      #
+      # Groups faces by person. Every pair is compared, and faces are linked when they clear your threshold.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceClusterParams), under the API's names
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :faces (required) Faces. 2 to 8
+      #   faces, each with your own id. (2 to 8 items; each entry an image or a Hash with `image`; `id`
+      #   defaults to "face-1", …)
+      # @option params [Numeric] :threshold Threshold. Two faces join a group at or above this similarity.
+      #   (default 0.75; 0 to 1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceCluster] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def cluster(request_options: nil, **params)
+        _json(:post, "/v1/face/cluster", params, Types::FaceCluster, envelope: :data,
+              images: { lists: [{ name: "faces", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+
+      # Age Estimation: `POST /v1/face/age`.
+      #
+      # The age range of each face, its midpoint, and an aligned crop. The range is most exact with the crop
+      # on.
+      #
+      # Price: 0.05 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceAgeParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Boolean] :onlyCentralFace Only the central face. (default false)
+      # @option params [Hash] :crop Keys: `type` [String, Integer] (one of "", 0, 1, 2, 3, 4; default 1)
+      #   Aligned crop. Recommended: the range is most exact with a crop.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceAge] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def age(request_options: nil, **params)
+        _json(:post, "/v1/face/age", params, Types::FaceAge, envelope: :data, images: { fields: ["image"] },
+              request_options: request_options)
+      end
+
+      # Photo Quality: `POST /v1/face/quality`.
+      #
+      # Scores a portrait against a standard (ICAO, Schengen, US visa, Full) or your own checks. Returns every
+      # check with its value, its range and pass/fail, plus group roll-ups and an optional crop.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceQualityParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Portrait. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :scenario Standard. (one of "QualityICAO", "QualityVisaSchengen",
+      #   "QualityVisaUSA", "QualityFull"; default "QualityICAO")
+      # @option params [Boolean] :onlyCentralFace Only the central face. (default true)
+      # @option params [Hash] :output Keys: `crop` [Hash]; `backgroundColor` [Array<Integer>] (default [255,
+      #   255, 255]) Crop background. Replaces the background of the crop.
+      # @option params [Object] :customChecks Your own checks. When you add checks, they replace the standard:
+      #   exactly these run, with your ranges.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceQuality] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def quality(request_options: nil, **params)
+        _json(:post, "/v1/face/quality", params, Types::FaceQuality, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+    end
+
+    # `client.age`: `age.verify`, `age.verifyLive` (Face).
+    class Age < Resource
+      # Age Check: `POST /v1/age/verify`.
+      #
+      # An age gate: pass or fail against a minimum age, deciding on the lower end of the range (strict) or
+      # the midpoint.
+      #
+      # Price: 0.05 credits per successful call.
+      #
+      # @param params [Hash] the request fields (AgeVerifyParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Integer] :minAge Minimum age. (default 18; 0 to 120)
+      # @option params [String] :policy Decide on. (one of "lowerBound", "midpoint"; default "lowerBound")
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::AgeVerify] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def verify(request_options: nil, **params)
+        _json(:post, "/v1/age/verify", params, Types::AgeVerify, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Age Check + Liveness: `POST /v1/age/verify-live`.
+      #
+      # The age gate plus liveness: allowed only when the person is old enough AND the face is live.
+      #
+      # Price: 0.25 credits per successful call.
+      #
+      # @param params [Hash] the request fields (AgeVerifyLiveParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Face image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Integer] :minAge Minimum age. (default 21; 0 to 120)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::AgeVerifyLive] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def verify_live(request_options: nil, **params)
+        _json(:post, "/v1/age/verify-live", params, Types::AgeVerifyLive, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+    end
+
+    # `client.photo`: `photo.compliance`, `photo.policy`, `photo.gate`, `photo.autofix`, `photo.bestFrame`
+    # (Face).
+    class Photo < Resource
+      # Photo Compliance: `POST /v1/photo/compliance`.
+      #
+      # A pass/fail against one named passport or visa photo standard, with the list of failed checks.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhotoComplianceParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Portrait. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :standard Standard. (one of "ICAO", "VisaSchengen", "VisaUSA", "Full"; default
+      #   "ICAO")
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhotoCompliance] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def compliance(request_options: nil, **params)
+        _json(:post, "/v1/photo/compliance", params, Types::PhotoCompliance, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Photo Policy: `POST /v1/photo/policy`.
+      #
+      # Your own checks with your own ranges. Exactly the checks you send run, nothing else.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhotoPolicyParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Portrait. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<Object>] :policy (required) Your checks.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhotoPolicy] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def policy(request_options: nil, **params)
+        _json(:post, "/v1/photo/policy", params, Types::PhotoPolicy, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Quality Gate: `POST /v1/photo/gate`.
+      #
+      # A fast good-enough answer. Only the checks you require run, at their standard ranges, so it returns
+      # one ok and the list of any that failed.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhotoGateParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Photo. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String>] :require (required) Required checks.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhotoGate] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def gate(request_options: nil, **params)
+        _json(:post, "/v1/photo/gate", params, Types::PhotoGate, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Photo Auto-fix: `POST /v1/photo/autofix`.
+      #
+      # The portrait cropped to the shape you need, with the background replaced by your colour.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhotoAutofixParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Portrait. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :aspect Shape. (one of "3:4", "4:5", "2:3", "1:1"; default "3:4")
+      # @option params [Array<Integer>] :backgroundColor Background. (default [255, 255, 255]; exactly 3
+      #   items)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhotoAutofix] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def autofix(request_options: nil, **params)
+        _json(:post, "/v1/photo/autofix", params, Types::PhotoAutofix, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Best Frame: `POST /v1/photo/best-frame`.
+      #
+      # Picks the most compliant of several frames against a standard, and shows how every frame ranked.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhotoBestFrameParams), under the API's names
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :frames (required) Frames. 2 to 10
+      #   images of the same scene, in order. (2 to 10 items; each entry an image)
+      # @option params [String] :standard Standard. (one of "ICAO", "VisaSchengen", "VisaUSA", "Full"; default
+      #   "ICAO")
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhotoBestFrame] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def best_frame(request_options: nil, **params)
+        _json(:post, "/v1/photo/best-frame", params, Types::PhotoBestFrame, envelope: :data,
+              images: { lists: [{ name: "frames", item_label: "frame" }] }, request_options: request_options)
+      end
+    end
+
+    # `client.liveness`: `liveness.check`, `liveness.antispoof`, `liveness.gate` (Face).
+    class Liveness < Resource
+      # Liveness: `POST /v1/liveness`.
+      #
+      # Passive liveness from one image. status 0 means live, 1 means not live or undetermined; code carries
+      # the reason; an age estimate comes free.
+      #
+      # Price: 0.2 credits per successful call.
+      #
+      # @param params [Hash] the request fields (LivenessCheckParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::LivenessCheck] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def check(request_options: nil, **params)
+        _json(:post, "/v1/liveness", params, Types::LivenessCheck, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Anti-spoof Reason: `POST /v1/liveness/antispoof`.
+      #
+      # The same check with the reason spelled out: whether it is live, the reason by name, and its category
+      # (a presentation attack or a capture problem).
+      #
+      # Price: 0.2 credits per successful call.
+      #
+      # @param params [Hash] the request fields (LivenessAntispoofParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::LivenessAntispoof] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def antispoof(request_options: nil, **params)
+        _json(:post, "/v1/liveness/antispoof", params, Types::LivenessAntispoof, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Liveness Gate: `POST /v1/liveness/gate`.
+      #
+      # One pass/fail for a pipeline. Strict also requires a clean reason code, not just a live verdict.
+      #
+      # Price: 0.2 credits per successful call.
+      #
+      # @param params [Hash] the request fields (LivenessGateParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Boolean] :strict Strict. Strict also requires a clean reason code. (default true)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::LivenessGate] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def gate(request_options: nil, **params)
+        _json(:post, "/v1/liveness/gate", params, Types::LivenessGate, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+    end
+
+    # `client.identity`: `identity.verify` (Face workflows).
+    class Identity < Resource
+      # Identity Verification: `POST /v1/identity/verify`.
+      #
+      # One call that runs liveness, a quality gate and a 1:1 match against your reference face, and returns
+      # each step plus a single verified verdict.
+      #
+      # Price: 0.42 credits per successful call.
+      #
+      # @param params [Hash] the request fields (IdentityVerifyParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :selfie (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String, Pathname, IO, VeriSec::Image] :reference (required) Reference face. For
+      #   example the portrait from the ID document. The image as base64 (JPEG or PNG). The SDKs also take a
+      #   file path or the file bytes.
+      # @option params [Array<String>] :minQuality Quality checks. (default ["BlurLevel", "OffGaze"])
+      # @option params [Numeric] :threshold Threshold. Match threshold. (default 0.8; 0 to 1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::IdentityVerify] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def verify(request_options: nil, **params)
+        _json(:post, "/v1/identity/verify", params, Types::IdentityVerify, envelope: :data,
+              images: { fields: ["selfie", "reference"] }, request_options: request_options)
+      end
+    end
+
+    # `client.face_login`: `faceLogin.authenticate` (Face workflows).
+    class FaceLogin < Resource
+      # Face Login: `POST /v1/auth/login`.
+      #
+      # Passwordless login: a live selfie searched against your enrolled users. Authenticated only when the
+      # face is live and matches someone above the threshold.
+      #
+      # Price: 0.5 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FaceLoginAuthenticateParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :selfie (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :gallery (required) Enrolled users.
+      #   1 to 10 faces, each with your own id. (1 to 10 items; each entry an image or a Hash with `image`;
+      #   `id` defaults to "face-1", …)
+      # @option params [Numeric] :threshold Threshold. Login at or above this similarity. (default 0.8; 0 to
+      #   1)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FaceLoginAuthenticate] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def authenticate(request_options: nil, **params)
+        _json(:post, "/v1/auth/login", params, Types::FaceLoginAuthenticate, envelope: :data,
+              images: { fields: ["selfie"], lists: [{ name: "gallery", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+    end
+
+    # `client.fraud`: `fraud.signupCheck` (Face workflows).
+    class Fraud < Resource
+      # Sign-up Fraud Check: `POST /v1/fraud/signup-check`.
+      #
+      # At sign-up: is the face live, and has it signed up before? Blocks a duplicate (similarity 0.8+) or a
+      # non-live face.
+      #
+      # Price: 0.5 credits per successful call.
+      #
+      # @param params [Hash] the request fields (FraudSignupCheckParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :selfie (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Array<String, Pathname, IO, VeriSec::Image, Hash>] :existing (required) Existing
+      #   users. 1 to 10 faces, each with your own id. (1 to 10 items; each entry an image or a Hash with
+      #   `image`; `id` defaults to "face-1", …)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::FraudSignupCheck] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def signup_check(request_options: nil, **params)
+        _json(:post, "/v1/fraud/signup-check", params, Types::FraudSignupCheck, envelope: :data,
+              images: { fields: ["selfie"], lists: [{ name: "existing", image_key: "image", id_key: "id", item_label: "face" }] },
+              request_options: request_options)
+      end
+    end
+
+    # `client.proctor`: `proctor.check` (Face workflows).
+    class Proctor < Resource
+      # Proctoring Check: `POST /v1/proctor/check`.
+      #
+      # One webcam frame judged for exam proctoring: live, exactly one face, looking at the screen, and no
+      # mask.
+      #
+      # Price: 0.26 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ProctorCheckParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :frame (required) Webcam frame. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ProctorCheck] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def check(request_options: nil, **params)
+        _json(:post, "/v1/proctor/check", params, Types::ProctorCheck, envelope: :data,
+              images: { fields: ["frame"] }, request_options: request_options)
+      end
+    end
+
+    # `client.age_gate`: `ageGate.checkout` (Face workflows).
+    class AgeGate < Resource
+      # Age-gated Checkout: `POST /v1/age-gate/checkout`.
+      #
+      # Age and liveness together for an age-restricted sale: allowed only when old enough and live.
+      #
+      # Price: 0.25 credits per successful call.
+      #
+      # @param params [Hash] the request fields (AgeGateCheckoutParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :selfie (required) Selfie. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [Integer] :minAge Minimum age. (default 18; 0 to 120)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::AgeGateCheckout] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def checkout(request_options: nil, **params)
+        _json(:post, "/v1/age-gate/checkout", params, Types::AgeGateCheckout, envelope: :data,
+              images: { fields: ["selfie"] }, request_options: request_options)
+      end
+    end
+
+    # `client.kiosk`: `kiosk.photo` (Face workflows).
+    class Kiosk < Resource
+      # Photo Kiosk: `POST /v1/kiosk/photo`.
+      #
+      # A passport/visa photo booth in one call: compliance against a standard, an auto-fixed version, and
+      # whether the fixed photo is ready to print.
+      #
+      # Price: 0.06 credits per successful call.
+      #
+      # @param params [Hash] the request fields (KioskPhotoParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Portrait. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String] :standard Standard. (one of "ICAO", "VisaSchengen", "VisaUSA", "Full"; default
+      #   "ICAO")
+      # @option params [String] :aspect Shape. (one of "3:4", "4:5", "2:3", "1:1"; default "3:4")
+      # @option params [Array<Integer>] :backgroundColor Background. (default [255, 255, 255]; exactly 3
+      #   items)
+      # @option params [String] :tag Tag. Any text you want echoed back in the response.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::KioskPhoto] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def photo(request_options: nil, **params)
+        _json(:post, "/v1/kiosk/photo", params, Types::KioskPhoto, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+    end
+
+    # `client.documents`: `documents.read`, `documents.classify`, `documents.mrz`, `documents.portrait`,
+    # `documents.authenticity`, `documents.fields` (Document).
+    class Documents < Resource
+      # Document Read: `POST /v1/idv/read`.
+      #
+      # The full read of an ID document. Returns every container the reader produced, type, printed and MRZ
+      # fields, portrait, security and image-quality checks, under data.ContainerList. An optional hint says
+      # whether the document matches what you expected.
+      #
+      # Price: 0.35 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentReadParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image_front (required) Document front. The
+      #   image as base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String, Pathname, IO, VeriSec::Image] :image_back Document back. The reverse side,
+      #   when it carries data. The image as base64 (JPEG or PNG). The SDKs also take a file path or the file
+      #   bytes.
+      # @option params [String] :scenario Scenario. (one of "FullProcess", "FullAuth", "Barcode", "Mrz";
+      #   default "FullProcess")
+      # @option params [Hash] :doc_hint Keys: `country` [String] Expected country. ISO code, for example RW or
+      #   RWA.; `type` [String] (one of "", "passport", "national_id", "driving_licence", "residence_permit";
+      #   default "") Expected type.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentRead] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def read(request_options: nil, **params)
+        _json(:post, "/v1/idv/read", params, Types::DocumentRead, envelope: :data,
+              images: { fields: ["image_front", "image_back"] }, request_options: request_options)
+      end
+
+      # Document Classify: `POST /v1/idv/classify`.
+      #
+      # Just the identity of the document: its name, category, issuing country, year and a confidence.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentClassifyParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentClassify] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def classify(request_options: nil, **params)
+        _json(:post, "/v1/idv/classify", params, Types::DocumentClassify, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Document MRZ: `POST /v1/idv/mrz`.
+      #
+      # The MRZ read from the document: the raw lines, the parsed fields, and every check digit recomputed
+      # under ICAO 9303 (the same rule for every country).
+      #
+      # Price: 0.06 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentMrzParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document page with the MRZ.
+      #   The image as base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentMrz] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def mrz(request_options: nil, **params)
+        _json(:post, "/v1/idv/mrz", params, Types::DocumentMrz, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Document Portrait: `POST /v1/idv/portrait`.
+      #
+      # The portrait cut from the document, and a one-time reference you can pass straight to Face Verify or
+      # Face Match as image1.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentPortraitParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentPortrait] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def portrait(request_options: nil, **params)
+        _json(:post, "/v1/idv/portrait", params, Types::DocumentPortrait, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # Document Authenticity: `POST /v1/idv/authenticity`.
+      #
+      # The document's checks and the capture's image quality. Each item is pass, fail or not_checked, with
+      # one overall verdict.
+      #
+      # Price: 0.25 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentAuthenticityParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image_front (required) Document front. The
+      #   image as base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @option params [String, Pathname, IO, VeriSec::Image] :image_back Document back. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentAuthenticity] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def authenticity(request_options: nil, **params)
+        _json(:post, "/v1/idv/authenticity", params, Types::DocumentAuthenticity, envelope: :data,
+              images: { fields: ["image_front", "image_back"] }, request_options: request_options)
+      end
+
+      # Document Fields: `POST /v1/idv/fields`.
+      #
+      # Which fields were read, from which sources, whether each is valid, and whether the sources agree.
+      # Values are masked, so it is safe to log.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # @param params [Hash] the request fields (DocumentFieldsParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document. The image as base64
+      #   (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::DocumentFields] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def fields(request_options: nil, **params)
+        _json(:post, "/v1/idv/fields", params, Types::DocumentFields, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+    end
+
+    # `client.proof_of_address`: `proofOfAddress.analyze` (Document).
+    class ProofOfAddress < Resource
+      # Proof of Address: `POST /v1/poa/analyze`.
+      #
+      # Reads a proof-of-address document (utility bill, bank statement, letter) and checks it against the
+      # name, address and country you expect, with a recency and integrity check.
+      #
+      # Price: 0.4 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ProofOfAddressAnalyzeParams), under the API's names
+      # @option params [String] :document_token (required) Address document. Encrypted in your browser; the
+      #   API takes the token of the stored document. A document token from the vault. (passed as it is)
+      # @option params [String] :filename File name.
+      # @option params [Hash] :expected Keys: `name` [String] Expected name.; `address` [String] Expected
+      #   address.; `country` [String] Expected country. ISO alpha-2, for example RW.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ProofOfAddressAnalyze] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def analyze(request_options: nil, **params)
+        _json(:post, "/v1/poa/analyze", params, Types::ProofOfAddressAnalyze, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.mrz`: `mrz.read`, `mrz.recognize`, `mrz.parse` (MRZ).
+    class Mrz < Resource
+      # MRZ Read: `POST /v1/mrz/read`.
+      #
+      # Finds the MRZ in an image, reads it, parses every field, and validates every check digit under ICAO
+      # 9303.
+      #
+      # Price: 0.01 credits per successful call.
+      #
+      # @param params [Hash] the request fields (MrzReadParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::MrzRead] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def read(request_options: nil, **params)
+        _json(:post, "/v1/mrz/read", params, Types::MrzRead, envelope: :data, images: { fields: ["image"] },
+              request_options: request_options)
+      end
+
+      # MRZ Recognize: `POST /v1/mrz/recognize`.
+      #
+      # Only the MRZ lines, where they are, and how confident the read is. No parsing.
+      #
+      # Price: 0.01 credits per successful call.
+      #
+      # @param params [Hash] the request fields (MrzRecognizeParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::Image] :image (required) Document image. The image as
+      #   base64 (JPEG or PNG). The SDKs also take a file path or the file bytes.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::MrzRecognize] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def recognize(request_options: nil, **params)
+        _json(:post, "/v1/mrz/recognize", params, Types::MrzRecognize, envelope: :data,
+              images: { fields: ["image"] }, request_options: request_options)
+      end
+
+      # MRZ Parse: `POST /v1/mrz/parse`.
+      #
+      # Parses MRZ lines you already have (no image): every field, every check digit recomputed, and a check
+      # that the dates are real.
+      #
+      # Price: 0.002 credits per successful call.
+      #
+      # @param params [Hash] the request fields (MrzParseParams), under the API's names
+      # @option params [Array<String>] :lines (required) MRZ lines. An ID card has 3 lines of 30 characters, a
+      #   passport 2 lines of 44.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::MrzParse] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def parse(request_options: nil, **params)
+        _json(:post, "/v1/mrz/parse", params, Types::MrzParse, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.email`: `email.verify`, `email.footprint` (Contact & risk).
+    class Email < Resource
+      # Email Risk: `POST /v1/email/verify`.
+      #
+      # Whether an address can receive mail and whether the mailbox exists, flagging temporary inboxes and
+      # typos, with a risk level and the reasons behind it.
+      #
+      # Price: 0.05 credits per successful call.
+      #
+      # @param params [Hash] the request fields (EmailVerifyParams), under the API's names
+      # @option params [String] :email (required) Email.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::EmailVerify] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def verify(request_options: nil, **params)
+        _json(:post, "/v1/email/verify", params, Types::EmailVerify, envelope: :data,
+              request_options: request_options)
+      end
+
+      # Email Accounts: `POST /v1/email/footprint`.
+      #
+      # The sites where an email address has an account, found through each site's sign-up and recovery forms.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (EmailFootprintParams), under the API's names
+      # @option params [String] :email (required) Email.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::EmailFootprint] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def footprint(request_options: nil, **params)
+        _json(:post, "/v1/email/footprint", params, Types::EmailFootprint, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.osint`: `osint.username`, `osint.web` (Contact & risk).
+    class Osint < Resource
+      # Username Search: `POST /v1/osint/username`.
+      #
+      # Public profiles that use a username, across hundreds of sites. Profiles whose page does not actually
+      # contain the name are dropped.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (OsintUsernameParams), under the API's names
+      # @option params [String] :username (required) Username.
+      # @option params [Integer] :top Sites to check. The most visited sites first. (default 150; 10 to 500)
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::OsintUsername] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def username(request_options: nil, **params)
+        _json(:post, "/v1/osint/username", params, Types::OsintUsername, envelope: :data,
+              request_options: request_options)
+      end
+
+      # Adverse Media: `POST /v1/osint/web`.
+      #
+      # Web pages that name a person or company, filtered to adverse news by default and tagged with risk
+      # topics.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (OsintWebParams), under the API's names
+      # @option params [String] :query (required) Name.
+      # @option params [String] :mode Show. (one of "aml", "all"; default "aml")
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::OsintWeb] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def web(request_options: nil, **params)
+        _json(:post, "/v1/osint/web", params, Types::OsintWeb, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.phone`: `phone.lookup`, `phone.otp.send`, `phone.otp.check` (Contact & risk).
+    class Phone < Resource
+      # @return [VeriSec::Resources::PhoneOtp]
+      attr_reader :otp
+
+      # @api private
+      def initialize(transport)
+        super
+        @otp = PhoneOtp.new(transport)
+      end
+
+      # Phone Intelligence: `POST /v1/phone/lookup`.
+      #
+      # Whether a number is valid and live, with its format, country, line type, carrier, SMS pumping risk,
+      # SIM swap and forwarding, and a risk level. With a name, the carrier is also asked whether the number
+      # belongs to that person.
+      #
+      # Price: 0.08 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhoneLookupParams), under the API's names
+      # @option params [String] :phone (required) Phone. With its country code, for example +250788123456.
+      # @option params [String] :first_name First name. With a name, the carrier is asked whether it belongs
+      #   to that person (some countries only).
+      # @option params [String] :last_name Last name.
+      # @option params [String] :date_of_birth Date of birth. YYYY-MM-DD.
+      # @option params [String] :country Country. ISO alpha-2, for example RW.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhoneLookup] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def lookup(request_options: nil, **params)
+        _json(:post, "/v1/phone/lookup", params, Types::PhoneLookup, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.phone.otp`: `phone.otp.send`, `phone.otp.check` (Contact & risk).
+    class PhoneOtp < Resource
+      # Send Phone Code: `POST /v1/phone/otp/send`.
+      #
+      # Sends a one-time code by SMS to prove the person holds the number.
+      #
+      # Price: 0.08 credits per successful call.
+      #
+      # @param params [Hash] the request fields (PhoneOtpSendParams), under the API's names
+      # @option params [String] :phone (required) Phone. A real SMS is sent to this number.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhoneOtpSend] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def send(request_options: nil, **params)
+        _json(:post, "/v1/phone/otp/send", params, Types::PhoneOtpSend, envelope: :data,
+              request_options: request_options)
+      end
+
+      # Check Phone Code: `POST /v1/phone/otp/check`.
+      #
+      # Checks the code the person entered against the one that was sent.
+      #
+      # Free: not charged.
+      #
+      # @param params [Hash] the request fields (PhoneOtpCheckParams), under the API's names
+      # @option params [String] :phone (required) Phone.
+      # @option params [String] :code (required) Code.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::PhoneOtpCheck] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def check(request_options: nil, **params)
+        _json(:post, "/v1/phone/otp/check", params, Types::PhoneOtpCheck, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.screening`: `screening.ip`, `screening.sanctions`, `screening.crypto` (Contact & risk).
+    class Screening < Resource
+      # IP Risk: `POST /v1/screen/ip`.
+      #
+      # Where an IP address is, who runs it, whether it hides the user (VPN, proxy, Tor, data centre), its
+      # abuse reports, and a risk level with reasons.
+      #
+      # Price: 0.06 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ScreeningIpParams), under the API's names
+      # @option params [String] :ip (required) IP address. IPv4 or IPv6.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ScreeningIp] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def ip(request_options: nil, **params)
+        _json(:post, "/v1/screen/ip", params, Types::ScreeningIp, envelope: :data,
+              request_options: request_options)
+      end
+
+      # Sanctions & PEP Screening: `POST /v1/screen/sanctions`.
+      #
+      # Screens a person or company against sanctions, politically exposed person and crime lists. Every
+      # detail you give, name, date of birth, nationality, ID number, is scored together, and each result
+      # explains why it matched.
+      #
+      # Price: 0.8 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ScreeningSanctionsParams), under the API's names
+      # @option params [String] :name (required) Name.
+      # @option params [String] :schema Type. (one of "Person", "Company", "Organization", "LegalEntity";
+      #   default "Person")
+      # @option params [String] :birth_date Date of birth. YYYY, YYYY-MM or YYYY-MM-DD. People only.
+      # @option params [Array<String>] :countries Countries. Up to 5 ISO alpha-2 codes (nationality for a
+      #   person, country for a company).
+      # @option params [Array<String>] :id_numbers ID numbers. Up to 5: passport, national ID, tax or
+      #   registration numbers.
+      # @option params [Integer] :limit Results. (default 10; 1 to 50)
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ScreeningSanctions] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def sanctions(request_options: nil, **params)
+        _json(:post, "/v1/screen/sanctions", params, Types::ScreeningSanctions, envelope: :data,
+              request_options: request_options)
+      end
+
+      # Wallet Screening: `POST /v1/screen/crypto`.
+      #
+      # A verdict and a risk level for up to 100 wallet addresses, on any supported network, from sanctions
+      # and illicit-activity data.
+      #
+      # Price: 0.1 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ScreeningCryptoParams), under the API's names
+      # @option params [Array<String>] :addresses (required) Wallet addresses. One per line, up to 100.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ScreeningCrypto] the answer's `data`; `last_response` has the status,
+      #   headers, request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def crypto(request_options: nil, **params)
+        _json(:post, "/v1/screen/crypto", params, Types::ScreeningCrypto, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.ip`: `ip.analyze` (Contact & risk).
+    class Ip < Resource
+      # IP Anonymity: `POST /v1/ip/analyze`.
+      #
+      # The fast answer from the platform's own lists only: Tor, VPN, data centre, cloud, private relay,
+      # blocklist and the network owner. No outside call, so it is quick.
+      #
+      # Price: 0.06 credits per successful call.
+      #
+      # @param params [Hash] the request fields (IpAnalyzeParams), under the API's names
+      # @option params [String] :ip (required) IP address. IPv4 or IPv6.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::IpAnalyze] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def analyze(request_options: nil, **params)
+        _json(:post, "/v1/ip/analyze", params, Types::IpAnalyze, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.contact`: `contact.dossier` (Contact & risk).
+    class Contact < Resource
+      # Contact Dossier: `POST /v1/verify/contact`.
+      #
+      # Everything in one call: email, phone, IP, sanctions screening and wallet, each part in exactly the
+      # same shape as its own API. The slower checks (accounts, username, adverse media) are opt-in.
+      #
+      # Price: 1.39 credits per successful call.
+      #
+      # @param params [Hash] the request fields (ContactDossierParams), under the API's names
+      # @option params [String] :email Email.
+      # @option params [String] :phone Phone. With its country code.
+      # @option params [String] :name Name.
+      # @option params [String] :dob Date of birth. YYYY-MM-DD.
+      # @option params [String] :country Country. ISO alpha-2.
+      # @option params [String] :ip IP address.
+      # @option params [String] :wallet Wallet address.
+      # @option params [Array<String>] :include Slower checks. Each adds up to a few minutes. (default [])
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ContactDossier] the answer's `data`; `last_response` has the status, headers,
+      #   request id, warnings and latency
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def dossier(request_options: nil, **params)
+        _json(:post, "/v1/verify/contact", params, Types::ContactDossier, envelope: :data,
+              request_options: request_options)
+      end
+    end
+
+    # `client.cheques`: `cheques.read`, `cheques.micr`, `cheques.micrLine`, `cheques.amount`, `cheques.date`,
+    # `cheques.parties`, `cheques.bank` (Cheques).
+    class Cheques < Resource
+      # Read a whole cheque: `POST /v2/cheques/read`.
+      #
+      # Reads everything on a cheque in one call: the MICR line with its named fields, what is written on the
+      # face (payee, amount in figures and words, date, drawer, bank, crossing, signature), the bank matched
+      # in the directory, and the country and currency. A photo with several cheques returns each in
+      # `cheques`. The read and the photo are kept in the scan history.
+      #
+      # Price: 0.05 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeReadParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @option params [String] :format The MICR font. `auto` finds it. (one of "auto", "e13b", "cmc7";
+      #   default "auto")
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeDeepRead] the answer; `last_response` has the status, headers, request
+      #   id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def read(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/read", params, Types::ChequeDeepRead, operation: "cheques.read",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a cheque's MICR line: `POST /v2/cheques/micr`.
+      #
+      # Finds and reads every MICR code line on a cheque (E-13B or CMC-7) and names its fields: the layout
+      # template for the layout, a national standard when one applies (Canada, India), and the US
+      # routing-number proof. The read and the photo are kept in the scan history.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeMicrParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @option params [String] :format The MICR font. `auto` finds it. (one of "auto", "e13b", "cmc7";
+      #   default "auto")
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeResponse] the answer; `last_response` has the status, headers, request
+      #   id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def micr(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/micr", params, Types::ChequeResponse, operation: "cheques.micr",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read just the MICR line: `POST /v2/cheques/micr-line`.
+      #
+      # Reads the strongest MICR line with the same engine and naming as the full reads and returns a small
+      # response: the line, its named fields, its layout and confidence. Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeMicrLineParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @option params [String] :format The MICR font. `auto` finds it. (one of "auto", "e13b", "cmc7";
+      #   default "auto")
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::MicrLine] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def micr_line(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/micr-line", params, Types::MicrLine, operation: "cheques.micrLine",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a cheque's amount: `POST /v2/cheques/amount`.
+      #
+      # Reads the amount in figures and in words, turns it into a number, says whether the two agree, and
+      # resolves the currency. Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeAmountParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeAmount] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def amount(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/amount", params, Types::ChequeAmount, operation: "cheques.amount",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a cheque's date: `POST /v2/cheques/date`.
+      #
+      # Reads the cheque's date as written and as YYYY-MM-DD, with its age in days (negative when post-dated).
+      # Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeDateParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeDate] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def date(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/date", params, Types::ChequeDate, operation: "cheques.date",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a cheque's payee and drawer: `POST /v2/cheques/parties`.
+      #
+      # Reads who the cheque is paid to (the name after Pay) and whose account pays it (the account holder
+      # printed on the cheque). Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequePartiesParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeParties] the answer; `last_response` has the status, headers, request
+      #   id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def parties(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/parties", params, Types::ChequeParties, operation: "cheques.parties",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a cheque's bank: `POST /v2/cheques/bank`.
+      #
+      # Reads the bank printed on the cheque and matches it in the directory of about 75,000 banks. A bank not
+      # in the directory is never forced onto another: `bank` is left out. Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (ChequeBankParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The cheque photo: JPG, PNG
+      #   or BMP, up to 10 MB. Read exactly as uploaded, never resized.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::ChequeBank] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def bank(request_options: nil, **params)
+        _upload(:post, "/v2/cheques/bank", params, Types::ChequeBank, operation: "cheques.bank",
+                envelope: :object, request_options: request_options)
+      end
+    end
+
+    # `client.banks`: `banks.lookup` (Banks).
+    class Banks < Resource
+      # Look up a bank: `GET /v2/banks`.
+      #
+      # Finds a bank in the directory by BIC, or by name (best with the country). Trust `bank` when `verified`
+      # is true; otherwise look at `alternatives`. Send `name` or `bic`; neither answers `400 missing_query`.
+      #
+      # Price: 0.002 credits per successful call.
+      #
+      # @param params [Hash] the query parameters (BankLookupParams)
+      # @option params [String] :name The bank's name, as you have it.
+      # @option params [String] :country ISO 3166-1 alpha-2. Narrows a name search.
+      # @option params [String] :bic BIC / SWIFT code, 8 or 11 characters. When given, the name is not needed.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::BankLookup] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def lookup(request_options: nil, **params)
+        _call(:get, "/v2/banks", Types::BankLookup, query: params, envelope: :object,
+              request_options: request_options)
+      end
+    end
+
+    # `client.cards`: `cards.read`, `cards.number`, `cards.expiry`, `cards.check`, `cards.fingerprint`
+    # (Cards).
+    class Cards < Resource
+      # Read a payment card: `POST /v2/cards/read`.
+      #
+      # Reads every card in a photo: number, expiry and holder with their confidences, the checks (Luhn,
+      # length for the network, expiry), the BIN record and the issuer in the bank directory. The full number
+      # is in this response only; the stored copy keeps the first six and last four digits, and the photo is
+      # never stored.
+      #
+      # Price: 0.03 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (CardReadParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The card photo: JPG, PNG
+      #   or BMP, up to 10 MB. The photo is never stored.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::CardResponse] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def read(request_options: nil, **params)
+        _upload(:post, "/v2/cards/read", params, Types::CardResponse, operation: "cards.read",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a card number: `POST /v2/cards/number`.
+      #
+      # Reads the card number from a photo, with its network and checks. Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (CardNumberParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The card photo: JPG, PNG
+      #   or BMP, up to 10 MB. The photo is never stored.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::CardNumber] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def number(request_options: nil, **params)
+        _upload(:post, "/v2/cards/number", params, Types::CardNumber, operation: "cards.number",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Read a card's expiry date: `POST /v2/cards/expiry`.
+      #
+      # Reads the expiry date from a card photo and works out whether the card has expired and how many days
+      # it has left. Nothing is stored.
+      #
+      # Price: 0.02 credits per successful call.
+      #
+      # Sends the image as multipart/form-data with `X-VeriSec-Source: sdk` (the console files the scan under
+      # "SDK").
+      #
+      # @param params [Hash] the form fields (CardExpiryParams), under the API's names
+      # @option params [String, Pathname, IO, VeriSec::FileInput] :image (required) The card photo: JPG, PNG
+      #   or BMP, up to 10 MB. The photo is never stored.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::CardExpiry] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def expiry(request_options: nil, **params)
+        _upload(:post, "/v2/cards/expiry", params, Types::CardExpiry, operation: "cards.expiry",
+                envelope: :object, request_options: request_options)
+      end
+
+      # Check a card number: `POST /v2/cards/check`.
+      #
+      # Checks a typed card number, for example from a checkout form: the Luhn checksum, a length that fits
+      # the network, the expiry when sent, and the BIN record. Accept the card when `scheme_valid` is true and
+      # `expired` is not. Only the first six and last four digits come back; nothing is stored.
+      #
+      # Price: 0.002 credits per successful call.
+      #
+      # @param params [Hash] the request fields (CardCheckParams), under the API's names
+      # @option params [String] :number (required) 12 to 19 digits; spaces are ignored. Never stored.
+      # @option params [String] :expiry MM/YY.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::CardCheck] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def check(request_options: nil, **params)
+        _json(:post, "/v2/cards/check", params, Types::CardCheck, envelope: :object,
+              request_options: request_options)
+      end
+
+      # Fingerprint a card number: `POST /v2/cards/fingerprint`.
+      #
+      # Turns a card number into a fingerprint: always the same for the same card, and impossible to turn back
+      # into the number. Store it to recognise a card you have seen before; a card read from a photo carries
+      # the same fingerprint.
+      #
+      # Price: 0.002 credits per successful call.
+      #
+      # @param params [Hash] the request fields (CardFingerprintParams), under the API's names
+      # @option params [String] :number (required) 12 to 19 digits; spaces are ignored. Never stored.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::CardFingerprint] the answer; `last_response` has the status, headers, request
+      #   id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def fingerprint(request_options: nil, **params)
+        _json(:post, "/v2/cards/fingerprint", params, Types::CardFingerprint, envelope: :object,
+              request_options: request_options)
+      end
+    end
+
+    # `client.bin`: `bin.lookup` (BIN).
+    class Bin < Resource
+      # Look up a BIN: `GET /v2/bin/{digits}`.
+      #
+      # Looks up the first 6 to 8 digits of a card: network, type, level, funding, issuer, country with its
+      # flag, currency, and the issuer's record in the bank directory. Fewer than 6 digits answer `400
+      # bin_too_short`; a BIN not in the tables `404 bin_not_found`.
+      #
+      # Price: 0.002 credits per successful call.
+      #
+      # @param digits [String] The first 6 to 8 digits of the card number.
+      # @param request_options [Hash, nil] `timeout:`, `max_retries:`, `headers:` for this call
+      # @return [VeriSec::Types::BinRecord] the answer; `last_response` has the status, headers, request id
+      # @raise [VeriSec::APIError] when the API refuses the call (see the subclasses)
+      # @raise [VeriSec::APIConnectionError] when no answer came back
+      def lookup(digits, request_options: nil)
+        _call(:get, "/v2/bin/#{_segment(digits, "digits")}", Types::BinRecord, envelope: :object,
+              request_options: request_options)
+      end
+    end
+  end
+end