Data Masking API

Data Masking is a powerful tool for detecting and masking sensitive information in text. It can identify and redact emails, phone numbers, SSNs, credit cards, IP addresses, URLs, and dates.

This is a Javascript Wrapper for the Data Masking API

Installation

Using npm:

npm install @apiverve/datamasking

Using yarn:

yarn add @apiverve/datamasking

Configuration

Before using the Data Masking API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com

Quick Start

Get started with the Quick Start Guide

The Data Masking API documentation is found here: https://docs.apiverve.com/ref/datamasking. You can find parameters, example responses, and status codes documented here.

Setup

const datamaskingAPI = require('@apiverve/datamasking');
const api = new datamaskingAPI({
    api_key: '[YOUR_API_KEY]'
});

Usage

Perform Request

Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.

var query = {
  "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
};

api.execute(query, function (error, data) {
    if (error) {
        return console.error(error);
    } else {
        console.log(data);
    }
});

Using Promises

You can also use promises to make requests. The API returns a promise that you can use to handle the response.

var query = {
  "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
};

api.execute(query)
    .then(data => {
        console.log(data);
    })
    .catch(error => {
        console.error(error);
    });

Using Async/Await

You can also use async/await to make requests. The API returns a promise that you can use to handle the response.

async function makeRequest() {
    var query = {
  "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
};

    try {
        const data = await api.execute(query);
        console.log(data);
    } catch (error) {
        console.error(error);
    }
}

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "masked": "Contact John Doe at [EMAIL] or call [PHONE]. His SSN is [SSN].",
    "detected": {
      "email": 1,
      "phone": 1,
      "ssn": 1,
      "credit_card": 0,
      "ip_address": 0,
      "url": 0,
      "date": 0
    }
  }
}

Customer Support

Need any assistance? Get in touch with Customer Support.

Updates

Stay up to date by following @apiverveHQ on Twitter.

Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.

License

Licensed under the The MIT License (MIT)

Copyright (©) 2025 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.