PersonalApi

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

Method	HTTP request	Description
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)
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)
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)
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)
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)
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)
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)
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)
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.
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.
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.
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.
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.)
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.)
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.)
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.)
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.
gender1	GET /api2/json/gender/{firstName}/{lastName}	Infer the likely gender of a name.
genderBatch	POST /api2/json/genderBatch	Infer the likely gender of up to 100 names, detecting automatically the cultural context.
genderFull	GET /api2/json/genderFull/{fullName}	Infer the likely gender of a full name, ex. John H. Smith
genderFullBatch	POST /api2/json/genderFullBatch	Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
genderFullGeo	GET /api2/json/genderFullGeo/{fullName}/{countryIso2}	Infer the likely gender of a full name, given a local context (ISO2 country code).
genderFullGeoBatch	POST /api2/json/genderFullGeoBatch	Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
genderGeo	GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2}	Infer the likely gender of a name, given a local context (ISO2 country code).
genderGeoBatch	POST /api2/json/genderGeoBatch	Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
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.
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.
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.
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.
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.
parseNameBatch	POST /api2/json/parseNameBatch	Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
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.
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.
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).
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.
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).
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.
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').
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').
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').
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').
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).
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).
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).
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).
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).
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).

communityEngage

CommunityEngageOut 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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    CommunityEngageOut result = apiInstance.communityEngage(countryIso2, firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#communityEngage");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
firstName	String
lastName	String

Return type

CommunityEngageOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

communityEngageBatch

BatchCommunityEngageOut communityEngageBatch(batchFirstLastNameGeoIn)

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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of personal names
try {
    BatchCommunityEngageOut result = apiInstance.communityEngageBatch(batchFirstLastNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#communityEngageBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoIn	BatchFirstLastNameGeoIn	A list of personal names	[optional]

Return type

BatchCommunityEngageOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

communityEngageFull

CommunityEngageOut 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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String personalNameFull = "personalNameFull_example"; // String | 
try {
    CommunityEngageOut result = apiInstance.communityEngageFull(countryIso2, personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#communityEngageFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
personalNameFull	String

Return type

CommunityEngageOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

communityEngageFullBatch

BatchCommunityEngageFullOut communityEngageFullBatch(batchPersonalNameGeoIn)

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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names
try {
    BatchCommunityEngageFullOut result = apiInstance.communityEngageFullBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#communityEngageFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names	[optional]

Return type

BatchCommunityEngageFullOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

corridor

CorridorOut 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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2From = "countryIso2From_example"; // String | 
String firstNameFrom = "firstNameFrom_example"; // String | 
String lastNameFrom = "lastNameFrom_example"; // String | 
String countryIso2To = "countryIso2To_example"; // String | 
String firstNameTo = "firstNameTo_example"; // String | 
String lastNameTo = "lastNameTo_example"; // String | 
try {
    CorridorOut result = apiInstance.corridor(countryIso2From, firstNameFrom, lastNameFrom, countryIso2To, firstNameTo, lastNameTo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#corridor");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2From	String
firstNameFrom	String
lastNameFrom	String
countryIso2To	String
firstNameTo	String
lastNameTo	String

Return type

CorridorOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

corridorBatch

BatchCorridorOut corridorBatch(batchCorridorIn)

[USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchCorridorIn batchCorridorIn = new BatchCorridorIn(); // BatchCorridorIn | A list of name pairs, with country code (nameFrom -> nameTo).
try {
    BatchCorridorOut result = apiInstance.corridorBatch(batchCorridorIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#corridorBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchCorridorIn	BatchCorridorIn	A list of name pairs, with country code (nameFrom -> nameTo).	[optional]

Return type

BatchCorridorOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

corridorFull

CorridorFullOut 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)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2From = "countryIso2From_example"; // String | 
String personalNameFrom = "personalNameFrom_example"; // String | 
String countryIso2To = "countryIso2To_example"; // String | 
String personalNameTo = "personalNameTo_example"; // String | 
try {
    CorridorFullOut result = apiInstance.corridorFull(countryIso2From, personalNameFrom, countryIso2To, personalNameTo);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#corridorFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2From	String
personalNameFrom	String
countryIso2To	String
personalNameTo	String

Return type

CorridorFullOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

corridorFullBatch

BatchCorridorFullOut corridorFullBatch(batchCorridorFullIn)

[USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchCorridorFullIn batchCorridorFullIn = new BatchCorridorFullIn(); // BatchCorridorFullIn | A list of name pairs, with country code (nameFrom -> nameTo).
try {
    BatchCorridorFullOut result = apiInstance.corridorFullBatch(batchCorridorFullIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#corridorFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchCorridorFullIn	BatchCorridorFullIn	A list of name pairs, with country code (nameFrom -> nameTo).	[optional]

Return type

BatchCorridorFullOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

country

PersonalNameGeoOut 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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String personalNameFull = "personalNameFull_example"; // String | 
try {
    PersonalNameGeoOut result = apiInstance.country(personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#country");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
personalNameFull	String

Return type

PersonalNameGeoOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

countryBatch

BatchPersonalNameGeoOut countryBatch(batchPersonalNameIn)

[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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names
try {
    BatchPersonalNameGeoOut result = apiInstance.countryBatch(batchPersonalNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#countryBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameIn	BatchPersonalNameIn	A list of personal names	[optional]

Return type

BatchPersonalNameGeoOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

countryFnLn

FirstLastNameOriginedOut 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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameOriginedOut result = apiInstance.countryFnLn(firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#countryFnLn");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String

Return type

FirstLastNameOriginedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

countryFnLnBatch

BatchFirstLastNameGeoOut countryFnLnBatch(batchFirstLastNameIn)

[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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal names
try {
    BatchFirstLastNameGeoOut result = apiInstance.countryFnLnBatch(batchFirstLastNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#countryFnLnBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameIn	BatchFirstLastNameIn	A list of personal names	[optional]

Return type

BatchFirstLastNameGeoOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

diaspora

FirstLastNameDiasporaedOut 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.)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameDiasporaedOut result = apiInstance.diaspora(countryIso2, firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#diaspora");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
firstName	String
lastName	String

Return type

FirstLastNameDiasporaedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

diasporaBatch

BatchFirstLastNameDiasporaedOut diasporaBatch(batchFirstLastNameGeoIn)

[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.)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of personal names
try {
    BatchFirstLastNameDiasporaedOut result = apiInstance.diasporaBatch(batchFirstLastNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#diasporaBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoIn	BatchFirstLastNameGeoIn	A list of personal names	[optional]

Return type

BatchFirstLastNameDiasporaedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

diasporaFull

PersonalNameDiasporaedOut 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.)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String personalNameFull = "personalNameFull_example"; // String | 
try {
    PersonalNameDiasporaedOut result = apiInstance.diasporaFull(countryIso2, personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#diasporaFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
personalNameFull	String

Return type

PersonalNameDiasporaedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

diasporaFullBatch

BatchPersonalNameDiasporaedOut diasporaFullBatch(batchPersonalNameGeoIn)

[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.)

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names
try {
    BatchPersonalNameDiasporaedOut result = apiInstance.diasporaFullBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#diasporaFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names	[optional]

Return type

BatchPersonalNameDiasporaedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

gender

FirstLastNameGenderedOut 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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
try {
    FirstLastNameGenderedOut result = apiInstance.gender(firstName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#gender");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String

Return type

FirstLastNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

gender1

FirstLastNameGenderedOut gender1(firstName, lastName)

Infer the likely gender of a name.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameGenderedOut result = apiInstance.gender1(firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#gender1");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String

Return type

FirstLastNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

genderBatch

BatchFirstLastNameGenderedOut genderBatch(batchFirstLastNameIn)

Infer the likely gender of up to 100 names, detecting automatically the cultural context.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal names
try {
    BatchFirstLastNameGenderedOut result = apiInstance.genderBatch(batchFirstLastNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameIn	BatchFirstLastNameIn	A list of personal names	[optional]

Return type

BatchFirstLastNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

genderFull

PersonalNameGenderedOut genderFull(fullName)

Infer the likely gender of a full name, ex. John H. Smith

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String fullName = "fullName_example"; // String | 
try {
    PersonalNameGenderedOut result = apiInstance.genderFull(fullName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
fullName	String

Return type

PersonalNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

genderFullBatch

BatchPersonalNameGenderedOut genderFullBatch(batchPersonalNameIn)

Infer the likely gender of up to 100 full names, detecting automatically the cultural context.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names
try {
    BatchPersonalNameGenderedOut result = apiInstance.genderFullBatch(batchPersonalNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameIn	BatchPersonalNameIn	A list of personal names	[optional]

Return type

BatchPersonalNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

genderFullGeo

PersonalNameGenderedOut genderFullGeo(fullName, countryIso2)

Infer the likely gender of a full name, given a local context (ISO2 country code).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String fullName = "fullName_example"; // String | 
String countryIso2 = "countryIso2_example"; // String | 
try {
    PersonalNameGenderedOut result = apiInstance.genderFullGeo(fullName, countryIso2);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderFullGeo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
fullName	String
countryIso2	String

Return type

PersonalNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

genderFullGeoBatch

BatchPersonalNameGenderedOut genderFullGeoBatch(batchPersonalNameGeoIn)

Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names, with a country ISO2 code
try {
    BatchPersonalNameGenderedOut result = apiInstance.genderFullGeoBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderFullGeoBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names, with a country ISO2 code	[optional]

Return type

BatchPersonalNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

genderGeo

FirstLastNameGenderedOut genderGeo(firstName, lastName, countryIso2)

Infer the likely gender of a name, given a local context (ISO2 country code).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
String countryIso2 = "countryIso2_example"; // String | 
try {
    FirstLastNameGenderedOut result = apiInstance.genderGeo(firstName, lastName, countryIso2);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderGeo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String
countryIso2	String

Return type

FirstLastNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

genderGeoBatch

BatchFirstLastNameGenderedOut genderGeoBatch(batchFirstLastNameGeoIn)

Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of names, with country code.
try {
    BatchFirstLastNameGenderedOut result = apiInstance.genderGeoBatch(batchFirstLastNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#genderGeoBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoIn	BatchFirstLastNameGeoIn	A list of names, with country code.	[optional]

Return type

BatchFirstLastNameGenderedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

origin

FirstLastNameOriginedOut 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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameOriginedOut result = apiInstance.origin(firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#origin");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String

Return type

FirstLastNameOriginedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

originBatch

BatchFirstLastNameOriginedOut originBatch(batchFirstLastNameIn)

[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameIn batchFirstLastNameIn = new BatchFirstLastNameIn(); // BatchFirstLastNameIn | A list of personal names
try {
    BatchFirstLastNameOriginedOut result = apiInstance.originBatch(batchFirstLastNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#originBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameIn	BatchFirstLastNameIn	A list of personal names	[optional]

Return type

BatchFirstLastNameOriginedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

originFull

PersonalNameOriginedOut 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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String personalNameFull = "personalNameFull_example"; // String | 
try {
    PersonalNameOriginedOut result = apiInstance.originFull(personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#originFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
personalNameFull	String

Return type

PersonalNameOriginedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

originFullBatch

BatchPersonalNameOriginedOut originFullBatch(batchPersonalNameIn)

[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names
try {
    BatchPersonalNameOriginedOut result = apiInstance.originFullBatch(batchPersonalNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#originFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameIn	BatchPersonalNameIn	A list of personal names	[optional]

Return type

BatchPersonalNameOriginedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

parseName

PersonalNameParsedOut parseName(nameFull)

Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String nameFull = "nameFull_example"; // String | 
try {
    PersonalNameParsedOut result = apiInstance.parseName(nameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#parseName");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
nameFull	String

Return type

PersonalNameParsedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

parseNameBatch

BatchPersonalNameParsedOut parseNameBatch(batchPersonalNameIn)

Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameIn batchPersonalNameIn = new BatchPersonalNameIn(); // BatchPersonalNameIn | A list of personal names
try {
    BatchPersonalNameParsedOut result = apiInstance.parseNameBatch(batchPersonalNameIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#parseNameBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameIn	BatchPersonalNameIn	A list of personal names	[optional]

Return type

BatchPersonalNameParsedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

parseNameGeo

PersonalNameParsedOut parseNameGeo(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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String nameFull = "nameFull_example"; // String | 
String countryIso2 = "countryIso2_example"; // String | 
try {
    PersonalNameParsedOut result = apiInstance.parseNameGeo(nameFull, countryIso2);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#parseNameGeo");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
nameFull	String
countryIso2	String

Return type

PersonalNameParsedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

parseNameGeoBatch

BatchPersonalNameParsedOut parseNameGeoBatch(batchPersonalNameGeoIn)

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.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names
try {
    BatchPersonalNameParsedOut result = apiInstance.parseNameGeoBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#parseNameGeoBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names	[optional]

Return type

BatchPersonalNameParsedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

religion2

FirstLastNameReligionedOut religion2(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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String subDivisionIso31662 = "subDivisionIso31662_example"; // String | 
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameReligionedOut result = apiInstance.religion2(countryIso2, subDivisionIso31662, firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#religion2");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
subDivisionIso31662	String
firstName	String
lastName	String

Return type

FirstLastNameReligionedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

religionBatch

BatchFirstLastNameReligionedOut religionBatch(batchFirstLastNameGeoSubdivisionIn)

[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoSubdivisionIn batchFirstLastNameGeoSubdivisionIn = new BatchFirstLastNameGeoSubdivisionIn(); // BatchFirstLastNameGeoSubdivisionIn | A list of personal first / last names
try {
    BatchFirstLastNameReligionedOut result = apiInstance.religionBatch(batchFirstLastNameGeoSubdivisionIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#religionBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoSubdivisionIn	BatchFirstLastNameGeoSubdivisionIn	A list of personal first / last names	[optional]

Return type

BatchFirstLastNameReligionedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

religionFull

PersonalNameReligionedOut 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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String subDivisionIso31662 = "subDivisionIso31662_example"; // String | 
String personalNameFull = "personalNameFull_example"; // String | 
try {
    PersonalNameReligionedOut result = apiInstance.religionFull(countryIso2, subDivisionIso31662, personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#religionFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
subDivisionIso31662	String
personalNameFull	String

Return type

PersonalNameReligionedOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

religionFullBatch

BatchPersonalNameReligionedOut religionFullBatch(batchPersonalNameGeoSubdivisionIn)

[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoSubdivisionIn batchPersonalNameGeoSubdivisionIn = new BatchPersonalNameGeoSubdivisionIn(); // BatchPersonalNameGeoSubdivisionIn | A list of personal names
try {
    BatchPersonalNameReligionedOut result = apiInstance.religionFullBatch(batchPersonalNameGeoSubdivisionIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#religionFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoSubdivisionIn	BatchPersonalNameGeoSubdivisionIn	A list of personal names	[optional]

Return type

BatchPersonalNameReligionedOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

subclassification

FirstLastNameGeoSubclassificationOut 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').

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameGeoSubclassificationOut result = apiInstance.subclassification(countryIso2, firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#subclassification");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
firstName	String
lastName	String

Return type

FirstLastNameGeoSubclassificationOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

subclassificationBatch

BatchFirstLastNameGeoSubclassificationOut subclassificationBatch(batchFirstLastNameGeoIn)

[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').

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of personal names
try {
    BatchFirstLastNameGeoSubclassificationOut result = apiInstance.subclassificationBatch(batchFirstLastNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#subclassificationBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoIn	BatchFirstLastNameGeoIn	A list of personal names	[optional]

Return type

BatchFirstLastNameGeoSubclassificationOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

subclassificationFull

FirstLastNameGeoSubclassificationOut 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').

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String countryIso2 = "countryIso2_example"; // String | 
String fullName = "fullName_example"; // String | 
try {
    FirstLastNameGeoSubclassificationOut result = apiInstance.subclassificationFull(countryIso2, fullName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#subclassificationFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
countryIso2	String
fullName	String

Return type

FirstLastNameGeoSubclassificationOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

subclassificationFullBatch

BatchPersonalNameGeoSubclassificationOut subclassificationFullBatch(batchPersonalNameGeoIn)

[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').

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names
try {
    BatchPersonalNameGeoSubclassificationOut result = apiInstance.subclassificationFullBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#subclassificationFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names	[optional]

Return type

BatchPersonalNameGeoSubclassificationOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

usRaceEthnicity

FirstLastNameUSRaceEthnicityOut 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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
try {
    FirstLastNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicity(firstName, lastName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usRaceEthnicity");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String

Return type

FirstLastNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

usRaceEthnicityBatch

BatchFirstLastNameUSRaceEthnicityOut usRaceEthnicityBatch(batchFirstLastNameGeoIn)

[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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoIn batchFirstLastNameGeoIn = new BatchFirstLastNameGeoIn(); // BatchFirstLastNameGeoIn | A list of personal names
try {
    BatchFirstLastNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityBatch(batchFirstLastNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usRaceEthnicityBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoIn	BatchFirstLastNameGeoIn	A list of personal names	[optional]

Return type

BatchFirstLastNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

usRaceEthnicityFull

PersonalNameUSRaceEthnicityOut 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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String personalNameFull = "personalNameFull_example"; // String | 
try {
    PersonalNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityFull(personalNameFull);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usRaceEthnicityFull");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
personalNameFull	String

Return type

PersonalNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

usRaceEthnicityFullBatch

BatchPersonalNameUSRaceEthnicityOut usRaceEthnicityFullBatch(batchPersonalNameGeoIn)

[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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchPersonalNameGeoIn batchPersonalNameGeoIn = new BatchPersonalNameGeoIn(); // BatchPersonalNameGeoIn | A list of personal names
try {
    BatchPersonalNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityFullBatch(batchPersonalNameGeoIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usRaceEthnicityFullBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchPersonalNameGeoIn	BatchPersonalNameGeoIn	A list of personal names	[optional]

Return type

BatchPersonalNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

usRaceEthnicityZIP5

FirstLastNameUSRaceEthnicityOut 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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
String firstName = "firstName_example"; // String | 
String lastName = "lastName_example"; // String | 
String zip5Code = "zip5Code_example"; // String | 
try {
    FirstLastNameUSRaceEthnicityOut result = apiInstance.usRaceEthnicityZIP5(firstName, lastName, zip5Code);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usRaceEthnicityZIP5");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
firstName	String
lastName	String
zip5Code	String

Return type

FirstLastNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

usZipRaceEthnicityBatch

BatchFirstLastNameUSRaceEthnicityOut usZipRaceEthnicityBatch(batchFirstLastNameGeoZippedIn)

[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).

Example

// Import classes:
//import com.namsor.sdk2.invoke.ApiClient;
//import com.namsor.sdk2.invoke.ApiException;
//import com.namsor.sdk2.invoke.Configuration;
//import com.namsor.sdk2.invoke.auth.*;
//import com.namsor.sdk2.api.PersonalApi;

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");

PersonalApi apiInstance = new PersonalApi();
BatchFirstLastNameGeoZippedIn batchFirstLastNameGeoZippedIn = new BatchFirstLastNameGeoZippedIn(); // BatchFirstLastNameGeoZippedIn | A list of personal names
try {
    BatchFirstLastNameUSRaceEthnicityOut result = apiInstance.usZipRaceEthnicityBatch(batchFirstLastNameGeoZippedIn);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonalApi#usZipRaceEthnicityBatch");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
batchFirstLastNameGeoZippedIn	BatchFirstLastNameGeoZippedIn	A list of personal names	[optional]

Return type

BatchFirstLastNameUSRaceEthnicityOut

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

PersonalApi.md

Latest commit

History

PersonalApi.md

File metadata and controls

PersonalApi

communityEngage

Example

Parameters

Return type

Authorization

HTTP request headers

communityEngageBatch

Example

Parameters

Return type

Authorization

HTTP request headers

communityEngageFull

Example

Parameters

Return type

Authorization

HTTP request headers

communityEngageFullBatch

Example

Parameters

Return type

Authorization

HTTP request headers

corridor

Example

Parameters

Return type

Authorization

HTTP request headers

corridorBatch

Example

Parameters

Return type

Authorization

HTTP request headers

corridorFull

Example

Parameters

Return type

Authorization

HTTP request headers

corridorFullBatch

Example

Parameters

Return type

Authorization

HTTP request headers

country

Example

Parameters

Return type

Authorization

HTTP request headers

countryBatch

Example

Parameters

Return type

Authorization

HTTP request headers

countryFnLn

Example

Parameters

Return type

Authorization

HTTP request headers

countryFnLnBatch

Example

Parameters

Return type

Authorization

HTTP request headers

diaspora