Sensitivity Detection and Redaction

Introduction

Welcome to our Sensitivity Detection and Redaction API documentation. This API is designed to assist you in identifying sensitive data within text and providing recommendations for regex patterns.

Base URL
The base URL for accessing the API is https://api.example.com.

Endpoint: /api/recommend

Overview

This endpoint analyzes input text and returns a JSON response containing recommended regex patterns for sensitive data found in the text.

Request
Method: POST
Endpoint: /api/recommend
Content Type: application/json
Request Body Example

JSON

{
  "text": "This is a sample text containing an email test@gmail.com and a credit card number 4111111111111111."
}

Response
A successful response will have a JSON structure as follows:

json
{
  "state": "Ok",
  "response": [
    {
      "text": "test@gmail.com",
      "regex": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
      "category": "Email",
      "confidence": 0.8
    },
    {
      "text": "4111111111111111",
      "regex": "^(?:\\d{4}-){3}\\d{4}|\\d{16}$",
      "category": "CreditCardNumber",
      "confidence": 1.0
    }
  ],
  "error": null
}

Explanation

text: The sensitive text identified.
regex: The recommended regex pattern.
category: The category of sensitive information (e.g., Email, CreditCardNumber).
confidence: Confidence level in the recommendation (ranging from 0.0 to 1.0).

Utilize these powerful endpoints to enhance the security and privacy of your data. If you have any questions or encounter issues, feel free to contact our support team at support@regexmy.com.