Async content PII discovery
POST {{baseUrl}}/api/{{apiV1Version}}/ner/pii/async
Discover PII information from text contents. This is an async mode API.
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 5210 characters. |
| callback | false | Successful callback URL, support HTTP POST. |
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"=>["Pyroclastic flows at La Soufriere could possibly cause destruction and devastation of areas close to the volcano, according to NEMO.", "Pyroclastic flows contain a high-density mix of hot lava blocks, pumice, ash and volcanic gas. They move at very high speed down volcanic slopes, typically following valleys, according to the USGS and destroy nearly everything in their path.", "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"], "callback"=>"http://examplehost:8080/examplepath"}
RESPONSES
status: OK
{"jobId":"620b6c9ad1906f1744072492","taskCategory":"NER","taskSubcategory":"ASYNC_PII","status":"Processing","startDateTime":"2022-02-15T09:04:26.734Z","expirationDateTime":"2022-02-16T09:04:26.734Z"}