logo

Your first check through the API

Five steps from sign-up to a verdict. Everything here works with a test key, so no real document and no credits are needed until the last step.

  1. 1. Create a free account

    New accounts get 5 free checks, usable in the browser and through the API. Sign up, then open API keys in the dashboard.

  2. 2. Create a test key

    Test keys start with htpbe_test_. They cost nothing, return fixed synthetic results for the sample files at api.htpbe.tech/v1/test/ (such as clean.pdf and modified-high.pdf) and reject any other URL, so you can build and test your handling of every verdict without a real document.

  3. 3. Submit a PDF

    The API takes the URL of a publicly reachable PDF and returns a check ID.

    bash
    curl -X POST https://api.htpbe.tech/v1/analyze \
  -H "Authorization: Bearer htpbe_test_..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://api.htpbe.tech/v1/test/modified-high.pdf"}'
# → { "id": "3f9c8b7a-2e1d-4c5f-9b8e-7a6d5c4b3a21" }

  4. 4. Read the verdict

    The result is intact, modified or inconclusive, plus the named markers behind it. Marker IDs are public and are never renamed, so your code can branch on them.

    bash
    curl https://api.htpbe.tech/v1/result/3f9c8b7a-2e1d-4c5f-9b8e-7a6d5c4b3a21 \
  -H "Authorization: Bearer htpbe_test_..."
# → { "status": "modified", "modification_markers": [...], ... }

  5. 5. Go live

    Create a live key (htpbe_live_) on the same page and send a real PDF URL. Each check uses one credit from the same pool as the browser tool; see pricing for credit packs and subscriptions.

    bash
    curl -X POST https://api.htpbe.tech/v1/analyze \
  -H "Authorization: Bearer htpbe_live_..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/statement.pdf"}'

Full endpoint reference, error codes and a Python client are in the API documentation.

Create A Free Account