Qodex.ai

Async content PII discovery

POST {{baseUrl}}/api/{{apiV3Version}}/ner/pii/async

Discover PII information from text contents. This is an async mode API.

Request Body

namerequireddescription
paragraphstrueTarget 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.
callbackfalseThe callback URL. HTTP POST is supported.
categoriesFilterfalseReturn the designated entity categories. The supported categories are listed below this table.

Empty array [] to return all PII categories.

Only PII entities fill in array to return filled in related PII categories.

Only PHI entities fill in array to return filled in related PHI categories and all PII categories.

PII and PHI entities fill in array to return filled in related PII and PHI categories.

Entity Categories

This API supports 80 types of categories.

Code NameCountryRemark
PersonAll(PII)
OrganizationAll(PII)
PersonTypeAll(PII)
AddressAll(PII)
ZipCodeAll(PII) First three digits of a zip code
LocationAll(PII) LocationAllIncludes names like cities, countries, regions, states manmade structures, and geographical locations, like rivers, oceans, and deserts.
EmailAll(PII)
FaxNumberAll(PII)
DateTimeAll(PII)
TemperatureAll(PII)
CurrencyAll(PII)
AgeAll(PII)
PercentageAll(PII)
CreditCardNumberAll(PII)
InternationalBankingAccountNumberAll(PII) IBAN
GenderAll(PII) Terms that disclose the gender of the subject, e.g., male, female, woman, gentleman, or lady.
SWIFTCodeAll
SocialMediaUrlAll(PII) It supports the social media account detection:
* Twitter username
* Facebook username
* YouTube account
* Vimeo account
* Instagrame username
* LinkedIn URL
* Pinterest username
HumanRaceAll(PII) Examples: African, Asian, European, Native American, Oceanian
ReligiousViewAll(PII) Example: Judaism, Catholic
SexualPreferenceAll(PII) Example: bisexual, homosexual, heterosexual
PoliticalAffiliationAll(PII) Example: Democratic Party (United States) or Republican Party (United States)
CountryCodeAll(PII) Example: +591, +886
LanguageAll(PII) Example: English, French
OccupationAll(PII) Example: Scientist, Doctor
BloodTypeAll(PII) eg. A, B, AB, O
MaritalStatusAll(PII) eg. Married, Single, Divorced
IPAll(PII) Network IP4 and IP6 address. Example: 168.131.1.1 and 21DA:D3:0:2F3B:2AA:FF:FE28:9C5A
ABARoutingNumberUS(PII)
USPhoneNumberUS(PII)
USIndividualTaxpayerIdentificationUS(PII)
USSocialSecurityNumberUS(PII)
USDriversLicenseNumberUS(PII)
USUKPassportNumberUS and UK(PII) Context-aware cognition. Needs passport number text around numbers.
USBankAccountNumberUS(PII)
ACHRoutingNumberUS(PII) Automatic Clearing House number
InsuranceProviderUS(PII)
MemberIDUS(PII) Insurance member ID number
GroupIDUSInsurance group number
AUDriversLicenseAustralia(PII) Insurance group number
AUPassportNumberAustralia(PII) Insurance group number
AUBusinessNumberAustralia(PII) Australia business number
BSBCodeAustralia(PII) Bank state branch code
AUSTRALIAPhoneNumberAustralia(PII)
CustomerReferenceNumberAustralia(PII) A CRN is 9 numbers and ends with a letter. For example: 123 456 789A.
TaxFileNumberAustralia(PII) A tax file number (TFN) is free and identifies the user for tax and superannuation purposes.
UKDriversLicenseNumberUK(PII) UK driver license number
CommunityHealthIndexUK(PII) Community Health Index (CHI) number, e.g. 0911640250
UKNationalHealthNumberUK(PII) National Health Service (NHS) number
UKNationalInsuranceNumberUK(PII) National insurance number
UKNationalHealthNumberUK(PII) National Health Service number
UKPhoneNumberUK(PII) U.K. phone number
ExaminationNameAllExamination (PHI); diagnostic procedures and tests, including vital signs and body measurements
DiagnosisAllDiagnosis (PHI); disease, syndrome, poisoning
SymptomOrSignAllSymptom (PHI); subjective or objective evidence of disease or other diagnoses
TreatmentNameAllTreatment (PHI); therapeutic procedures
AllergenAllAllergen (PHI); an antigen triggering an allergic reaction
CourseAllCourse (PHI); description of a change in another entity over time, such as condition progression, a course of treatment or medication
MeasurementValueAllMeasurement value (PHI); the value related to an examination or a medical condition measurement
VariantAllVariant (PHI); all mentions of gene variations and mutations
GeneOrProteinAllGene/Protein (PHI); all mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins
MutationTypeAllMutation type (PHI); description of the mutation, including its type, effect, and location
ExpressionAllExpression (PHI); gene expression level
AdministrativeEventAllAdministrative event (PHI); events that relate to the healthcare system but of an administrative/semi-administrative nature
CareEnvironmentAllCare environment (PHI); an environment or location where patients are given care
ConditionQualifierAllCondition qualifier (PHI); qualitative terms that are used to describe a medical condition
MedicationNameAllMedication name (PHI); medication mentions, including copyrighted brand names, and non-brand names
DosageAllDosage (PHI); amount of medication ordered
FamilyRelationAllFamily relation (PHI); mentions of family relatives of the subject
BodyStructureAllBody structure (PHI); body systems, anatomic locations or regions, and body sites
DirectionAllDirection (PHI); directional terms that may relate to a body structure, medical condition, examination, or treatment
FrequencyAllFrequency (PHI); describes how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur
TimeAllTime (PHI); temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event
MeasurementUnitAllMeasurement unit (PHI); the unit of measurement related to an examination or a medical condition measurement
RelationalOperatorAllRelational operator (PHI); phrases that express the quantitative relation between an entity and some additional information
HealthcareProfessionAllHealthcare profession (PHI); a healthcare practitioner licensed or non-licensed
ConditionScaleAllCondition scale (PHI); qualitative terms that characterize the condition by a scale, which is a finite ordered list of values
MedicationClassAllMedication class (PHI); a set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease
MedicationFormAllMedication form (PHI); the form of the medication
MedicationRouteAllMedication route (PHI); the administration method of medication

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"}

HEADERS

KeyDatatypeRequiredDescription
{{idoxAPIKey}}stringPlease sign-up iDox.ai and get an API key.

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"}