@apiverve/taxidvalidator 1.1.14 → 1.2.0

package/README.md

@@ -131,12 +131,15 @@ async function makeRequest() {
     "digits_only": "123456789",
     "masked": "***-**-6789",
     "last4": "6789",
+    "is_placeholder": true,
     "validation_details": {
       "format_valid": true,
       "area_number_valid": true,
       "group_number_valid": true,
       "serial_number_valid": true
     },
+    "risk_score": 35,
+    "risk_level": "medium",
     "error": null
   }
 }

package/index.d.ts

@@ -4,33 +4,48 @@ declare module '@apiverve/taxidvalidator' {
     secure?: boolean;
   }
 
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
   export interface taxidvalidatorResponse {
     status: string;
     error: string | null;
     data: TaxIDValidatorData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface TaxIDValidatorData {
-      valid:             boolean;
-      taxid:             string;
-      type:              string;
-      typeFull:          string;
-      format:            string;
-      normalized:        string;
-      digitsOnly:        string;
-      masked:            string;
-      last4:             string;
+      valid:             boolean | null;
+      taxid:             null | string;
+      type:              null | string;
+      typeFull:          null | string;
+      format:            null | string;
+      normalized:        null | string;
+      digitsOnly:        null | string;
+      masked:            null | string;
+      last4:             null | string;
+      isPlaceholder:     boolean | null;
       validationDetails: ValidationDetails;
+      riskScore:         number | null;
+      riskLevel:         null | string;
       error:             null;
   }
   
   interface ValidationDetails {
-      formatValid:       boolean;
-      areaNumberValid:   boolean;
-      groupNumberValid:  boolean;
-      serialNumberValid: boolean;
+      formatValid:       boolean | null;
+      areaNumberValid:   boolean | null;
+      groupNumberValid:  boolean | null;
+      serialNumberValid: boolean | null;
   }
 
   export default class taxidvalidatorWrapper {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/taxidvalidator",
-  "version": "1.1.14",
+  "version": "1.2.0",
   "description": "Tax ID Validator is a comprehensive tool for validating US Tax IDs including Social Security Numbers (SSN), Employer Identification Numbers (EIN), and Individual Taxpayer Identification Numbers (ITIN).",
   "main": "index.js",
   "types": "index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "index.js",
@@ -23,7 +23,7 @@
     "directory": "npm"
   },
   "keywords": [
-    ""
+    "tax id", "ssn validator", "ein validator", "itin validator", "social security"
   ],
   "author": {
     "name": "APIVerve",
@@ -41,8 +41,7 @@
     "dotenv": "^16.4.7"
   },
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "promise": "^8.3.0",
-    "axios": "1.13.2"
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
   }
 }