Catalog/text-phonetic-match

Text

Phonetic match check API

Decides whether two strings sound alike, returning the chosen-algorithm verdict plus a cross-check across Soundex, Metaphone, NYSIIS and Caverphone with an agreement count. Answers 'do these two names sound the same?', 'how many phonetic algorithms agree?'.

Price$0.03per request
MethodPOST
Route/v1/text/phonetic-match
StatusLive
MIME typeapplication/json
Rate limit120/minute
Cache0s public
textphoneticmatchsounds-likesoundexmetaphonename-matchingfuzzy
API URLhttps://x402.hexl.dev/v1/text/phonetic-match
Integration docs
Example request
{
  "a": "Smith",
  "b": "Smyth"
}
Example response
{
  "match": true,
  "algorithm": "metaphone",
  "codeA": "SM0",
  "codeB": "SM0",
  "allAlgorithms": {
    "soundex": true,
    "metaphone": true,
    "nysiis": false,
    "caverphone": true
  },
  "agreement": "3/4 algorithms agree they sound alike"
}
Input schema
{
  "type": "object",
  "required": [
    "a",
    "b"
  ],
  "properties": {
    "a": {
      "type": "string",
      "examples": [
        "Smith"
      ]
    },
    "b": {
      "type": "string",
      "examples": [
        "Smyth"
      ]
    },
    "algorithm": {
      "type": "string",
      "enum": [
        "soundex",
        "metaphone",
        "nysiis",
        "caverphone"
      ],
      "examples": [
        "metaphone"
      ]
    }
  }
}
Output schema
{
  "type": "object",
  "additionalProperties": true
}