diff --git a/README.md b/README.md index de0eabc..dbeb940 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,48 @@ guard = Guard().use( ``` +### Supported Entities +The following entities are supported by this validator. You may use any combination of them together in the validator init + +- "CREDIT_CARD", +- "CRYPTO", +- "DATE_TIME", +- "EMAIL_ADDRESS", +- "IBAN_CODE", +- "IP_ADDRESS", +- "NRP", +- "LOCATION", +- "PERSON", +- "PHONE_NUMBER", +- "MEDICAL_LICENSE", +- "URL", +- "US_BANK_NUMBER", +- "US_DRIVER_LICENSE", +- "US_ITIN", +- "US_PASSPORT", +- "US_SSN", +- "UK_NHS", +- "ES_NIF", +- "ES_NIE", +- "IT_FISCAL_CODE", +- "IT_DRIVER_LICENSE", +- "IT_VAT_CODE", +- "IT_PASSPORT", +- "IT_IDENTITY_CARD", +- "PL_PESEL", +- "SG_NRIC_FIN", +- "SG_UEN", +- "AU_ABN", +- "AU_ACN", +- "AU_TFN", +- "AU_MEDICARE", +- "IN_PAN", +- "IN_AADHAAR", +- "IN_VEHICLE_REGISTRATION", +- "IN_VOTER", +- "IN_PASSPORT", +- "FI_PERSONAL_IDENTITY_CODE" + # API Reference **`__init__(self, entities: List[str], model_name: str = "urchade/gliner_small-v2.1", on_fail: Optional[Callable] = None)`**