namegender 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4643c981f5be9a9a9e2e4ebd41d812b466c1e740918d01374daf75c9d1e60ae
-  data.tar.gz: b46fa7433ebbae2738c127a4b1446d13d1fa14f98ec3369ad3c6ac7184d1b316
+  metadata.gz: 658d4fb7a91170b0e2b2c61f23f172b259192bca6308113674e874057aa0adc1
+  data.tar.gz: a1272df8391d88b717b26494bf79bc16bbbc4c51a3db6bec6016177d8572828c
 SHA512:
-  metadata.gz: 2fcce41ef6af0dab6bb88560310d56d8573d8f2267b95a3b9c669818f679f7b63a1b0f27dd9d77ec329d651b3f14a879d7eaae30f7a58cd5283165f15328e54b
-  data.tar.gz: 8a072d1a84da3868b1d170f98b8c90e7210716f91737fb9f3fb30515e50b166706c3d5801edf94e5a63010273beef31143fbe2c3e3da679a5065d35672ba2f3a
+  metadata.gz: c83e850168ffcdfdd3ad530f59df0cb3db34dbf6a7159e6bc9bdd230156bbb2343192b79701d42a1f2420c0bff379b9cf7c84cba7436a5bec2ffc532c1c14876
+  data.tar.gz: bb93bcc96d6651dd39e0bfe25a0c4464db382e5c310f3879160f8c747a468840b2e8cd8f7b60da17ea0e93d411e02f70da2b2be72a7160111595eba614ecfe2d

data/README.md

@@ -84,6 +84,35 @@ does not apply here. If you already know the gender, pass
 names and returns `results` in input order. An unsupported language raises
 `NameGender::Error` with status 422 and `body["supported"]`.
 
+## Name check
+
+Whether a name typed into a form looks like a real person's name, with the
+reasons. It never calls a name fake: use it to flag records for a closer look,
+not to reject people automatically.
+
+```ruby
+result = client.name_check("asdf qwerty")
+puts result["assessment"]   # implausible
+puts result["score"]        # 0 (0-100)
+result["signals"].each { |s| puts "#{s["code"]} #{s["severity"]} #{s["part"]}" }   # keyboard_pattern high first_name, ...
+
+client.name_check("Jennifer Null")["assessment"]   # plausible
+
+# Names stored in separate fields are used as they are, not parsed:
+client.name_check(first_name: "Jennifer", last_name: "Null", country: "US")
+
+result = client.name_check_bulk(["Jennifer Null", "asdf qwerty"])
+puts result["summary"]   # total, plausible, suspicious, implausible
+```
+
+One credit per name. `assessment` is `"plausible"`, `"suspicious"` or
+`"implausible"`; each signal has `code`, `severity` (`high`, `medium`, `low`,
+`info`, `positive`), `part` and `value` (either can be `nil`). `evidence`
+says whether the first name is counted, attested or not found. Surnames are
+judged by their shape only. It takes `country:`, `locale:` and `ip:`, not
+`best_guess` or `ai_fallback`. `name_check_bulk` takes up to 100 names and
+returns `results` in input order.
+
 ## File jobs
 
 Upload a CSV or XLSX file (up to 100 MB and 1,000,000 rows) and get it back

data/lib/namegender.rb

@@ -80,6 +80,27 @@ module NameGender
         min_probability: min_probability, title: title
       }.compact)
     end
+    # Whether a name typed into a form looks like a real person's name, with
+    # reasons. It never calls a name fake: use it to flag records for a look,
+    # not to reject people automatically. "assessment" is "plausible",
+    # "suspicious" or "implausible", "score" is 0-100, and "signals" lists
+    # why ({"code", "severity", "part", "value"}; "part" and "value" can be
+    # nil). Surnames are judged by their shape only. `value` is the full name;
+    # pass `first_name:` and `last_name:` instead when they are stored
+    # separately (they are not parsed). `country`, `locale` and `ip` work as
+    # in #name. One credit per name. `best_guess`, `ai_fallback` and
+    # `language` do not apply here and are not accepted.
+    def name_check(value = nil, first_name: nil, last_name: nil, country: nil, locale: nil, ip: nil)
+      post("/name-check", {
+        name: value, first_name: first_name, last_name: last_name, country: country, locale: locale, ip: ip
+      }.compact)
+    end
+    # Up to 100 names; every option applies to all of them. "results" keeps
+    # the input order, "summary" counts the plausible, suspicious and
+    # implausible names.
+    def name_check_bulk(values, country: nil, locale: nil, ip: nil)
+      post("/name-check/bulk", { names: Array(values), country: country, locale: locale, ip: ip }.compact)
+    end
     def account
       request(Net::HTTP::Get, "/me")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namegender
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - NameGender
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2026-10-06 00:00:00.000000000 Z
 dependencies: []
 description: A dependency-free Ruby client for name, email, username, bulk, country
-  distribution and salutation lookups through NameGender.
+  distribution, salutation and name check lookups through NameGender.
 email:
 - support@namegender.com
 executables: []