namsor-sdk2

NamSor API v2

• API version: 2.0.30
  • Build date: 2024-04-11T10:56:47.519625+02:00[Europe/Berlin]

NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!

For more information, please visit http://www.namsor.com/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.namsor</groupId>
  <artifactId>namsor-sdk2</artifactId>
  <version>2.0.30</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.namsor:namsor-sdk2:2.0.30"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/namsor-sdk2-2.0.30.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.namsor.sdk2.invoke.*;
import com.namsor.sdk2.invoke.auth.*;
import com.namsor.sdk2.model.*;
import com.namsor.sdk2.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String source = "source_example"; // String | 
        Boolean anonymized = true; // Boolean | 
        try {
            apiInstance.anonymize(source, anonymized);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#anonymize");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Class	Method	HTTP request	Description
AdminApi	anonymize	GET /api2/json/anonymize/{source}/{anonymized}	Activate/deactivate anonymization for a source.
AdminApi	anonymize1	GET /api2/json/anonymize/{source}/{anonymized}/{token}	Activate/deactivate anonymization for a source.
AdminApi	apiKeyInfo	GET /api2/json/apiKeyInfo	Read API Key info.
AdminApi	apiStatus	GET /api2/json/apiStatus	Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
AdminApi	apiUsage	GET /api2/json/apiUsage	Print current API usage.
AdminApi	apiUsageHistory	GET /api2/json/apiUsageHistory	Print historical API usage.
AdminApi	apiUsageHistoryAggregate	GET /api2/json/apiUsageHistoryAggregate	Print historical API usage (in an aggregated view, by service, by day/hour/min).
AdminApi	availableServices	GET /api2/json/apiServices	List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
AdminApi	disable	GET /api2/json/disable/{source}/{disabled}	Activate/deactivate an API Key.
AdminApi	learnable	GET /api2/json/learnable/{source}/{learnable}/{token}	Activate/deactivate learning from a source.
AdminApi	learnable1	GET /api2/json/learnable/{source}/{learnable}	Activate/deactivate learning from a source.
AdminApi	regions	GET /api2/json/regions	Print basic source statistics.
AdminApi	softwareVersion	GET /api2/json/softwareVersion	Get the current software version
AdminApi	taxonomyClasses	GET /api2/json/taxonomyClasses/{classifierName}	Print the taxonomy classes valid for the given classifier.
ChineseApi	chineseNameCandidates	GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}	Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
ChineseApi	chineseNameCandidatesBatch	POST /api2/json/chineseNameCandidatesBatch	Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
ChineseApi	chineseNameCandidatesGenderBatch	POST /api2/json/chineseNameCandidatesGenderBatch	Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.
ChineseApi	chineseNameGenderCandidates	GET /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}	Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')
ChineseApi	chineseNameMatch	GET /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}	Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming
ChineseApi	chineseNameMatchBatch	POST /api2/json/chineseNameMatchBatch	Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
ChineseApi	genderChineseName	GET /api2/json/genderChineseName/{chineseName}	Infer the likely gender of a Chinese full name ex. 王晓明
ChineseApi	genderChineseNameBatch	POST /api2/json/genderChineseNameBatch	Infer the likely gender of up to 100 full names ex. 王晓明
ChineseApi	genderChineseNamePinyin	GET /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}	Infer the likely gender of a Chinese name in LATIN (Pinyin).
ChineseApi	genderChineseNamePinyinBatch	POST /api2/json/genderChineseNamePinyinBatch	Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).
ChineseApi	parseChineseName	GET /api2/json/parseChineseName/{chineseName}	Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name)
ChineseApi	parseChineseNameBatch	POST /api2/json/parseChineseNameBatch	Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name).
ChineseApi	pinyinChineseName	GET /api2/json/pinyinChineseName/{chineseName}	Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name)
ChineseApi	pinyinChineseNameBatch	POST /api2/json/pinyinChineseNameBatch	Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name).
GeneralApi	nameType	GET /api2/json/nameType/{properNoun}	Infer the likely type of a proper noun (personal name, brand name, place name etc.)
GeneralApi	nameTypeBatch	POST /api2/json/nameTypeBatch	Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
GeneralApi	nameTypeGeo	GET /api2/json/nameTypeGeo/{properNoun}/{countryIso2}	Infer the likely type of a proper noun (personal name, brand name, place name etc.)
GeneralApi	nameTypeGeoBatch	POST /api2/json/nameTypeGeoBatch	Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
IndianApi	casteIndianBatch	POST /api2/json/casteIndianBatch	[USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names.
IndianApi	castegroupIndian	GET /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name.
IndianApi	castegroupIndianBatch	POST /api2/json/castegroupIndianBatch	[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names.
IndianApi	castegroupIndianFull	GET /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull}	[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.
IndianApi	castegroupIndianFullBatch	POST /api2/json/castegroupIndianFullBatch	[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.
IndianApi	castegroupIndianHindu	GET /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name.
IndianApi	religion	GET /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull}	[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian full name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
IndianApi	religion1	GET /api2/json/religionIndian/{subDivisionIso31662}/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian first/last name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
IndianApi	religionIndianBatch	POST /api2/json/religionIndianBatch	[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
IndianApi	religionIndianFullBatch	POST /api2/json/religionIndianFullBatch	[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
IndianApi	subclassificationIndian	GET /api2/json/subclassificationIndian/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
IndianApi	subclassificationIndianBatch	POST /api2/json/subclassificationIndianBatch	[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
IndianApi	subclassificationIndianFull	GET /api2/json/subclassificationIndianFull/{fullName}	[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
IndianApi	subclassificationIndianFullBatch	POST /api2/json/subclassificationIndianFullBatch	[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
JapaneseApi	genderJapaneseNameFull	GET /api2/json/genderJapaneseNameFull/{japaneseName}	Infer the likely gender of a Japanese full name ex. 王晓明
JapaneseApi	genderJapaneseNameFullBatch	POST /api2/json/genderJapaneseNameFullBatch	Infer the likely gender of up to 100 full names
JapaneseApi	genderJapaneseNamePinyin	GET /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}	Infer the likely gender of a Japanese name in LATIN (Pinyin).
JapaneseApi	genderJapaneseNamePinyinBatch	POST /api2/json/genderJapaneseNameBatch	Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).
JapaneseApi	japaneseNameGenderKanjiCandidatesBatch	POST /api2/json/japaneseNameGenderKanjiCandidatesBatch	Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
JapaneseApi	japaneseNameKanjiCandidates	GET /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}	Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
JapaneseApi	japaneseNameKanjiCandidates1	GET /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}	Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
JapaneseApi	japaneseNameKanjiCandidatesBatch	POST /api2/json/japaneseNameKanjiCandidatesBatch	Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae
JapaneseApi	japaneseNameLatinCandidates	GET /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}	Romanize japanese name, based on the name in Kanji.
JapaneseApi	japaneseNameLatinCandidatesBatch	POST /api2/json/japaneseNameLatinCandidatesBatch	Romanize japanese names, based on the name in KANJI
JapaneseApi	japaneseNameMatch	GET /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}	Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae
JapaneseApi	japaneseNameMatchBatch	POST /api2/json/japaneseNameMatchBatch	Return a score for matching a list of Japanese names in KANJI ex. 山本 早苗 with romanized names ex. Yamamoto Sanae
JapaneseApi	japaneseNameMatchFeedbackLoop	GET /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}	[CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae
JapaneseApi	parseJapaneseName	GET /api2/json/parseJapaneseName/{japaneseName}	Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae
JapaneseApi	parseJapaneseNameBatch	POST /api2/json/parseJapaneseNameBatch	Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae
PersonalApi	communityEngage	GET /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}	[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
PersonalApi	communityEngageBatch	POST /api2/json/communityEngageBatch	Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
PersonalApi	communityEngageFull	GET /api2/json/communityEngageFull/{countryIso2}/{personalNameFull}	[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
PersonalApi	communityEngageFullBatch	POST /api2/json/communityEngageFullBatch	Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
PersonalApi	corridor	GET /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}	[USES 50 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)
PersonalApi	corridorBatch	POST /api2/json/corridorBatch	[USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)
PersonalApi	corridorFull	GET /api2/json/corridorFull/{countryIso2From}/{personalNameFrom}/{countryIso2To}/{personalNameTo}	[USES 50 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)
PersonalApi	corridorFullBatch	POST /api2/json/corridorFullBatch	[USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)
PersonalApi	country	GET /api2/json/country/{personalNameFull}	[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
PersonalApi	countryBatch	POST /api2/json/countryBatch	[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
PersonalApi	countryFnLn	GET /api2/json/countryFnLn/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
PersonalApi	countryFnLnBatch	POST /api2/json/countryFnLnBatch	[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
PersonalApi	diaspora	GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}	[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.)
PersonalApi	diasporaBatch	POST /api2/json/diasporaBatch	[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
PersonalApi	diasporaFull	GET /api2/json/diasporaFull/{countryIso2}/{personalNameFull}	[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.)
PersonalApi	diasporaFullBatch	POST /api2/json/diasporaFullBatch	[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
PersonalApi	gender	GET /api2/json/gender/{firstName}	Infer the likely gender of a just a fiven name, assuming default 'US' local context. Please use preferably full names and local geographic context for better accuracy.
PersonalApi	gender1	GET /api2/json/gender/{firstName}/{lastName}	Infer the likely gender of a name.
PersonalApi	genderBatch	POST /api2/json/genderBatch	Infer the likely gender of up to 100 names, detecting automatically the cultural context.
PersonalApi	genderFull	GET /api2/json/genderFull/{fullName}	Infer the likely gender of a full name, ex. John H. Smith
PersonalApi	genderFullBatch	POST /api2/json/genderFullBatch	Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
PersonalApi	genderFullGeo	GET /api2/json/genderFullGeo/{fullName}/{countryIso2}	Infer the likely gender of a full name, given a local context (ISO2 country code).
PersonalApi	genderFullGeoBatch	POST /api2/json/genderFullGeoBatch	Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
PersonalApi	genderGeo	GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2}	Infer the likely gender of a name, given a local context (ISO2 country code).
PersonalApi	genderGeoBatch	POST /api2/json/genderGeoBatch	Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
PersonalApi	origin	GET /api2/json/origin/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
PersonalApi	originBatch	POST /api2/json/originBatch	[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
PersonalApi	originFull	GET /api2/json/originFull/{personalNameFull}	[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
PersonalApi	originFullBatch	POST /api2/json/originFullBatch	[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
PersonalApi	parseName	GET /api2/json/parseName/{nameFull}	Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
PersonalApi	parseNameBatch	POST /api2/json/parseNameBatch	Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
PersonalApi	parseNameGeo	GET /api2/json/parseName/{nameFull}/{countryIso2}	Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
PersonalApi	parseNameGeoBatch	POST /api2/json/parseNameGeoBatch	Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
PersonalApi	religion2	GET /api2/json/religion/{countryIso2}/{subDivisionIso31662}/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely religion of a personal first/last name. NB: only for INDIA (as of current version).
PersonalApi	religionBatch	POST /api2/json/religionBatch	[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.
PersonalApi	religionFull	GET /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull}	[USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).
PersonalApi	religionFullBatch	POST /api2/json/religionFullBatch	[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.
PersonalApi	subclassification	GET /api2/json/subclassification/{countryIso2}/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer the likely origin of a name at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
PersonalApi	subclassificationBatch	POST /api2/json/subclassificationBatch	[USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
PersonalApi	subclassificationFull	GET /api2/json/subclassificationFull/{countryIso2}/{fullName}	[USES 10 UNITS PER NAME] Infer the likely origin of a name at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
PersonalApi	subclassificationFullBatch	POST /api2/json/subclassificationFullBatch	[USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
PersonalApi	usRaceEthnicity	GET /api2/json/usRaceEthnicity/{firstName}/{lastName}	[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy 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).
PersonalApi	usRaceEthnicityBatch	POST /api2/json/usRaceEthnicityBatch	[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. 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).
PersonalApi	usRaceEthnicityFull	GET /api2/json/usRaceEthnicityFull/{personalNameFull}	[USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy 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).
PersonalApi	usRaceEthnicityFullBatch	POST /api2/json/usRaceEthnicityFullBatch	[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. 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).
PersonalApi	usRaceEthnicityZIP5	GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code}	[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).
PersonalApi	usZipRaceEthnicityBatch	POST /api2/json/usZipRaceEthnicityBatch	[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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).
SocialApi	phoneCode	GET /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}	[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.
SocialApi	phoneCodeBatch	POST /api2/json/phoneCodeBatch	[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.
SocialApi	phoneCodeGeo	GET /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2}	[USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
SocialApi	phoneCodeGeoBatch	POST /api2/json/phoneCodeGeoBatch	[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, with a local context (ISO2 country of residence).
SocialApi	phoneCodeGeoFeedbackLoop	GET /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2}	[CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).

Documentation for Models

• APIBillingPeriodUsageOut
• APIClassifierOut
• APIClassifierTaxonomyOut
• APIClassifiersStatusOut
• APICounterV2Out
• APIKeyOut
• APIPeriodUsageOut
• APIPlanSubscriptionOut
• APIServiceOut
• APIServicesOut
• APIUsageAggregatedOut
• APIUsageHistoryOut
• BatchCommunityEngageFullOut
• BatchCommunityEngageOut
• BatchCorridorFullIn
• BatchCorridorFullOut
• BatchCorridorIn
• BatchCorridorOut
• BatchFirstLastNameCasteOut
• BatchFirstLastNameCastegroupOut
• BatchFirstLastNameDiasporaedOut
• BatchFirstLastNameGenderIn
• BatchFirstLastNameGenderedOut
• BatchFirstLastNameGeoIn
• BatchFirstLastNameGeoOut
• BatchFirstLastNameGeoSubclassificationOut
• BatchFirstLastNameGeoSubdivisionIn
• BatchFirstLastNameGeoZippedIn
• BatchFirstLastNameIn
• BatchFirstLastNameOriginedOut
• BatchFirstLastNamePhoneCodedOut
• BatchFirstLastNamePhoneNumberGeoIn
• BatchFirstLastNamePhoneNumberIn
• BatchFirstLastNameReligionedOut
• BatchFirstLastNameSubdivisionIn
• BatchFirstLastNameUSRaceEthnicityOut
• BatchMatchPersonalFirstLastNameIn
• BatchNameGeoIn
• BatchNameIn
• BatchNameMatchCandidatesOut
• BatchNameMatchedOut
• BatchPersonalNameCastegroupOut
• BatchPersonalNameDiasporaedOut
• BatchPersonalNameGenderedOut
• BatchPersonalNameGeoIn
• BatchPersonalNameGeoOut
• BatchPersonalNameGeoSubclassificationOut
• BatchPersonalNameGeoSubdivisionIn
• BatchPersonalNameIn
• BatchPersonalNameOriginedOut
• BatchPersonalNameParsedOut
• BatchPersonalNameReligionedOut
• BatchPersonalNameSubdivisionIn
• BatchPersonalNameUSRaceEthnicityOut
• BatchProperNounCategorizedOut
• CommunityEngageOptionOut
• CommunityEngageOut
• CorridorFullOut
• CorridorIn
• CorridorOut
• FeedbackLoopOut
• FirstLastNameCasteOut
• FirstLastNameCastegroupOut
• FirstLastNameDiasporaedOut
• FirstLastNameGenderIn
• FirstLastNameGenderedOut
• FirstLastNameGeoIn
• FirstLastNameGeoOut
• FirstLastNameGeoSubclassificationOut
• FirstLastNameGeoSubdivisionIn
• FirstLastNameGeoZippedIn
• FirstLastNameIn
• FirstLastNameOriginedOut
• FirstLastNameOut
• FirstLastNamePhoneCodedOut
• FirstLastNamePhoneNumberGeoIn
• FirstLastNamePhoneNumberIn
• FirstLastNameReligionedOut
• FirstLastNameSubdivisionIn
• FirstLastNameUSRaceEthnicityOut
• MatchPersonalFirstLastNameIn
• NameGeoIn
• NameIn
• NameMatchCandidateOut
• NameMatchCandidatesOut
• NameMatchedOut
• PersonalNameCastegroupOut
• PersonalNameDiasporaedOut
• PersonalNameGenderedOut
• PersonalNameGeoIn
• PersonalNameGeoOut
• PersonalNameGeoSubclassificationOut
• PersonalNameGeoSubdivisionIn
• PersonalNameIn
• PersonalNameOriginedOut
• PersonalNameParsedOut
• PersonalNameReligionedOut
• PersonalNameSubdivisionIn
• PersonalNameUSRaceEthnicityOut
• ProperNounCategorizedOut
• RegionISO
• RegionOut
• ReligionStatOut
• SoftwareVersionOut

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]