Spec

Fragmentos de código

curl "https://api.oanor.com/mask-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/mask-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/mask-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/mask-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Respuesta de ejemplo

Una respuesta real de este endpoint, capturada en la última comprobación de estado.

{
    "data": {
        "name": "Mask API",
        "notes": "This masks a known value for display (e.g. •••• 1234) — to find and redact PII inside free text, use a redaction API. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/mask",
                "params": {
                    "value": "the string (required)",
                    "mask_char": "default •",
                    "show_last": "visible chars at end (default 4)",
                    "show_first": "visible chars at start (default 0)",
                    "keep_separators": "true to keep spaces/dashes"
                },
                "returns": "the masked string"
            },
            {
                "path": "/v1/email",
                "params": {
                    "email": "an email address (required)",
                    "mask_char": "default •",
                    "show_first": "visible local chars (default 1)",
                    "mask_domain": "true to also mask the domain"
                },
                "returns": "the masked email"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Mask a value for safe display — keep the first and/or last few characters visible and replace the rest with a mask character, optionally leaving separators (spaces, dashes) intact so a card or phone number keeps its shape. A dedicated email masker hides the local part (and optionally the domain) while keeping it recognisable. Pure local, no key."
    },
    "meta": {
        "timestamp": "2026-06-03T09:25:08.232Z",
        "request_id": "7817b0e0-ef2f-4936-b4c5-16f97afb828b"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}