Data MaskingData Masking

Token Usage:1 per call

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 API provides reliable and fast access to data masking data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.

View API in Directory

Endpoint

POST Request
POST https://api.apiverve.com/v1/datamasking

Code Examples

Here are examples of how to call this API in different programming languages:

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/datamasking" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
}'
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/datamasking', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
})
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

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

response = requests.post('https://api.apiverve.com/v1/datamasking', headers=headers, json=payload)

data = response.json()
print(data)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const postData = JSON.stringify({
  "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
});

const req = https.request('https://api.apiverve.com/v1/datamasking', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.write(postData);
req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/datamasking');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
    'text': 'Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789.'
}));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "text": "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/datamasking", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/datamasking')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

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

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

request.body = payload.to_json

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

Authentication

This API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

GraphQL AccessBETA

Most APIVerve APIs support GraphQL queries, allowing you to combine multiple API calls into a single request and retrieve only the data you need. This powerful feature enables you to orchestrate complex data fetching with precise field selection.

This API does not currently support GraphQL as it requires a POST request. GraphQL support for POST APIs is coming soon.

Parameters

The following parameters are available for this API endpoint:

ParameterTypeRequiredLocationDescriptionExample
textstringYesbodyThe text containing sensitive data to maskContact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789.
typesarrayNobodyArray of data types to mask (default: all types)["email","phone","ssn","credit_card","ip_address","url","date"]

Response

The API returns responses in JSON, XML, and YAML formats:

Example Responses

JSON Response
200 OK
{
  "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
    }
  }
}
XML Response
200 OK
<Root>
  <status>ok</status>
  <error />
  <data>
    <masked>Contact John Doe at [EMAIL] or call [PHONE]. His SSN is [SSN].</masked>
    <detected>
      <email>1</email>
      <phone>1</phone>
      <ssn>1</ssn>
      <credit_card>0</credit_card>
      <ip_address>0</ip_address>
      <url>0</url>
      <date>0</date>
    </detected>
  </data>
</Root>
YAML Response
200 OK
status: ok
error: 
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

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample Value
maskedstring"Contact John Doe at [EMAIL] or call [PHONE]. His SSN is [SSN]."
detectedobject{...}
detected.emailnumber1
detected.phonenumber1
detected.ssnnumber1
detected.credit_cardnumber0
detected.ip_addressnumber0
detected.urlnumber0
detected.datenumber0

Headers

Required and optional headers for API requests:

Header NameRequiredExample ValueDescription
X-API-KeyYesyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
AcceptNoapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentNoMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDNoreq_123456789Custom request identifier for tracking and debugging requests
Cache-ControlNono-cacheControl caching behavior for the request and response

Client Libraries

To get started with minimal code, most of our APIs are available through client libraries and clients:

Run in PostmanNPMPyPINuGetSwagger

Error Codes

The API uses standard HTTP status codes to indicate success or failure:

Status CodeMessageDescription
200OKRequest successful, data returned
400Bad RequestInvalid request parameters or malformed request
401UnauthorizedMissing or invalid API key
403ForbiddenAPI key does not have permission for this endpoint
429Too Many RequestsRate limit exceeded, please slow down requests
500Internal Server ErrorServer error, please try again later

What's Next?

Continue your journey with these recommended resources

Was this page helpful?

Help us improve our documentation