NameAPI is a web API
to handle people's names
in your software.

News

24.02.2025

Version 10.7.0 Released

Release of Optimaize PII Platform, version 10.7.0.


20.01.2025

2024 Around the World

2024 has been a pivotal year for Optimaize, with notable advancements in our software capabilities,...


16.12.2024

Dictionary Update: Armenian Names

The Armenian language, part of the Indo-European family, stands out and forms its own branch....


18.11.2024

Dictionary Update: Ukrainian Names

A member of the East Slavic family, the Ukrainian language shares deep historical roots with...


04.11.2024

New Python Client Library Released

We have implemented a Python client library, now available on PyPI, providing easy access to...


   

Name Matcher


       
The matcher compares names and name pairs to find out whether the people could possibly be one and the same person.
See also the Swagger specification.
                    
POST
       
application/json (you must set the content-type as http header)
       
We have integrated Swagger directly into our API.
Visit https://api.nameapi.org/rest/swagger-ui/.

   

Input

               
See Context.
   
{
  "context" : {
    "priority" : "REALTIME",
    "properties" : [ ]
},
 "inputPerson1" : {
    "type" : "NaturalInputPerson",
    "personName" : {
      "nameFields" : [ {
        "string" : "John",
        "fieldType" : "GIVENNAME"
      }, {
        "string" : "Doe",
        "fieldType" : "SURNAME"
      } ]
    },
    "gender" : "UNKNOWN"
  },
   "inputPerson2" : {
    "type" : "NaturalInputPerson",
    "personName" : {
      "nameFields" : [ {
        "string" : "Johnny",
        "fieldType" : "GIVENNAME"
      }, {
        "string" : "Doe",
        "fieldType" : "SURNAME"
      } ]
    },
    "gender" : "UNKNOWN"
  }
}
   

   

Output

   
Shows how well the 2 people matched. See PersonMatcherResult.
   
{
  "matchType" : "MATCHING",
  "personMatchComposition" : "FULL",
  "points" : 0.7592745638200183,
  "confidence" : 1.0,
  "personNameMatcherResult" : {
    "matchType" : "MATCHING"
  },
  "genderMatcherResult" : {
    "matchType" : "EQUAL",
    "confidence" : 0.5,
    "warnings" : [ ]
  },
  "ageMatcherResult" : {
    "matchType" : "NOT_APPLICABLE"
  }
}