BrandKwikID Documentation
API SuiteName Matching (ML)

Namematch

Score similarity between two name strings. Server-side JSON POST with Bearer auth.

API reference

Try itLoading playground…
Loading…
AuthorizationBearer <token>

JWT Bearer token authentication. Obtain a token from the KwikID dashboard.

In: header

name1string
Default""
name2string
Default""

Response Body

curl -X POST "https://__mock__/namematch" \  -H "Content-Type: application/json" \  -d '{    "name1": "",    "name2": ""  }'
{
  "score": 0
}
{
  "detail": {
    "<location>": {
      "<field_name>": [
        "string"
      ]
    }
  },
  "message": "string"
}
{
  "detail": {},
  "message": "string"
}

Overview

Call POST /namematch with Authorization: Bearer <token> and JSON name1 and name2. On 200 OK, read score (number) and apply your thresholds for match vs manual review.

Key features

  • Handles minor variations in spelling, order, and transliteration that exact string compare rejects.
  • Pairs with verification APIs: Compare user input to issuer-returned names.

Implementation

Step 1: Call from your backend

POST /namematch HTTP/1.1
Host: <machine-learning-api-base-url>
Authorization: Bearer <token>
Content-Type: application/json

{
  "name1": "RAJESH KUMAR",
  "name2": "Rajesh Kumar"
}

Error handling

HTTP statusWhen
400Missing names.
401Invalid token.

Benefits

  • Reduces false rejects on legitimate minor name differences.

Next steps