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

News

30.11.2017

Version 5.3 Deployed

New version 5.3 available.


15.11.2017

Version 5.3 release candidate is online

More names, more cultures and a new web service: Risk Detector.


16.03.2017

Version 5.2 Deployed

As announced, the new version has been installed.


02.03.2017

Version 5.2 release candidate is online

More names, more cultures.


01.11.2016

Version 5.1 Deployed

As announced, the new version has been installed.


   

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)
       

   

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"
  }
}