Anonymization

Text Anonymization

Automatically mask personally identifiable information (PII) in any text.

Send the text to anonymize in the request body.

Example request

1curl -X POST https://app.anymize.ai/api/anonymize \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"text": "Max Mustermann wohnt in Berlin und seine E-Mail ist max@example.com",
6    #86efac">"language": "de"
7  }'

Example response

The anonymized text contains placeholders for detected entities.

{
  "job_id": "job_abc123def456",
  "status": "processing",
  "message": "Anonymization job created"
}

Endpoint

Upload documents or images for OCR processing and automatic anonymization.

Supported Formats

The following file formats are supported for OCR processing.

Parameters

Example Request

1curl -X POST https://app.anymize.ai/api/ocr \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -F #86efac">"file=@document.pdf" \
4  -F #86efac">"language=de"

Response

Returns a job ID. Processing runs asynchronously — check status with the Status API.

{
  "job_id": "job_ocr789xyz012",
  "status": "processing",
  "message": "OCR and anonymization job created"
}

Processing Pipeline

File anonymization runs through a 3-step pipeline.

Endpoint

Combine chat and anonymization in a single request — your data is masked before reaching the model.

Flow

Here's how anonymous chat processes your request:

Parameters

Same parameters as Chat Completions plus anonymization options.

Placeholder Handling

In anonymous chat, personal data is automatically replaced with placeholders in the format [[Type-HASH]]. For de-anonymization to work, the model must preserve these placeholders exactly.

Without the right system prompt, the model often writes 'an anonymized person' or '[name redacted]' instead of using the placeholder [[Person-ABC123]]. This makes de-anonymization impossible.

1## CRITICAL RULE: ANONYMIZATION PLACEHOLDERS
2
3THIS IS THE MOST IMPORTANT RULE. VIOLATING IT MAKES YOUR RESPONSE USELESS.
4
5The user's messages contain anonymized placeholders in format [[Type-HASH]]:
6- [[Person-QSEZB6]] = a person's name
7- [[email-BE2966]] = an email address
8- [[iban-5B7BCF]] = a bank account
9- [[telephone_number-F29732]] = a phone number
10- [[Adress-NT9DQE]] = an address
11
12FORBIDDEN:
13- Writing "[Name anonymisiert]" or "[anonymized]"
14- Describing WHAT the placeholder is instead of USING it
15- Inventing NEW [[Type-HASH]] placeholders
16
17REQUIRED:
18- Copy [[Person-QSEZB6]] exactly as-is
19- Write "Herr [[Person-QSEZB6]] hat..." (use it like a real name)
20
21WHY: After your response, placeholders get replaced with real values.
22BEFORE RESPONDING: Check that every [[Placeholder-HASH]] appears exactly as written.

Example request

1curl -X POST https://app.anymize.ai/api/v1/llm-anonymous/chat/completions \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"model": "fountain-1.0",
6    #86efac">"messages": [
7      {#86efac">"role": "user", "content": "Schreibe eine E-Mail an Max Mustermann, max@example.com, wegen dem Termin am 15. Januar."}
8    ],
9    #86efac">"language": "de",
10  }'

Response

The response contains the de-anonymized text and metadata.

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "fountain-1.0",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Sehr geehrter Herr Max Mustermann,\n\nich schreibe Ihnen bezüglich unseres Termins am 15. Januar..."
      },
      "finish_reason": "stop"
    }
  ],
  "_anymize": {
    "anonymized": true,
    "job_id": "job_anon_456def",
    "language": "de"
  }
}

Credit usage

Anonymous chat consumes credits for two services:

• •LLM credits for model usage (same as regular chat).
• •Anonymization credits for PII masking.

Overview

Replace placeholders with original data — reverse the anonymization.

Parameters

Send the anonymized text and job ID to restore the original data.

Example request

1curl -X POST https://app.anymize.ai/api/deanonymize \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"text": "Sehr geehrter [[Person-QSEZB6]], Ihre Adresse [[Adress-NT9DQE]] wurde aktualisiert."
6  }'

Response

The de-anonymized text contains the original data in place of placeholders.

{
  "text": "Sehr geehrter Max Mustermann, Ihre Adresse Berliner Str. 42, 10115 Berlin wurde aktualisiert.",
  "replacements": 2
}

Limitations

• •The job ID must exist and not be expired.
• •The original job must not have been created with ZDR.
• •Only the user who created the job can de-anonymize.

Error cases

Common de-anonymization errors and what they mean.

{
  "error": {
    "message": "No hash pairs found for the given placeholders",
    "type": "not_found_error",
    "code": "hash_pairs_not_found"
  }
}

Endpoint

Retrieve the mapping table between placeholders and original data.

Parameters

Response

The response contains an array of pairs with placeholder and original value.

{
  "job_id": "job_abc123def456",
  "hash_pairs": [
    {
      "original": "Max Mustermann",
      "hash": "[PERSON-1]",
      "prefix_name": "Person",
      "placeholder": "PERSON-1"
    },
    {
      "original": "Berlin",
      "hash": "[LOCATION-1]",
      "prefix_name": "Location",
      "placeholder": "LOCATION-1"
    },
    {
      "original": "Acme GmbH",
      "hash": "[ORGANIZATION-1]",
      "prefix_name": "Organization",
      "placeholder": "ORGANIZATION-1"
    },
    {
      "original": "15.03.1990",
      "hash": "[DATE-1]",
      "prefix_name": "Date",
      "placeholder": "DATE-1"
    },
    {
      "original": "max@example.com",
      "hash": "[EMAIL-1]",
      "prefix_name": "Email",
      "placeholder": "EMAIL-1"
    },
    {
      "original": "+49 170 1234567",
      "hash": "[PHONE-1]",
      "prefix_name": "Phone",
      "placeholder": "PHONE-1"
    }
  ],
  "total": 6
}

Entity types

Placeholders are categorized by type: PERSON, ADDRESS, PHONE, EMAIL, etc.

Restrictions

Example request

1curl https://app.anymize.ai/api/status/job_abc123def456/strings \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Use cases

Typical scenarios where hash pairs are useful:

• •Anonymization quality check — verify what was masked.
• •Partial de-anonymization — replace only specific placeholders.
• •Audit and compliance — document which data was anonymized.