Blackline AI REST API

Authentication

Every request needs a Bearer token in the Authorization header. Create keys under /account/api.

Authorization: Bearer blk_live_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx

POST /api/public/v1/detect

Finds all sensitive entities in the text and returns them with their category.

Example request

curl -X POST https://blackline-documents.com/api/public/v1/detect \
  -H "Authorization: Bearer blk_live_xxxxxxxx_..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hallo Max Mustermann, deine IBAN DE89370400440532013000 wurde bestätigt.",
    "categories": ["name", "iban"]
  }'

Response

{
  "entities": [
    { "text": "Max Mustermann", "category": "name" },
    { "text": "DE89370400440532013000", "category": "iban" }
  ]
}

POST /api/public/v1/redact

Detects sensitive data and replaces it inline. Modes: block (█), stars (*), label ([NAME]).

curl -X POST https://blackline-documents.com/api/public/v1/redact \
  -H "Authorization: Bearer blk_live_xxxxxxxx_..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hallo Max Mustermann, deine IBAN DE89370400440532013000 wurde bestätigt.",
    "replacement": "block"
  }'

{
  "redacted_text": "Hallo ██████████████, deine IBAN ██████████████████████ wurde bestätigt.",
  "entities_detected": 2,
  "entities_replaced": [
    { "text": "DE89370400440532013000", "category": "iban", "count": 1 },
    { "text": "Max Mustermann", "category": "name", "count": 1 }
  ]
}

POST /api/public/v1/redact-pdf Private Beta

Accepts a PDF file and responds with HTTP 202 + job id. Poll status via GET /api/public/v1/jobs/{id}. Request early access: contact@blackline-documents.com.

Categories

name, address, phone, email, iban, credit_card, amount, customer_number, contract_number, tax_id, id_number, date_of_birth, company, signature

Errors

• 401 missing_bearer — no Authorization header
• 401 invalid_or_revoked_key — wrong or revoked key
• 403 missing_scope:* — key lacks the required scope
• 400 invalid_input — body fails validation
• 500 ai_error — internal detection failure, retry recommended