Data Masking
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 DirectoryEndpoint
POST https://api.apiverve.com/v1/datamaskingCode Examples
Here are examples of how to call this API in different programming languages:
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."
}'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);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)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
$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);
?>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))
}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:
X-API-Key: your_api_key_hereGraphQL 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:
| Parameter | Type | Required | Location | Description | Example |
|---|---|---|---|---|---|
| text | string | Yes | body | The text containing sensitive data to mask | Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789. |
| types | array | No | body | Array 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
{
"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
}
}
}<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>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: 0Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
| error | string | null | Contains error message if status is "error", otherwise null | null |
| data | object | null | Contains the API response data if successful, otherwise null | {...} |
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value |
|---|---|---|
| masked | string | "Contact John Doe at [EMAIL] or call [PHONE]. His SSN is [SSN]." |
| detected | object | {...} |
| detected.email | number | 1 |
| detected.phone | number | 1 |
| detected.ssn | number | 1 |
| detected.credit_card | number | 0 |
| detected.ip_address | number | 0 |
| detected.url | number | 0 |
| detected.date | number | 0 |
Headers
Required and optional headers for API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
| X-API-Key | Yes | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
| Accept | No | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
| User-Agent | No | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
| X-Request-ID | No | req_123456789 | Custom request identifier for tracking and debugging requests |
| Cache-Control | No | no-cache | Control 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:
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
| Status Code | Message | Description |
|---|---|---|
| 200 | OK | Request successful, data returned |
| 400 | Bad Request | Invalid request parameters or malformed request |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key does not have permission for this endpoint |
| 429 | Too Many Requests | Rate limit exceeded, please slow down requests |
| 500 | Internal Server Error | Server error, please try again later |
Was this page helpful?
Help us improve our documentation




