{"files":{"SKILL.md":"---\nname: namsor-api-v2\ndescription: \"NamSor API v2 API skill. Use when working with NamSor API v2 for api2. Covers 115 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# NamSor API v2\nAPI version: 2.1.4\n\n## Auth\nApiKey X-API-KEY in header\n\n## Base URL\nhttps://v2.namsor.com/NamSorAPIv2\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /api2/json/regions -- print basic source statistics.\n3. POST /api2/json/nameTypeBatch -- create first nameTypeBatch\n\n## Endpoints\n115 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Api2\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key. |\n| 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. |\n| 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. |\n| GET | /api2/json/nameType/{properNoun} | Infer the likely type of a proper noun (personal name, brand name, place name etc.) |\n| GET | /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. |\n| GET | /api2/json/regions | Print basic source statistics. |\n| GET | /api2/json/genderstatv3/{enabled} | Activate/deactivate genderstatv3. |\n| GET | /api2/json/softwareVersion | Get the current software version |\n| GET | /api2/json/apiStatus | Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices. |\n| 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. |\n| GET | /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier. |\n| GET | /api2/json/apiUsage | Print current API usage. |\n| GET | /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source. |\n| GET | /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source. |\n| GET | /api2/json/apiKeyInfo | Read API Key info. |\n| GET | /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source. |\n| GET | /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source. |\n| GET | /api2/json/nameTypeGeo/{properNoun}/{countryIso2} | Infer the likely type of a proper noun (personal name, brand name, place name etc.) |\n| POST | /api2/json/nameTypeBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.) |\n| POST | /api2/json/nameTypeGeoBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.) |\n| 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) |\n| 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) |\n| 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. |\n| GET | /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name. |\n| GET | /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code). |\n| POST | /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code). |\n| POST | /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context. |\n| GET | /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code). |\n| GET | /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith |\n| POST | /api2/json/genderFullBatch | Infer the likely gender of up to 100 full names, detecting automatically the cultural context. |\n| POST | /api2/json/genderFullGeoBatch | Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code). |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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. |\n| 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'). |\n| 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'). |\n| 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'). |\n| 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'). |\n| 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. |\n| 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. |\n| 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). |\n| 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). |\n| 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). |\n| 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). |\n| 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. |\n| 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). |\n| 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. |\n| 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). |\n| GET | /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name. |\n| POST | /api2/json/castegroupIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names. |\n| GET | /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name. |\n| POST | /api2/json/castegroupIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names. |\n| GET | /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name. |\n| POST | /api2/json/casteIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names. |\n| 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) |\n| 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) |\n| 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. |\n| 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. |\n| 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. |\n| 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). |\n| 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). |\n| 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). |\n| 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). |\n| 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). |\n| 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). |\n| 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.) |\n| 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.) |\n| 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.) |\n| 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.) |\n| 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) |\n| 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) |\n| 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) |\n| 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) |\n| 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. |\n| POST | /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. |\n| 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. |\n| GET | /api2/json/parseChineseName/{chineseName} | Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name) |\n| POST | /api2/json/parseChineseNameBatch | Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name). |\n| GET | /api2/json/pinyinChineseName/{chineseName} | Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name) |\n| POST | /api2/json/pinyinChineseNameBatch | Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name). |\n| GET | /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName} | Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming |\n| POST | /api2/json/chineseNameMatchBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming |\n| GET | /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin} | Infer the likely gender of a Chinese name in LATIN (Pinyin). |\n| POST | /api2/json/genderChineseNamePinyinBatch | Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin). |\n| GET | /api2/json/genderChineseName/{chineseName} | Infer the likely gender of a Chinese full name ex. 王晓明 |\n| POST | /api2/json/genderChineseNameBatch | Infer the likely gender of up to 100 full names ex. 王晓明 |\n| GET | /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming |\n| POST | /api2/json/chineseNameCandidatesBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming |\n| 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') |\n| POST | /api2/json/chineseNameCandidatesGenderBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming. |\n| GET | /api2/json/parseJapaneseName/{japaneseName} | Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae |\n| POST | /api2/json/parseJapaneseNameBatch | Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae |\n| GET | /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae |\n| 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. |\n| GET | /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji} | Romanize japanese name, based on the name in Kanji. |\n| POST | /api2/json/japaneseNameKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae |\n| 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 |\n| POST | /api2/json/japaneseNameLatinCandidatesBatch | Romanize japanese names, based on the name in KANJI |\n| GET | /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName} | Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae |\n| 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 |\n| POST | /api2/json/japaneseNameMatchBatch | Return a score for matching a list of Japanese names in KANJI ex. 山本 早苗 with romanized names ex. Yamamoto Sanae |\n| GET | /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin). |\n| POST | /api2/json/genderJapaneseNameBatch | Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin). |\n| GET | /api2/json/genderJapaneseNameFull/{japaneseName} | Infer the likely gender of a Japanese full name ex. 王晓明 |\n| POST | /api2/json/genderJapaneseNameFullBatch | Infer the likely gender of up to 100 full names |\n| 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. |\n| 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). |\n| 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). |\n| 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. |\n| 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). |\n| POST | /api2/json/translateFullBatch | Translate up to 100 full names, from one source language to a target language. |\n| POST | /api2/json/searchFullBatch | Search up to 100 full names, in an indexed dataset - using fuzzy name maching. |\n| POST | /api2/json/compareFullBatch | Compare up to 100 full name pairs, using fuzzy name maching. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Get disable details?\" -> GET /api2/json/disable/{source}/{disabled}\n- \"Get country details?\" -> GET /api2/json/country/{personalNameFull}\n- \"Get origin details?\" -> GET /api2/json/origin/{firstName}/{lastName}\n- \"Get nameType details?\" -> GET /api2/json/nameType/{properNoun}\n- \"Get parseName details?\" -> GET /api2/json/parseName/{nameFull}\n- \"List all regions?\" -> GET /api2/json/regions\n- \"Get genderstatv3 details?\" -> GET /api2/json/genderstatv3/{enabled}\n- \"List all softwareVersion?\" -> GET /api2/json/softwareVersion\n- \"List all apiStatus?\" -> GET /api2/json/apiStatus\n- \"List all apiServices?\" -> GET /api2/json/apiServices\n- \"Get taxonomyClasse details?\" -> GET /api2/json/taxonomyClasses/{classifierName}\n- \"List all apiUsage?\" -> GET /api2/json/apiUsage\n- \"Get learnable details?\" -> GET /api2/json/learnable/{source}/{learnable}\n- \"List all apiKeyInfo?\" -> GET /api2/json/apiKeyInfo\n- \"Get anonymize details?\" -> GET /api2/json/anonymize/{source}/{anonymized}/{token}\n- \"Get nameTypeGeo details?\" -> GET /api2/json/nameTypeGeo/{properNoun}/{countryIso2}\n- \"Create a nameTypeBatch?\" -> POST /api2/json/nameTypeBatch\n- \"Create a nameTypeGeoBatch?\" -> POST /api2/json/nameTypeGeoBatch\n- \"Get corridor details?\" -> GET /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}\n- \"Create a corridorBatch?\" -> POST /api2/json/corridorBatch\n- \"Get gender details?\" -> GET /api2/json/gender/{firstName}\n- \"Get genderGeo details?\" -> GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2}\n- \"Create a genderGeoBatch?\" -> POST /api2/json/genderGeoBatch\n- \"Create a genderBatch?\" -> POST /api2/json/genderBatch\n- \"Get genderFullGeo details?\" -> GET /api2/json/genderFullGeo/{fullName}/{countryIso2}\n- \"Get genderFull details?\" -> GET /api2/json/genderFull/{fullName}\n- \"Create a genderFullBatch?\" -> POST /api2/json/genderFullBatch\n- \"Create a genderFullGeoBatch?\" -> POST /api2/json/genderFullGeoBatch\n- \"Create a originBatch?\" -> POST /api2/json/originBatch\n- \"Get originFull details?\" -> GET /api2/json/originFull/{personalNameFull}\n- \"Create a originFullBatch?\" -> POST /api2/json/originFullBatch\n- \"Get subclassificationIndian details?\" -> GET /api2/json/subclassificationIndian/{firstName}/{lastName}\n- \"Get subclassificationIndianFull details?\" -> GET /api2/json/subclassificationIndianFull/{fullName}\n- \"Get subclassification details?\" -> GET /api2/json/subclassification/{countryIso2}/{firstName}/{lastName}\n- \"Get subclassificationFull details?\" -> GET /api2/json/subclassificationFull/{countryIso2}/{fullName}\n- \"Create a subclassificationBatch?\" -> POST /api2/json/subclassificationBatch\n- \"Create a subclassificationFullBatch?\" -> POST /api2/json/subclassificationFullBatch\n- \"Create a subclassificationIndianBatch?\" -> POST /api2/json/subclassificationIndianBatch\n- \"Create a subclassificationIndianFullBatch?\" -> POST /api2/json/subclassificationIndianFullBatch\n- \"Get religionIndian details?\" -> GET /api2/json/religionIndian/{subDivisionIso31662}/{firstName}/{lastName}\n- \"Get religion details?\" -> GET /api2/json/religion/{countryIso2}/{subDivisionIso31662}/{firstName}/{lastName}\n- \"Get religionIndianFull details?\" -> GET /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull}\n- \"Get religionFull details?\" -> GET /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull}\n- \"Create a religionFullBatch?\" -> POST /api2/json/religionFullBatch\n- \"Create a religionIndianFullBatch?\" -> POST /api2/json/religionIndianFullBatch\n- \"Create a religionBatch?\" -> POST /api2/json/religionBatch\n- \"Create a religionIndianBatch?\" -> POST /api2/json/religionIndianBatch\n- \"Get castegroupIndianFull details?\" -> GET /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull}\n- \"Create a castegroupIndianFullBatch?\" -> POST /api2/json/castegroupIndianFullBatch\n- \"Get castegroupIndian details?\" -> GET /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName}\n- \"Create a castegroupIndianBatch?\" -> POST /api2/json/castegroupIndianBatch\n- \"Get casteIndian details?\" -> GET /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName}\n- \"Create a casteIndianBatch?\" -> POST /api2/json/casteIndianBatch\n- \"Get corridorFull details?\" -> GET /api2/json/corridorFull/{countryIso2From}/{personalNameFrom}/{countryIso2To}/{personalNameTo}\n- \"Create a corridorFullBatch?\" -> POST /api2/json/corridorFullBatch\n- \"Create a countryBatch?\" -> POST /api2/json/countryBatch\n- \"Get countryFnLn details?\" -> GET /api2/json/countryFnLn/{firstName}/{lastName}\n- \"Create a countryFnLnBatch?\" -> POST /api2/json/countryFnLnBatch\n- \"Get usRaceEthnicity details?\" -> GET /api2/json/usRaceEthnicity/{firstName}/{lastName}\n- \"Get usRaceEthnicityZIP5 details?\" -> GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code}\n- \"Create a usRaceEthnicityBatch?\" -> POST /api2/json/usRaceEthnicityBatch\n- \"Create a usZipRaceEthnicityBatch?\" -> POST /api2/json/usZipRaceEthnicityBatch\n- \"Get usRaceEthnicityFull details?\" -> GET /api2/json/usRaceEthnicityFull/{personalNameFull}\n- \"Create a usRaceEthnicityFullBatch?\" -> POST /api2/json/usRaceEthnicityFullBatch\n- \"Get diaspora details?\" -> GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}\n- \"Create a diasporaBatch?\" -> POST /api2/json/diasporaBatch\n- \"Get diasporaFull details?\" -> GET /api2/json/diasporaFull/{countryIso2}/{personalNameFull}\n- \"Create a diasporaFullBatch?\" -> POST /api2/json/diasporaFullBatch\n- \"Get communityEngage details?\" -> GET /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}\n- \"Create a communityEngageBatch?\" -> POST /api2/json/communityEngageBatch\n- \"Get communityEngageFull details?\" -> GET /api2/json/communityEngageFull/{countryIso2}/{personalNameFull}\n- \"Create a communityEngageFullBatch?\" -> POST /api2/json/communityEngageFullBatch\n- \"Create a parseNameBatch?\" -> POST /api2/json/parseNameBatch\n- \"Create a parseNameGeoBatch?\" -> POST /api2/json/parseNameGeoBatch\n- \"Get parseChineseName details?\" -> GET /api2/json/parseChineseName/{chineseName}\n- \"Create a parseChineseNameBatch?\" -> POST /api2/json/parseChineseNameBatch\n- \"Get pinyinChineseName details?\" -> GET /api2/json/pinyinChineseName/{chineseName}\n- \"Create a pinyinChineseNameBatch?\" -> POST /api2/json/pinyinChineseNameBatch\n- \"Get chineseNameMatch details?\" -> GET /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}\n- \"Create a chineseNameMatchBatch?\" -> POST /api2/json/chineseNameMatchBatch\n- \"Get genderChineseNamePinyin details?\" -> GET /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}\n- \"Create a genderChineseNamePinyinBatch?\" -> POST /api2/json/genderChineseNamePinyinBatch\n- \"Get genderChineseName details?\" -> GET /api2/json/genderChineseName/{chineseName}\n- \"Create a genderChineseNameBatch?\" -> POST /api2/json/genderChineseNameBatch\n- \"Get chineseNameCandidate details?\" -> GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}\n- \"Create a chineseNameCandidatesBatch?\" -> POST /api2/json/chineseNameCandidatesBatch\n- \"Get chineseNameGenderCandidate details?\" -> GET /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}\n- \"Create a chineseNameCandidatesGenderBatch?\" -> POST /api2/json/chineseNameCandidatesGenderBatch\n- \"Get parseJapaneseName details?\" -> GET /api2/json/parseJapaneseName/{japaneseName}\n- \"Create a parseJapaneseNameBatch?\" -> POST /api2/json/parseJapaneseNameBatch\n- \"Get japaneseNameKanjiCandidate details?\" -> GET /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}\n- \"Get japaneseNameLatinCandidate details?\" -> GET /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}\n- \"Create a japaneseNameKanjiCandidatesBatch?\" -> POST /api2/json/japaneseNameKanjiCandidatesBatch\n- \"Create a japaneseNameGenderKanjiCandidatesBatch?\" -> POST /api2/json/japaneseNameGenderKanjiCandidatesBatch\n- \"Create a japaneseNameLatinCandidatesBatch?\" -> POST /api2/json/japaneseNameLatinCandidatesBatch\n- \"Get japaneseNameMatch details?\" -> GET /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}\n- \"Get japaneseNameMatchFeedbackLoop details?\" -> GET /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}\n- \"Create a japaneseNameMatchBatch?\" -> POST /api2/json/japaneseNameMatchBatch\n- \"Get genderJapaneseName details?\" -> GET /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}\n- \"Create a genderJapaneseNameBatch?\" -> POST /api2/json/genderJapaneseNameBatch\n- \"Get genderJapaneseNameFull details?\" -> GET /api2/json/genderJapaneseNameFull/{japaneseName}\n- \"Create a genderJapaneseNameFullBatch?\" -> POST /api2/json/genderJapaneseNameFullBatch\n- \"Get phoneCode details?\" -> GET /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}\n- \"Get phoneCodeGeo details?\" -> GET /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2}\n- \"Get phoneCodeGeoFeedbackLoop details?\" -> GET /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2}\n- \"Create a phoneCodeBatch?\" -> POST /api2/json/phoneCodeBatch\n- \"Create a phoneCodeGeoBatch?\" -> POST /api2/json/phoneCodeGeoBatch\n- \"Create a translateFullBatch?\" -> POST /api2/json/translateFullBatch\n- \"Create a searchFullBatch?\" -> POST /api2/json/searchFullBatch\n- \"Create a compareFullBatch?\" -> POST /api2/json/compareFullBatch\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api NamSor API v2\n@base https://v2.namsor.com/NamSorAPIv2\n@version 2.1.4\n@auth ApiKey X-API-KEY in header\n@endpoints 115\n@hint download_for_search\n@toc api2(115)\n\n@endpoint GET /api2/json/disable/{source}/{disabled}\n@desc Activate/deactivate an API Key.\n@required {source: str # The API Key to set as enabled/disabled., disabled: bool}\n@returns(200) Disabled the API Key.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/country/{personalNameFull}\n@desc [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.\n@required {personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/origin/{firstName}/{lastName}\n@desc [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.\n@required {firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/nameType/{properNoun}\n@desc Infer the likely type of a proper noun (personal name, brand name, place name etc.)\n@required {properNoun: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, commonType: str, commonTypeAlt: str, score: num(double)} # A typed name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/parseName/{nameFull}\n@desc Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.\n@required {nameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, nameParserType: str, nameParserTypeAlt: str, firstLastName: map{script: str, id: str, explanation: str, firstName: str, lastName: str}, score: num(double)} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/regions\n@desc Print basic source statistics.\n@returns(200) {countriesAndRegions: [map]} # List of countries and regions.\n@errors {401: Missing or incorrect API Key}\n\n@endpoint GET /api2/json/genderstatv3/{enabled}\n@desc Activate/deactivate genderstatv3.\n@required {enabled: bool}\n@returns(200) Enabled/disabled genderstatv3.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/softwareVersion\n@desc Get the current software version\n@returns(200) {softwareNameAndVersion: str, softwareVersion: [int(int32)]} # The current software version\n@errors {401: Missing or incorrect token}\n\n@endpoint GET /api2/json/apiStatus\n@desc Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.\n@returns(200) {softwareVersion: map{softwareNameAndVersion: str, softwareVersion: [int(int32)]}, classifiers: [map]} # Available classifiers and status\n@errors {401: Missing or incorrect token}\n\n@endpoint GET /api2/json/apiServices\n@desc List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.\n@returns(200) {apiServices: [map]} # Available services\n@errors {401: Missing or incorrect token}\n\n@endpoint GET /api2/json/taxonomyClasses/{classifierName}\n@desc Print the taxonomy classes valid for the given classifier.\n@required {classifierName: str}\n@returns(200) {classifierName: str, taxonomyClasses: [str], classifyingScripts: [str]} # Available plans\n@errors {401: Missing or incorrect token}\n\n@endpoint GET /api2/json/apiUsage\n@desc Print current API usage.\n@returns(200) {subscription: map{apiKey: str, planStarted: int(int64), taxRate: num(double), planName: str, planBaseFeesKey: str, planQuota: int(int64), price: num(double), planDiscountInPercent: num(double), priceOverage: num(double), overageDiscountInPercent: num(double), currency: str, currencyFactor: num(double), stripeCustomerId: str, stripeStatus: str, stripeSubscription: str, userId: str}, billingPeriod: map{subscriptionStarted: int(int64), periodStarted: int(int64), periodEnded: int(int64), usage: int(int64), softLimit: int(int64), hardLimit: int(int64)}, overageExclTax: num(double), overageInclTax: num(double), overageCurrency: str, overageQuantity: int(int64)} # Print current API usage.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/learnable/{source}/{learnable}\n@desc Activate/deactivate learning from a source.\n@required {source: str # The API Key to set as learnable/non learnable., learnable: bool}\n@returns(200) Set learning from source.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/learnable/{source}/{learnable}/{token}\n@desc Activate/deactivate learning from a source.\n@required {source: str # The API Key to set as learnable/non learnable., learnable: bool, token: str}\n@returns(200) {apiKey: str, userId: str, admin: bool, vetted: bool, learnable: bool, anonymized: bool, partner: bool, striped: bool, corporate: bool, disabled: bool, explainable: bool, duplicateNamesRatio: int(int32), ipAddress: str, communityEngageOption: map{genderFilter: [str], ethnicityFilter: [str], countryOutFilter: [str], usRaceEthnicityFilter: [str]}} # Set learning from source.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/apiKeyInfo\n@desc Read API Key info.\n@returns(200) {apiKey: str, userId: str, admin: bool, vetted: bool, learnable: bool, anonymized: bool, partner: bool, striped: bool, corporate: bool, disabled: bool, explainable: bool, duplicateNamesRatio: int(int32), ipAddress: str, communityEngageOption: map{genderFilter: [str], ethnicityFilter: [str], countryOutFilter: [str], usRaceEthnicityFilter: [str]}} # Read API Key (uncached, i.e. DB read)\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/anonymize/{source}/{anonymized}/{token}\n@desc Activate/deactivate anonymization for a source.\n@required {source: str, anonymized: bool, token: str}\n@returns(200) {apiKey: str, userId: str, admin: bool, vetted: bool, learnable: bool, anonymized: bool, partner: bool, striped: bool, corporate: bool, disabled: bool, explainable: bool, duplicateNamesRatio: int(int32), ipAddress: str, communityEngageOption: map{genderFilter: [str], ethnicityFilter: [str], countryOutFilter: [str], usRaceEthnicityFilter: [str]}} # Anonymization of a source.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/anonymize/{source}/{anonymized}\n@desc Activate/deactivate anonymization for a source.\n@required {source: str, anonymized: bool}\n@returns(200) Anonymization of a source.\n@errors {401: Missing or incorrect API Key, 429: Too Many Requests}\n\n@endpoint GET /api2/json/nameTypeGeo/{properNoun}/{countryIso2}\n@desc Infer the likely type of a proper noun (personal name, brand name, place name etc.)\n@required {properNoun: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, commonType: str, commonTypeAlt: str, score: num(double)} # A typed name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/nameTypeBatch\n@desc Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)\n@optional {properNouns: [map{id: str, name: str}]}\n@returns(200) {properNouns: [map]} # A list of commonTypeized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/nameTypeGeoBatch\n@desc Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)\n@optional {properNouns: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {properNouns: [map]} # A list of commonTypeized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}\n@desc [USES 50 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)\n@required {countryIso2From: str, firstNameFrom: str, lastNameFrom: str, countryIso2To: str, firstNameTo: str, lastNameTo: str}\n@returns(200) {id: str, FirstLastNameGenderedOut: map{script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, FirstLastNameOriginedOut: map{script: str, id: str, explanation: str, firstName: str, lastName: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, FirstLastNameGeoOut: map{script: str, id: str, explanation: str, firstName: str, lastName: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, FirstLastNameDiasporaedOut: map{script: str, id: str, explanation: str, firstName: str, lastName: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, script: str} # Two classified names.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/corridorBatch\n@desc [USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)\n@optional {corridorFromTo: [map{id: str, personalNameGeoFrom: map, personalNameGeoTo: map}]}\n@returns(200) {corridorFromTo: [map]} # A list of classified name pairs.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/gender/{firstName}\n@desc 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.\n@required {firstName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/gender/{firstName}/{lastName}\n@desc Infer the likely gender of a name.\n@required {firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2}\n@desc Infer the likely gender of a name, given a local context (ISO2 country code).\n@required {firstName: str, lastName: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderGeoBatch\n@desc Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderBatch\n@desc Infer the likely gender of up to 100 names, detecting automatically the cultural context.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderFullGeo/{fullName}/{countryIso2}\n@desc Infer the likely gender of a full name, given a local context (ISO2 country code).\n@required {fullName: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderFull/{fullName}\n@desc Infer the likely gender of a full name, ex. John H. Smith\n@required {fullName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderFullBatch\n@desc Infer the likely gender of up to 100 full names, detecting automatically the cultural context.\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderFullGeoBatch\n@desc Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/originBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/originFull/{personalNameFull}\n@desc [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.\n@required {personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map], religionStatsSynthetic: [map]} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/originFullBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/subclassificationIndian/{firstName}/{lastName}\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.\n@required {firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, countryIso2: str, subClassification: str, subClassificationAlt: str, subclassificationTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A classified name at a sub-country level.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/subclassificationIndianFull/{fullName}\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.\n@required {fullName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, countryIso2: str, subClassification: str, subClassificationAlt: str, subclassificationTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A classified name at a sub-country level.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/subclassification/{countryIso2}/{firstName}/{lastName}\n@desc [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').\n@required {countryIso2: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, countryIso2: str, subClassification: str, subClassificationAlt: str, subclassificationTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A classified name at a sub-country level.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/subclassificationFull/{countryIso2}/{fullName}\n@desc [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').\n@required {countryIso2: str, fullName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, countryIso2: str, subClassification: str, subClassificationAlt: str, subclassificationTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A classified name at a sub-country level.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/subclassificationBatch\n@desc [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').\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of classified names at a sub-country level.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/subclassificationFullBatch\n@desc [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').\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of classified names at a sub-country level.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/subclassificationIndianBatch\n@desc [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.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of classified names at a subcountry level.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/subclassificationIndianFullBatch\n@desc [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.\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of classified names at a subcountry level.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/religionIndian/{subDivisionIso31662}/{firstName}/{lastName}\n@desc [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).\n@required {subDivisionIso31662: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, religion: str, religionAlt: str, religionsTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A religion-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/religion/{countryIso2}/{subDivisionIso31662}/{firstName}/{lastName}\n@desc [USES 10 UNITS PER NAME] Infer the likely religion of a personal first/last name. NB: only for INDIA (as of current version).\n@required {countryIso2: str, subDivisionIso31662: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, religion: str, religionAlt: str, religionsTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A religion-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull}\n@desc [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).\n@required {subDivisionIso31662: str, personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, score: num(double), religion: str, religionAlt: str, religionsTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A religion-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull}\n@desc [USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).\n@required {countryIso2: str, subDivisionIso31662: str, personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, score: num(double), religion: str, religionAlt: str, religionsTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A religion-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/religionFullBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.\n@optional {personalNames: [map{id: str, name: str, countryIso2: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of religion-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/religionIndianFullBatch\n@desc [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).\n@optional {personalNames: [map{id: str, name: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of religion-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/religionBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of religion-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/religionIndianBatch\n@desc [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).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of religion-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull}\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.\n@required {subDivisionIso31662: str, personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, score: num(double), castegroup: str, castegroupAlt: str, castegroupTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A castegroup-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/castegroupIndianFullBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.\n@optional {personalNames: [map{id: str, name: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of castegroup-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName}\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name.\n@required {subDivisionIso31662: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, castegroup: str, castegroupAlt: str, castegroupTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A castegroup-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/castegroupIndianBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of castegroup-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName}\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name.\n@required {subDivisionIso31662: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, caste: str, casteAlt: str, casteTop: [str], score: num(double), probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # A caste-coded name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/casteIndianBatch\n@desc [USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str, subdivisionIso: str}]}\n@returns(200) {personalNames: [map]} # A list of castegroup-coded names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/corridorFull/{countryIso2From}/{personalNameFrom}/{countryIso2To}/{personalNameTo}\n@desc [USES 50 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)\n@required {countryIso2From: str, personalNameFrom: str, countryIso2To: str, personalNameTo: str}\n@returns(200) {id: str, personalNameGeoFromGender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, personalNameGeoToGender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, PersonalNameOriginedOut: map{script: str, id: str, explanation: str, name: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map], religionStatsSynthetic: [map]}, personalNameGeoFromCountry: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, personalNameGeoToCountry: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, PersonalNameDiasporaedOut: map{script: str, id: str, explanation: str, name: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, script: str, firstLastNameGeoFromCountry: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, firstLastNameGeoFromGender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, firstLastNameGeoToGender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, firstLastNameGeoToCountry: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}} # Two classified names.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/corridorFullBatch\n@desc [USES 50 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)\n@optional {corridorFromTo: [map{id: str, personalNameGeoFrom: map, personalNameGeoTo: map}]}\n@returns(200) {corridorFromTo: [map]} # A list of classified name pairs.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/countryBatch\n@desc [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.\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of origined names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/countryFnLn/{firstName}/{lastName}\n@desc [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.\n@required {firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/countryFnLnBatch\n@desc [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.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {personalNames: [map]} # A list of origined names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/usRaceEthnicity/{firstName}/{lastName}\n@desc [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).\n@required {firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, raceEthnicityAlt: str, raceEthnicity: str, score: num(double), raceEthnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code}\n@desc [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).\n@required {firstName: str, lastName: str, zip5Code: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, raceEthnicityAlt: str, raceEthnicity: str, score: num(double), raceEthnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/usRaceEthnicityBatch\n@desc [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).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/usZipRaceEthnicityBatch\n@desc [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).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str, zipCode: str}]}\n@returns(200) {personalNames: [map]} # A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/usRaceEthnicityFull/{personalNameFull}\n@desc [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).\n@required {personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, raceEthnicityAlt: str, raceEthnicity: str, score: num(double), raceEthnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)} # a US resident's likely race/ethnicity : W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/usRaceEthnicityFullBatch\n@desc [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).\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of US resident's likely race/ethnicity. W_NL (white, non latino), HL (hispano latino),  A (asian, non latino), B_NL (black, non latino), AI_AN (American Indian or Alaskan Native*) and PI (Pacific Islander*). *optionally\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}\n@desc [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.)\n@required {countryIso2: str, firstName: str, lastName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]} # A diaspora / ethnicity for given name and geography.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/diasporaBatch\n@desc [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.)\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of diaspora / ethnicity given a name and residency.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/diasporaFull/{countryIso2}/{personalNameFull}\n@desc [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.)\n@required {countryIso2: str, personalNameFull: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]} # A diaspora / ethnicity for given name and geography.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/diasporaFullBatch\n@desc [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.)\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of diaspora / ethnicity given a name and residency.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}\n@desc [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)\n@required {countryIso2: str, firstName: str, lastName: str}\n@returns(200) {id: str, PersonalNameDiasporaedOut: map{script: str, id: str, explanation: str, name: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, PersonalNameOriginedOut: map{script: str, id: str, explanation: str, name: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map], religionStatsSynthetic: [map]}, country: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, gender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, PersonalNameUSRaceEthnicityOut: map{script: str, id: str, explanation: str, name: str, raceEthnicityAlt: str, raceEthnicity: str, score: num(double), raceEthnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)}, prime: bool, scoped: bool, script: str} # A community engagement candidate.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/communityEngageBatch\n@desc 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)\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, countryIso2: str}]}\n@returns(200) {engagementCandidates: [map]} # A list of diaspora / ethnicity given a name and residency.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/communityEngageFull/{countryIso2}/{personalNameFull}\n@desc [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)\n@required {countryIso2: str, personalNameFull: str}\n@returns(200) {id: str, PersonalNameDiasporaedOut: map{script: str, id: str, explanation: str, name: str, score: num(double), ethnicityAlt: str, ethnicity: str, lifted: bool, countryIso2: str, ethnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, PersonalNameOriginedOut: map{script: str, id: str, explanation: str, name: str, countryOrigin: str, countryOriginAlt: str, countriesOriginTop: [str], score: num(double), regionOrigin: str, topRegionOrigin: str, subRegionOrigin: str, probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map], religionStatsSynthetic: [map]}, country: map{script: str, id: str, explanation: str, name: str, score: num(double), country: str, countryAlt: str, region: str, topRegion: str, subRegion: str, countriesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double), religionStats: [map], religionStatsAlt: [map]}, gender: map{script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)}, PersonalNameUSRaceEthnicityOut: map{script: str, id: str, explanation: str, name: str, raceEthnicityAlt: str, raceEthnicity: str, score: num(double), raceEthnicitiesTop: [str], probabilityCalibrated: num(double), probabilityAltCalibrated: num(double)}, prime: bool, scoped: bool, script: str} # A community engagement candidate.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/communityEngageFullBatch\n@desc 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)\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {engagementCandidates: [map]} # A list cummunity engagement candidates.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/parseName/{nameFull}/{countryIso2}\n@desc 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.\n@required {nameFull: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, nameParserType: str, nameParserTypeAlt: str, firstLastName: map{script: str, id: str, explanation: str, firstName: str, lastName: str}, score: num(double)} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/parseNameBatch\n@desc Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of parsed names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/parseNameGeoBatch\n@desc 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.\n@optional {personalNames: [map{id: str, name: str, countryIso2: str}]}\n@returns(200) {personalNames: [map]} # A list of parsed names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/parseChineseName/{chineseName}\n@desc Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name)\n@required {chineseName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, nameParserType: str, nameParserTypeAlt: str, firstLastName: map{script: str, id: str, explanation: str, firstName: str, lastName: str}, score: num(double)} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/parseChineseNameBatch\n@desc Infer the likely first/last name structure of a name, ex. 王晓明 -> 王(surname) 晓明(given name).\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of parsed names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/pinyinChineseName/{chineseName}\n@desc Romanize the Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name)\n@required {chineseName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, nameParserType: str, nameParserTypeAlt: str, firstLastName: map{script: str, id: str, explanation: str, firstName: str, lastName: str}, score: num(double)} # A pinyin name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/pinyinChineseNameBatch\n@desc Romanize a list of Chinese name to Pinyin, ex. 王晓明 -> Wang (surname) Xiaoming (given name).\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of Pinyin names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}\n@desc Return a score for matching Chinese name ex. 王晓明 with a romanized name ex. Wang Xiaoming\n@required {chineseSurnameLatin: str, chineseGivenNameLatin: str, chineseName: str}\n@returns(200) {script: str, id: str, explanation: str, matchStatus: str, score: num(double)} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/chineseNameMatchBatch\n@desc Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming\n@optional {personalNames: [map{id: str, name1: map, name2: map}]}\n@returns(200) {matchedNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}\n@desc Infer the likely gender of a Chinese name in LATIN (Pinyin).\n@required {chineseSurnameLatin: str, chineseGivenNameLatin: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderChineseNamePinyinBatch\n@desc Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderChineseName/{chineseName}\n@desc Infer the likely gender of a Chinese full name ex. 王晓明\n@required {chineseName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderChineseNameBatch\n@desc Infer the likely gender of up to 100 full names ex. 王晓明\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}\n@desc Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming\n@required {chineseSurnameLatin: str, chineseGivenNameLatin: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, orderOption: str, matchCandidates: [map]} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/chineseNameCandidatesBatch\n@desc Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {namesAndMatchCandidates: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}\n@desc Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')\n@required {chineseSurnameLatin: str, chineseGivenNameLatin: str, knownGender: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, orderOption: str, matchCandidates: [map]} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/chineseNameCandidatesGenderBatch\n@desc Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, gender: str}]}\n@returns(200) {namesAndMatchCandidates: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/parseJapaneseName/{japaneseName}\n@desc Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae\n@required {japaneseName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, nameParserType: str, nameParserTypeAlt: str, firstLastName: map{script: str, id: str, explanation: str, firstName: str, lastName: str}, score: num(double)} # A origined name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/parseJapaneseNameBatch\n@desc Infer the likely first/last name structure of a name, ex. 山本 早苗 or Yamamoto Sanae\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of parsed names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}\n@desc Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae\n@required {japaneseSurnameLatin: str, japaneseGivenNameLatin: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, orderOption: str, matchCandidates: [map]} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}\n@desc Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.\n@required {japaneseSurnameLatin: str, japaneseGivenNameLatin: str, knownGender: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, orderOption: str, matchCandidates: [map]} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}\n@desc Romanize japanese name, based on the name in Kanji.\n@required {japaneseSurnameKanji: str, japaneseGivenNameKanji: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, orderOption: str, matchCandidates: [map]} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/japaneseNameKanjiCandidatesBatch\n@desc Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {namesAndMatchCandidates: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/japaneseNameGenderKanjiCandidatesBatch\n@desc Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae\n@optional {personalNames: [map{id: str, firstName: str, lastName: str, gender: str}]}\n@returns(200) {namesAndMatchCandidates: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/japaneseNameLatinCandidatesBatch\n@desc Romanize japanese names, based on the name in KANJI\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {namesAndMatchCandidates: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}\n@desc Return a score for matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae\n@required {japaneseSurnameLatin: str, japaneseGivenNameLatin: str, japaneseName: str}\n@returns(200) {script: str, id: str, explanation: str, matchStatus: str, score: num(double)} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}\n@desc [CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. 山本 早苗 with a romanized name ex. Yamamoto Sanae\n@required {japaneseSurnameLatin: str, japaneseGivenNameLatin: str, japaneseName: str}\n@returns(200) {feedbackCredits: int(int64)} # A romanized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/japaneseNameMatchBatch\n@desc Return a score for matching a list of Japanese names in KANJI ex. 山本 早苗 with romanized names ex. Yamamoto Sanae\n@optional {personalNames: [map{id: str, name1: map, name2: map}]}\n@returns(200) {matchedNames: [map]} # A list of matched names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}\n@desc Infer the likely gender of a Japanese name in LATIN (Pinyin).\n@required {japaneseSurname: str, japaneseGivenName: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderJapaneseNameBatch\n@desc Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).\n@optional {personalNames: [map{id: str, firstName: str, lastName: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/genderJapaneseNameFull/{japaneseName}\n@desc Infer the likely gender of a Japanese full name ex. 王晓明\n@required {japaneseName: str}\n@returns(200) {script: str, id: str, explanation: str, name: str, likelyGender: str, genderScale: num(double), score: num(double), probabilityCalibrated: num(double)} # A genderized name.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/genderJapaneseNameFullBatch\n@desc Infer the likely gender of up to 100 full names\n@optional {personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}\n@desc [USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.\n@required {firstName: str, lastName: str, phoneNumber: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, internationalPhoneNumberVerified: str, phoneCountryIso2Verified: str, phoneCountryCode: int(int32), phoneCountryCodeAlt: int(int32), phoneCountryIso2: str, phoneCountryIso2Alt: str, originCountryIso2: str, originCountryIso2Alt: str, phoneNumber: str, verified: bool, score: num(double), countryIso2: str} # A name with country and phone code.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2}\n@desc [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).\n@required {firstName: str, lastName: str, phoneNumber: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, internationalPhoneNumberVerified: str, phoneCountryIso2Verified: str, phoneCountryCode: int(int32), phoneCountryCodeAlt: int(int32), phoneCountryIso2: str, phoneCountryIso2Alt: str, originCountryIso2: str, originCountryIso2Alt: str, phoneNumber: str, verified: bool, score: num(double), countryIso2: str} # A name with country and phone code.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint GET /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2}\n@desc [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).\n@required {firstName: str, lastName: str, phoneNumber: str, phoneNumberE164: str, countryIso2: str}\n@returns(200) {script: str, id: str, explanation: str, firstName: str, lastName: str, internationalPhoneNumberVerified: str, phoneCountryIso2Verified: str, phoneCountryCode: int(int32), phoneCountryCodeAlt: int(int32), phoneCountryIso2: str, phoneCountryIso2Alt: str, originCountryIso2: str, originCountryIso2Alt: str, phoneNumber: str, verified: bool, score: num(double), countryIso2: str} # A name with country and phone code.\n@errors {401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/phoneCodeBatch\n@desc [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.\n@optional {personalNamesWithPhoneNumbers: [map{id: str, firstName: str, lastName: str, phoneNumber: str}]}\n@returns(200) {personalNamesWithPhoneNumbers: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/phoneCodeGeoBatch\n@desc [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).\n@optional {personalNamesWithPhoneNumbers: [map{id: str, firstName: str, lastName: str, phoneNumber: str, countryIso2: str, countryIso2Alt: str}]}\n@returns(200) {personalNamesWithPhoneNumbers: [map]} # A list of genderized names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/translateFullBatch\n@desc Translate up to 100 full names, from one source language to a target language.\n@optional {sourceLangIso3: str, targetLangIso3: str, personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of translated names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/searchFullBatch\n@desc Search up to 100 full names, in an indexed dataset - using fuzzy name maching.\n@optional {datasetName: str, personalNames: [map{id: str, name: str}]}\n@returns(200) {personalNames: [map]} # A list of translated names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@endpoint POST /api2/json/compareFullBatch\n@desc Compare up to 100 full name pairs, using fuzzy name maching.\n@optional {personalNames: [map{id: str, name1: map, name2: map}]}\n@returns(200) {personalNames: [map]} # A list of compared names.\n@errors {400: Bad request (ex. too many names), 401: Missing or incorrect API Key, 403: Email not Verified, or API Limit Reached, or API Key Disabled, 429: Too Many Requests}\n\n@end\n"}}