Async document PII discovery
POST {{baseUrl}}/api/{{apiV2Version}}/ner/:document-id/pii/async
Discover PII information from a document. This is an async mode API.
Request Body
name | required | description |
---|---|---|
categoriesFilter | false | Return the designated entity categories. The supported categories are listed below this table. Empty array [] to return all categories. |
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
{"confidenceScore"=>0.7, "categoriesFilter"=>["Person", "PhoneNumber", "Email", "Date"], "callback"=>"http://examplehost:8080/examplepath"}