Data Masking API

Overview

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

POST Endpoint

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

Example

How to call the Data Masking 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)

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))
}

{
  "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
    }
  }
}

Authentication

The Data Masking API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Data Masking API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Data Masking API:

Response

The Data Masking API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <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>
</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

Response Structure

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

Learn more about response formats →

Response Data Fields

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

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Data Masking through GraphQL to combine it with other API calls in a single request. Query only the data masking data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  datamasking(
    input: {
      text: "Contact John Doe at [email protected] or call 555-123-4567. His SSN is 123-45-6789."
    }
  ) {
    masked
    detected {
      email
      phone
      ssn
      credit_card
      ip_address
      url
      date
    }
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Data Masking API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Data Masking requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Data Masking API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Data Masking

Official Data Masking packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Data Masking works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Data Masking, you might also like these APIs:

Rhyming Words

Word Rhymes is a simple tool for getting word rhymes. It returns a list of rhyming words.

1 credit per call

Word Pronunciation

Word Pronunciation is a simple tool for getting the pronunciation of a word. It returns the pronunciation of the word provided.

1 credit per call

Word Opposites

Word Opposites is a simple tool for getting the opposites of a word. It returns a list of opposites for the given word.

10 credits per call