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

namerequireddescription
categoriesFilterfalseReturn the designated entity categories. The supported categories are listed below this table.

Empty array [] to return all categories.
callbackfalseSuccessful callback URL, support HTTP POST.

Entity Categories

This API supports 31 types of categories.

Code NameCountryRemark
PersonAll
OrganizationAll
PhoneNumberAll
PersonTypeAll
AddressAll
EmailAll
DateTimeAll
TemperatureAll
CurrencyAll
AgeAll
PercentageAll
CreditCardNumberAll
InternationalBankingAccountNumberAllIBAN
SWIFTCodeAll
ABARoutingNumberUS
USIndividualTaxpayerIdentificationUS
USSocialSecurityNumberUS
USDriversLicenseNumberUS
USUKPassportNumberUS and UK
USBankAccountNumberUS
ACHRoutingNumberUSAutomatic Clearing House number
InsuranceProviderUS
MemberIDUSInsurance member ID number
GroupIDUSInsurance group number
AUDriversLicenseAustraliaInsurance group number
AUPassportNumberAustraliaInsurance group number
AUBusinessNumberAustraliaAustralia business number
BSBCodeAustraliaBank state branch code
UKDriversLicenseNumberUKUK driver license number
UKNationalHealthNumberUKNational Health Service (NHS) number
UKNationalInsuranceNumberUKNational insurance number

Request Body

{"confidenceScore"=>0.7, "categoriesFilter"=>["Person", "PhoneNumber", "Email", "Date"], "callback"=>"http://examplehost:8080/examplepath"}