Sign in

v1

latestOpenAPI 3.0.1NamSorAPI_Lic_v0.0.72026-07-13115112157.9 KB
personal

[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)

get/api2/json/diaspora/{countryIso2}/{firstName}/{lastName}

Path parameters

countryIso2string required
firstNamestring required
lastNamestring required

Response

A diaspora / ethnicity for given name and geography.

scriptstring
idstring
explanationstring
firstNamestring

The first name (also known as given name)

lastNamestring

The last name (also known as family name, or surname)

scorenumber double

Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available.

ethnicityAltstring

The second best alternative ethnicity

ethnicitystring

The most likely ethnicity

liftedboolean

Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true.

countryIso2string

From input data, the countryIso2 of geographic context (US,CA etc.)

ethnicitiesTopstring[]

List most likely ethnicities (top 10)

probabilityCalibratednumber double

The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating.

probabilityAltCalibratednumber double

The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating.

Example response

{
  "ethnicityAlt": "Japanese",
  "ethnicity": "Chinese"
}