Content PII discovery
POST {{baseUrl}}/api/{{apiV1Version}}/ner/pii
Discover PII information from textual contents.
Request body
| name | required | description |
|---|---|---|
| paragraphs | true | Target content for analysis. The format is a JSON array. The maximum number of array values is 5. The maximum length of an array value is 5120 characters. |
| categoriesFilter | false | Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all categories. |
Entity Categories
This API supports 31 types of categories.
| Code Name | Country | Remark |
|---|---|---|
| Person | All | |
| Organization | All | |
| PhoneNumber | All | |
| PersonType | All | |
| Address | All | |
| All | ||
| DateTime | All | |
| Temperature | All | |
| Currency | All | |
| Age | All | |
| Percentage | All | |
| CreditCardNumber | All | |
| InternationalBankingAccountNumber | All | IBAN |
| SWIFTCode | All | |
| ABARoutingNumber | US | |
| USIndividualTaxpayerIdentification | US | |
| USSocialSecurityNumber | US | |
| USDriversLicenseNumber | US | |
| USUKPassportNumber | US and UK | |
| USBankAccountNumber | US | |
| ACHRoutingNumber | US | Automatic Clearing House number |
| InsuranceProvider | US | |
| MemberID | US | Insurance member ID number |
| GroupID | US | Insurance group number |
| AUDriversLicense | Australia | Insurance group number |
| AUPassportNumber | Australia | Insurance group number |
| AUBusinessNumber | Australia | Australia business number |
| BSBCode | Australia | Bank state branch code |
| UKDriversLicenseNumber | UK | UK driver license number |
| UKNationalHealthNumber | UK | National Health Service (NHS) number |
| UKNationalInsuranceNumber | UK | National insurance number |
Request Body
{"paragraphs"=>["The Kremlin and the West held out the possibility of a diplomatic path out of the Ukraine crisis, even as Russia appeared to continue preparations for a potential invasion, including moving troops and military hardware closer to its neighbor.", "At a made-for-television meeting with President Vladimir Putin, Foreign Minister Sergey Lavrov signaled Monday that Russia was ready to keep talking about the security grievances that have led to the crisis.", "The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous."], "confidenceScore"=>0.7, "categoriesFilter"=>["Person", "PhoneNumber", "Email", "Date"]}
RESPONSES
status: OK
{"items":[{"paragraph":"The Kremlin and the West held out the possibility of a diplomatic path out of the Ukraine crisis, even as Russia appeared to continue preparations for a potential invasion, including moving troops and military hardware closer to its neighbor.","entities":[]},{"paragraph":"At a made-for-television meeting with President Vladimir Putin, Foreign Minister Sergey Lavrov signaled Monday that Russia was ready to keep talking about the security grievances that have led to the crisis.","entities":[{"text":"Vladimir Putin","category":"Person","subcategory":"","confidenceScore":0.99,"offset":48,"length":14},{"text":"Sergey Lavrov","category":"Person","subcategory":"","confidenceScore":0.99,"offset":81,"length":13},{"text":"Monday","category":"DateTime","subcategory":"Date","confidenceScore":0.8,"offset":104,"length":6}]},{"paragraph":"The University of the West Indies Seismic Research Centre tweeted photos taken by one of its researchers Sunday morning of an ash covered landscape in St. Vincent, using the hashtag #stilldangerous.","entities":[]}]}