NAnamsor
personal

[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).

Changed on
get/api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code}

Request

  • Base URL
    https://v2.namsor.com/NamSorAPIv2
  • Auth
    API key in header X-API-KEY

Path parameters

firstNamestring required
lastNamestring required
zip5Codestring required

Response

a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally

scriptstring
idstring
explanationstring
firstNamestring

The first name (also known as given name)

lastNamestring

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

raceEthnicityAlt'W_NL' | 'HL' | 'A' | 'B_NL' | 'AI_AN' | 'PI'

Second most likely US 'race'/ethnicity

raceEthnicity'W_NL' | 'HL' | 'A' | 'B_NL' | 'AI_AN' | 'PI'

Most likely US 'race'/ethnicity

scorenumber double

Higher score is better, but score is not normalized. Use calibratedProbability if available.

raceEthnicitiesTopstring[]

List 'race'/ethnicities

probabilityCalibratednumber double

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

probabilityAltCalibratednumber double

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

Changes

  • 6297d39b756dRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status