Test API keys let you build and test your integration without using real PDF files, consuming credits, or incurring any charges. The behavior is modeled after Stripe's test cards — every test URL returns a deterministic, predefined response.
Every account has one test API key. Test and live keys share the same format but differ in prefix:
| Key type | Format | Example |
|---|---|---|
| Live key | htpbe_live_... |
htpbe_live_abc123… |
| Test key | htpbe_test_... |
htpbe_test_xyz789… |
Test keys are stored separately from live keys and cannot be used interchangeably.
- Log in and go to htpbe.tech/dashboard/api-keys
- Your test key is displayed at the top of the page in the Test API Key section — it is always visible, no extra steps required
- Click the copy icon next to the key to copy it to the clipboard
The key is auto-generated the first time you open the page. You can regenerate it at any time by clicking Regenerate Key — the old key stops working immediately.
Test keys can only be used with mock URLs at https://api.htpbe.tech/v1/test/. Passing any other URL — including real PDFs, Vercel Blob URLs, or localhost — returns a 403 error:
{
"error": "Test API keys can only be used with test URLs. See documentation for available test URLs.",
"code": "test_url_required",
"details": "Use URLs like: https://api.htpbe.tech/v1/test/clean.pdf, https://api.htpbe.tech/v1/test/modified-high.pdf, etc."
}The server does not make any network request to the test URL. It matches the filename against a built-in response table and returns the predefined result instantly. This means:
- No PDF hosting is needed
- No external dependency that could go down
Test requests never consume credits.
A test key accepts the Idempotency-Key header but does not act on it. Nothing is charged, and the same test URL always returns the same synthetic id, so there is nothing for the key to protect: a test request never returns 409 idempotency_key_in_progress or 422 idempotency_key_fingerprint_mismatch. Exercise those paths against a live key.
POST /analyze with a test key returns a deterministic UUID v4 id based on the test filename. Like Stripe's 4242 4242 4242 4242 test card number that passes real card format validation, these IDs pass UUID v4 format validation while being obviously synthetic (all-zeros pattern with sequential last bytes):
| Test URL | Returned id |
|---|---|
.../test/clean.pdf |
00000000-0000-4000-8000-000000000001 |
.../test/clean-no-dates.pdf |
00000000-0000-4000-8000-000000000002 |
.../test/modified-low.pdf |
00000000-0000-4000-8000-000000000003 |
.../test/modified-medium.pdf |
00000000-0000-4000-8000-000000000004 |
.../test/modified-high.pdf |
00000000-0000-4000-8000-000000000005 |
.../test/modified-critical.pdf |
00000000-0000-4000-8000-000000000006 |
.../test/dates-mismatch.pdf |
00000000-0000-4000-8000-000000000007 |
.../test/dates-same.pdf |
00000000-0000-4000-8000-000000000008 |
.../test/incremental-updates.pdf |
00000000-0000-4000-8000-000000000009 |
.../test/multiple-xref.pdf |
00000000-0000-4000-8000-00000000000a |
.../test/signature-valid.pdf |
00000000-0000-4000-8000-00000000000b |
.../test/signature-removed.pdf |
00000000-0000-4000-8000-00000000000c |
.../test/modified-after-sign.pdf |
00000000-0000-4000-8000-00000000000d |
.../test/javascript.pdf |
00000000-0000-4000-8000-00000000000e |
.../test/embedded-files.pdf |
00000000-0000-4000-8000-00000000000f |
.../test/both-threats.pdf |
00000000-0000-4000-8000-000000000010 |
.../test/inconclusive.pdf |
00000000-0000-4000-8000-000000000011 |
.../test/date-sequence-invalid.pdf |
00000000-0000-4000-8000-000000000012 |
.../test/outdated-version.pdf |
00000000-0000-4000-8000-000000000013 |
.../test/inconclusive-online-editor.pdf |
00000000-0000-4000-8000-000000000014 |
.../test/scanned-document.pdf |
00000000-0000-4000-8000-000000000015 |
Because the ID is deterministic, you can hardcode it in your tests without calling POST /analyze first.
GET /api/v1/result/{id} works with synthetic IDs — but only when called with a test key. Passing a synthetic test ID with a live key returns 404, and a test key used with any id that isn't one of the synthetic ids — including a real check id created by the same account with a live key — also returns 404: test keys never resolve real checks. This lets you test the complete two-step flow:
POST /analyze→{ "id": "00000000-0000-4000-8000-000000000005" }GET /result/00000000-0000-4000-8000-000000000005→ full synthetic result
Test requests do not create checks. Synthetic results never appear in your check history or in GET /checks, and no credits are consumed. Synthetic IDs are recognized by the server and resolved to predefined data on every request.
The same test URL always returns the same result fields, regardless of how many times you call it or which account you use. check_date is always null for synthetic results — test responses have no real analysis timestamp. Do not assert on check_date in automated tests.
Step 1: Submit for analysis
curl -X POST https://api.htpbe.tech/v1/analyze \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://api.htpbe.tech/v1/test/modified-high.pdf"}'Response:
{
"id": "00000000-0000-4000-8000-000000000005"
}Step 2: Retrieve the full result
curl https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000005 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY"Response:
{
"id": "00000000-0000-4000-8000-000000000005",
"filename": "modified-high.pdf",
"check_date": null,
"file_size": 1048576,
"algorithm_version": "X.Y.Z",
"current_algorithm_version": "X.Y.Z",
"status": "modified",
"creation_date": 1704067200,
"modification_date": 1710528300,
"creator": "Adobe Acrobat Pro DC",
"creator_truncated": false,
"producer": "PDFtk Server 2.02",
"producer_truncated": false,
"modification_confidence": "high",
"date_sequence_valid": true,
"metadata_completeness_score": 75,
"xref_count": 4,
"has_incremental_updates": true,
"update_chain_length": 5,
"pdf_version": "1.7",
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false,
"page_count": 12,
"object_count": 480,
"has_javascript": false,
"has_embedded_files": false,
"modification_markers": ["HTPBE_EDITING_TOOL_FINGERPRINT"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}Note: check_date is always null for synthetic test results — do not assert on it in tests.
Test-key results always carry a numeric xref_count and a boolean has_incremental_updates. Live results can return null for both, when the number of revisions in the file could not be established, or was not recorded for this check (older records), so handle null even though test keys never return it.
Note:
X.Y.Zstands in for a real version number. For synthetic results,algorithm_versionandcurrent_algorithm_versionboth return the current algorithm version (exceptoutdated-version.pdf) — see the changelog.
Since IDs are deterministic, you can skip Step 1 and call GET /result/00000000-0000-4000-8000-000000000005 directly in your tests.
All test URLs live at https://api.htpbe.tech/v1/test/. Any other URL (including files you host yourself) will be rejected when using a test key.
Use these to test how your application handles documents that pass verification.
| URL | status |
Notes |
|---|---|---|
https://api.htpbe.tech/v1/test/clean.pdf |
intact |
Typical original document — full creator/producer metadata, no modification date |
https://api.htpbe.tech/v1/test/clean-no-dates.pdf |
intact |
Original document — metadata dates absent (e.g. auto-generated PDF) |
https://api.htpbe.tech/v1/test/signature-valid.pdf |
intact |
Digitally signed, no post-sign modifications |
Use these to test how your application handles the case where integrity check is not applicable — PDFs created with office/consumer software, processed through online editors, or scanned from paper cannot be verified.
The live API can also return
status: "inconclusive"with five furtherstatus_reasonvalues —unverifiable_metadata,filled_form_origin,fill_sign_origin,visible_signature_origin, andanalysis_incomplete(see result.md for the full enum). These origins depend on structural traits that the synthetic mock flow cannot reproduce, so there are no dedicated test URLs for them. Handle everyinconclusivereason with the same fallback path — do not branch on the exact reason string.
| URL | status |
Notes |
|---|---|---|
https://api.htpbe.tech/v1/test/dates-same.pdf |
inconclusive |
LibreOffice origin — status_reason: "consumer_software_origin" |
https://api.htpbe.tech/v1/test/inconclusive.pdf |
inconclusive |
Microsoft Excel origin — status_reason: "consumer_software_origin" |
https://api.htpbe.tech/v1/test/inconclusive-online-editor.pdf |
inconclusive |
iLovePDF origin — status_reason: "online_editor_origin", metadata stripped by service |
https://api.htpbe.tech/v1/test/scanned-document.pdf |
inconclusive |
Scanned document — status_reason: "scanned_document" |
Use these to test conditional logic and UI states for modified documents. Branch on status, modification_confidence and modification_markers — the API has no separate severity field.
| URL | status |
modification_confidence |
modification_markers |
Other fields to note |
|---|---|---|---|---|
https://api.htpbe.tech/v1/test/modified-low.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
— |
https://api.htpbe.tech/v1/test/modified-medium.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
— |
https://api.htpbe.tech/v1/test/multiple-xref.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
— |
https://api.htpbe.tech/v1/test/incremental-updates.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
— |
https://api.htpbe.tech/v1/test/embedded-files.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
has_embedded_files: true |
https://api.htpbe.tech/v1/test/javascript.pdf |
modified |
high |
HTPBE_MULTIPLE_REVISION_LAYERS |
has_javascript: true |
https://api.htpbe.tech/v1/test/modified-high.pdf |
modified |
high |
HTPBE_EDITING_TOOL_FINGERPRINT |
— |
https://api.htpbe.tech/v1/test/dates-mismatch.pdf |
modified |
certain |
HTPBE_DATES_DISAGREE |
— |
https://api.htpbe.tech/v1/test/modified-after-sign.pdf |
modified |
certain |
HTPBE_POST_SIGNATURE_EDIT |
has_digital_signature: true, modifications_after_signature: true |
https://api.htpbe.tech/v1/test/signature-removed.pdf |
modified |
certain |
HTPBE_SIGNATURE_REMOVED |
signature_removed: true |
https://api.htpbe.tech/v1/test/modified-critical.pdf |
modified |
certain |
HTPBE_SIGNATURE_REMOVED |
signature_removed: true, has_javascript: true |
https://api.htpbe.tech/v1/test/both-threats.pdf |
modified |
certain |
HTPBE_SIGNATURE_REMOVED |
signature_removed: true, has_javascript: true, has_embedded_files: true |
Use these to test fields that require specific scenarios not covered by the standard mocks.
| URL | Key field | Notes |
|---|---|---|
https://api.htpbe.tech/v1/test/date-sequence-invalid.pdf |
date_sequence_valid: false |
Modification date is before creation date — impossible in normal workflow, indicates tampering |
https://api.htpbe.tech/v1/test/outdated-version.pdf |
outdated_warning present |
Analyzed with algorithm version 1.0.0 — triggers outdated_warning in the result |
Use these to test error-handling paths. Unlike mock result URLs, these return an error response from POST /analyze directly — they have no check ID and cannot be used with GET /result/{id}.
| URL | HTTP Status | code |
Notes |
|---|---|---|---|
https://api.htpbe.tech/v1/test/trigger-402.pdf |
402 |
payment_required |
Synthetic trigger for the out-of-credits path. A test key never debits credits, so this URL is the only way to exercise the 402 response with a test key. |
Verify that your integration correctly handles the two-step flow.
# Step 1: Submit for analysis — returns a synthetic UUID
curl -s -X POST https://api.htpbe.tech/v1/analyze \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://api.htpbe.tech/v1/test/clean.pdf"}'
# → { "id": "00000000-0000-4000-8000-000000000001" }
# Step 2: Retrieve the full result using the synthetic ID
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000001 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" | jq .What to verify:
POST /analyzereturns{ "id": "00000000-0000-4000-8000-000000000001" }— no analysis datastatusis"intact"modification_markersis an empty array[]creation_dateis non-nullusage_caution.recommended_actionis"no_action"
The API returns three possible status values. Since IDs are deterministic, you can call GET /result/{id} directly without submitting via POST /analyze first:
# intact
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000001 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '.status'
# → "intact"
# modified
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000005 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '.status'
# → "modified"
# inconclusive (consumer software origin)
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000011 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '.status, .status_reason, .producer'
# → "inconclusive"
# → "consumer_software_origin"
# → "Microsoft: Print To PDF"
# inconclusive (online editor origin)
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000014 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '.status, .status_reason, .producer'
# → "inconclusive"
# → "online_editor_origin"
# → "iLovePDF"
# inconclusive (scanned document)
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000015 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '.status, .status_reason, .producer'
# → "inconclusive"
# → "scanned_document"
# → nullTest how your code handles each modification_confidence value:
modification_confidence |
Test URL |
|---|---|
none |
https://api.htpbe.tech/v1/test/clean.pdf |
high |
https://api.htpbe.tech/v1/test/modified-low.pdf, https://api.htpbe.tech/v1/test/modified-high.pdf |
certain |
https://api.htpbe.tech/v1/test/dates-mismatch.pdf, https://api.htpbe.tech/v1/test/signature-removed.pdf, https://api.htpbe.tech/v1/test/both-threats.pdf |
# Valid signature — should not trigger alerts
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-00000000000b \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '{has_digital_signature, signature_count, signature_removed, modifications_after_signature}'Expected:
{
"has_digital_signature": true,
"signature_count": 1,
"signature_removed": false,
"modifications_after_signature": false
}# Removed signature — critical alert
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-00000000000c \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '{has_digital_signature, signature_count, signature_removed, modifications_after_signature}'Expected:
{
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": true,
"modifications_after_signature": false
}Test that your UI handles JavaScript and embedded file warnings:
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000010 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '{has_javascript, has_embedded_files, modification_markers}'Expected:
{
"has_javascript": true,
"has_embedded_files": true,
"modification_markers": ["HTPBE_SIGNATURE_REMOVED"]
}Not all PDFs contain full metadata. Verify your application handles null values gracefully:
curl -s https://api.htpbe.tech/v1/result/00000000-0000-4000-8000-000000000002 \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
| jq '{creation_date, modification_date, creator, producer}'Expected:
{
"creation_date": null,
"modification_date": null,
"creator": null,
"producer": null
}Verify that your integration correctly handles the error returned when a test key is used with a non-test URL.
curl -s -X POST https://api.htpbe.tech/v1/analyze \
-H "Authorization: Bearer htpbe_test_YOUR_TEST_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com/invoice.pdf"}'Expected HTTP status: 403
{
"error": "Test API keys can only be used with test URLs. See documentation for available test URLs.",
"code": "test_url_required",
"details": "Use URLs like: https://api.htpbe.tech/v1/test/clean.pdf, https://api.htpbe.tech/v1/test/modified-high.pdf, etc."
}Some error codes and edge cases cannot be triggered by the normal test mock flow but have dedicated workarounds:
| Scenario | How to test |
|---|---|
402 payment_required |
Use https://api.htpbe.tech/v1/test/trigger-402.pdf — a test key never debits credits, so this synthetic trigger is the only way to reach the 402 code path with a test key |
403 inactive_client |
Not reachable through the test mocks. It is returned for a live key that has been deactivated, and for any key — live or test — whose account has been disabled. There is no synthetic trigger: handle it as a non-retryable authentication failure |
outdated_warning field |
Use https://api.htpbe.tech/v1/test/outdated-version.pdf — this mock returns algorithm_version: "1.0.0", which triggers outdated_warning in the response |
date_sequence_valid: false |
Use https://api.htpbe.tech/v1/test/date-sequence-invalid.pdf — modification date is set before creation date |
metadata_completeness_score ranges |
Test mocks return a variety of scores (0–80). See the metadata_completeness_score column in the full response reference below for per-mock values |
const BASE_URL = 'https://api.htpbe.tech/v1';
const TEST_KEY = process.env.HTPBE_TEST_KEY; // htpbe_test_...
async function analyzeAndGetResult(filename: string) {
// Step 1: Submit for analysis
const analyzeRes = await fetch(`${BASE_URL}/analyze`, {
method: 'POST',
headers: {
Authorization: `Bearer ${TEST_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({ url: `${BASE_URL}/test/${filename}` }),
});
if (!analyzeRes.ok) {
const error = await analyzeRes.json();
throw new Error(`Analyze error ${analyzeRes.status}: ${error.error}`);
}
const { id } = await analyzeRes.json(); // e.g. "00000000-0000-4000-8000-000000000001"
// Step 2: Retrieve the full result
const resultRes = await fetch(`${BASE_URL}/result/${id}`, {
headers: { Authorization: `Bearer ${TEST_KEY}` },
});
if (!resultRes.ok) {
const error = await resultRes.json();
throw new Error(`Result error ${resultRes.status}: ${error.error}`);
}
return resultRes.json();
}
// Test all three verdict branches
const original = await analyzeAndGetResult('clean.pdf');
console.assert(original.status === 'intact');
const tampered = await analyzeAndGetResult('signature-removed.pdf');
console.assert(tampered.status === 'modified');
console.assert(tampered.signature_removed === true);
const inconclusive = await analyzeAndGetResult('inconclusive.pdf');
console.assert(inconclusive.status === 'inconclusive');
console.assert(inconclusive.status_reason === 'consumer_software_origin');
const onlineEditor = await analyzeAndGetResult('inconclusive-online-editor.pdf');
console.assert(onlineEditor.status === 'inconclusive');
console.assert(onlineEditor.status_reason === 'online_editor_origin');
console.assert(onlineEditor.producer === 'iLovePDF');
const scanned = await analyzeAndGetResult('scanned-document.pdf');
console.assert(scanned.status === 'inconclusive');
console.assert(scanned.status_reason === 'scanned_document');
// Since IDs are deterministic you can skip POST and call GET directly:
const result = await fetch(`${BASE_URL}/result/00000000-0000-4000-8000-000000000001`, {
headers: { Authorization: `Bearer ${TEST_KEY}` },
}).then((r) => r.json());
console.assert(result.status === 'intact');import os
import requests
BASE_URL = "https://api.htpbe.tech/v1"
TEST_KEY = os.getenv("HTPBE_TEST_KEY") # htpbe_test_...
def analyze_and_get_result(filename: str) -> dict:
# Step 1: Submit for analysis
analyze_res = requests.post(
f"{BASE_URL}/analyze",
headers={
"Authorization": f"Bearer {TEST_KEY}",
"Content-Type": "application/json",
},
json={"url": f"{BASE_URL}/test/{filename}"},
)
analyze_res.raise_for_status()
check_id = analyze_res.json()["id"] # e.g. "00000000-0000-4000-8000-000000000001"
# Step 2: Retrieve the full result
result_res = requests.get(
f"{BASE_URL}/result/{check_id}",
headers={"Authorization": f"Bearer {TEST_KEY}"},
)
result_res.raise_for_status()
return result_res.json()
# Test intact document
result = analyze_and_get_result("clean.pdf")
assert result["status"] == "intact"
# Test critical tampering
result = analyze_and_get_result("both-threats.pdf")
assert result["status"] == "modified"
assert result["has_javascript"] is True
# Test inconclusive (consumer software)
result = analyze_and_get_result("inconclusive.pdf")
assert result["status"] == "inconclusive"
assert result["status_reason"] == "consumer_software_origin"
assert result["creator"] == "Microsoft Excel 2019"
# Test inconclusive (online editor)
result = analyze_and_get_result("inconclusive-online-editor.pdf")
assert result["status"] == "inconclusive"
assert result["status_reason"] == "online_editor_origin"
assert result["producer"] == "iLovePDF"
# Test inconclusive (scanned document)
result = analyze_and_get_result("scanned-document.pdf")
assert result["status"] == "inconclusive"
assert result["status_reason"] == "scanned_document"{
"error": "Test API keys can only be used with test URLs. See documentation for available test URLs.",
"code": "test_url_required"
}Fix: Use one of the URLs listed in the Available Test URLs table, or switch to your live key.
Synthetic check IDs are only accessible with a test key. Calling GET /api/v1/result/00000000-0000-4000-8000-000000000001 with a live key returns 404:
{
"error": "Check not found or access denied",
"code": "not_found"
}Fix: Use your test key when retrieving synthetic test results. Keep test and live keys in separate environments.
Test keys never resolve real checks. Calling GET /api/v1/result/{id} with a test key and a real check id — even one created by the same account with a live key — returns 404:
{
"error": "Check not found or access denied",
"code": "not_found"
}The same applies to GET /api/v1/checks: a test key always returns data: [] and total: 0, never your real check history.
Fix: Use your live key to retrieve real checks and check history. Test keys are for exercising the integration flow only.
Live keys download and analyze the URL as a real file. Passing https://api.htpbe.tech/v1/test/clean.pdf with a live key will attempt to download a file that does not exist and return a 400 download error.
Fix: Test URLs only work with test keys. Keep the two environments separate.
Use this list before switching from test to live keys:
- Application handles
status: "intact"(original document) - Application handles
status: "modified"at low, medium, and high risk - Application handles
status: "inconclusive"withstatus_reason: "consumer_software_origin"and thecreator/producertool displayed to the user - Application handles
status: "inconclusive"withstatus_reason: "online_editor_origin"(online editor, metadata stripped) - Application handles
status: "inconclusive"withstatus_reason: "scanned_document"(scanned document) - Application falls back gracefully on any other
status_reason—unverifiable_metadata,filled_form_origin,fill_sign_origin,visible_signature_origin,analysis_incomplete— without branching on the exact string (these are not reproducible via test URLs) - UI displays
modification_markersarray items clearly - Code handles
nullvalues increation_dateandmodification_date - Code handles empty
modification_markersarray -
signature_removed: truetriggers a visible alert -
has_javascript: truetriggers a visible warning - 403 errors are surfaced to the user (not silently swallowed)
- API key is stored in environment variables, not hardcoded
Every test URL returns a deterministic result accessible via GET /api/v1/result/{id}. Synthetic results are not stored as checks and never appear in GET /checks; they are accessible at any time with a test key.
The field values below show what each fixture returns. The JSON is formatted with nested groupings for readability — this nesting does not exist in the real API response. The actual GET /result/{id} response is a flat object with all fields at the top level.
Formatting differences between the tables below and the real API response:
metadata,structure,signatures,threats— these groupings are display-only. In the real response, all fields (creator,has_incremental_updates,has_digital_signature, etc.) are at the top level.- Date fields (
creation_date,modification_date) — shown as ISO 8601 strings below for readability. The real response returns Unix timestamps (integer, seconds since epoch), e.g.1704067200. - Additional fields present in the real response but omitted here for brevity:
check_date,algorithm_version,current_algorithm_version,date_sequence_valid,metadata_completeness_score.
See GET /result for the complete flat schema with exact field types.
URL: https://api.htpbe.tech/v1/test/clean.pdf
ID: 00000000-0000-4000-8000-000000000001
Original document, no modifications.
{
"status": "intact",
"metadata": {
"creation_date": "2024-01-15T10:00:00.000Z",
"modification_date": null,
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 524288
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "no_action",
"message": "No modification was detected. This is not a guarantee of authenticity — do not use this verdict as the sole basis for a consequential decision."
}
}URL: https://api.htpbe.tech/v1/test/clean-no-dates.pdf
ID: 00000000-0000-4000-8000-000000000002
Original document, metadata dates absent (common in auto-generated PDFs).
{
"status": "intact",
"metadata": {
"creation_date": null,
"modification_date": null,
"creator": null,
"producer": null,
"file_size": 102400
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.4"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "no_action",
"message": "No modification was detected. This is not a guarantee of authenticity — do not use this verdict as the sole basis for a consequential decision."
}
}URL: https://api.htpbe.tech/v1/test/dates-same.pdf
ID: 00000000-0000-4000-8000-000000000008
LibreOffice origin — integrity check not applicable.
{
"status": "inconclusive",
"status_reason": "consumer_software_origin",
"metadata": {
"creation_date": "2024-03-01T12:00:00.000Z",
"modification_date": "2024-03-01T12:00:00.000Z",
"creator": "LibreOffice 7.0",
"producer": "LibreOffice 7.0",
"file_size": 245760
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.4"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "request_from_issuer",
"message": "The check could not confirm this document’s integrity, which is not proof of fraud. Confirm the content directly with the issuing organisation or route it to human review — do not treat inconclusive as an automatic rejection."
}
}URL: https://api.htpbe.tech/v1/test/inconclusive.pdf
ID: 00000000-0000-4000-8000-000000000011
Microsoft Excel origin — integrity check not applicable.
{
"status": "inconclusive",
"status_reason": "consumer_software_origin",
"metadata": {
"creation_date": "2024-03-01T09:00:00.000Z",
"modification_date": "2024-03-01T09:00:00.000Z",
"creator": "Microsoft Excel 2019",
"producer": "Microsoft: Print To PDF",
"file_size": 204800
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "request_from_issuer",
"message": "The check could not confirm this document’s integrity, which is not proof of fraud. Confirm the content directly with the issuing organisation or route it to human review — do not treat inconclusive as an automatic rejection."
}
}URL: https://api.htpbe.tech/v1/test/inconclusive-online-editor.pdf
ID: 00000000-0000-4000-8000-000000000014
iLovePDF origin — processed through an online editing service, metadata stripped.
{
"status": "inconclusive",
"status_reason": "online_editor_origin",
"metadata": {
"creation_date": null,
"modification_date": null,
"creator": null,
"producer": "iLovePDF",
"file_size": 312000
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "request_from_issuer",
"message": "The check could not confirm this document’s integrity, which is not proof of fraud. Confirm the content directly with the issuing organisation or route it to human review — do not treat inconclusive as an automatic rejection."
}
}URL: https://api.htpbe.tech/v1/test/scanned-document.pdf
ID: 00000000-0000-4000-8000-000000000015
Scanned document. Anyone can print and scan a document.
{
"status": "inconclusive",
"status_reason": "scanned_document",
"metadata": {
"creation_date": null,
"modification_date": null,
"creator": null,
"producer": null,
"file_size": 890000
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.4"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "request_from_issuer",
"message": "The check could not confirm this document’s integrity, which is not proof of fraud. Confirm the content directly with the issuing organisation or route it to human review — do not treat inconclusive as an automatic rejection."
}
}URL: https://api.htpbe.tech/v1/test/signature-valid.pdf
ID: 00000000-0000-4000-8000-00000000000b
Digitally signed, no post-sign modifications.
{
"status": "intact",
"metadata": {
"creation_date": "2024-03-05T10:00:00.000Z",
"modification_date": null,
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 1125000
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": true,
"signature_count": 1,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "no_action",
"message": "No modification was detected. This is not a guarantee of authenticity — do not use this verdict as the sole basis for a consequential decision."
}
}URL: https://api.htpbe.tech/v1/test/dates-mismatch.pdf
ID: 00000000-0000-4000-8000-000000000007
status: modified, marker HTPBE_DATES_DISAGREE.
{
"status": "modified",
"metadata": {
"creation_date": "2024-02-01T10:00:00.000Z",
"modification_date": "2024-02-15T14:30:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 655360
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 2,
"xref_count": 2,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_DATES_DISAGREE"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/modified-low.pdf
ID: 00000000-0000-4000-8000-000000000003
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS.
{
"status": "modified",
"metadata": {
"creation_date": "2024-01-15T10:00:00.000Z",
"modification_date": "2024-01-15T11:30:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 545000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 2,
"xref_count": 2,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/modified-medium.pdf
ID: 00000000-0000-4000-8000-000000000004
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS.
{
"status": "modified",
"metadata": {
"creation_date": "2024-01-10T08:00:00.000Z",
"modification_date": "2024-02-05T14:20:00.000Z",
"creator": "Microsoft Word",
"producer": "Adobe PDF Library 15.0",
"file_size": 780000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 3,
"xref_count": 3,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/multiple-xref.pdf
ID: 00000000-0000-4000-8000-00000000000a
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS.
{
"status": "modified",
"metadata": {
"creation_date": "2024-02-10T11:00:00.000Z",
"modification_date": "2024-02-11T09:00:00.000Z",
"creator": "Acrobat PDFMaker 20",
"producer": "Adobe PDF Library 15.0",
"file_size": 712000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 4,
"xref_count": 4,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/incremental-updates.pdf
ID: 00000000-0000-4000-8000-000000000009
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS.
{
"status": "modified",
"metadata": {
"creation_date": "2024-01-20T09:00:00.000Z",
"modification_date": "2024-01-20T15:00:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 890000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 6,
"xref_count": 5,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/embedded-files.pdf
ID: 00000000-0000-4000-8000-00000000000f
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS, has_embedded_files: true.
{
"status": "modified",
"metadata": {
"creation_date": "2024-03-12T14:00:00.000Z",
"modification_date": "2024-03-12T15:30:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 2450000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 2,
"xref_count": 2,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": true },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/javascript.pdf
ID: 00000000-0000-4000-8000-00000000000e
status: modified, marker HTPBE_MULTIPLE_REVISION_LAYERS, has_javascript: true.
{
"status": "modified",
"metadata": {
"creation_date": "2024-03-10T10:00:00.000Z",
"modification_date": "2024-03-10T11:00:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 456000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 2,
"xref_count": 2,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": true, "has_embedded_files": false },
"modification_markers": ["HTPBE_MULTIPLE_REVISION_LAYERS"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/modified-high.pdf
ID: 00000000-0000-4000-8000-000000000005
status: modified, marker HTPBE_EDITING_TOOL_FINGERPRINT.
{
"status": "modified",
"metadata": {
"creation_date": "2024-01-01T00:00:00.000Z",
"modification_date": "2024-03-15T18:45:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "PDFtk Server 2.02",
"file_size": 1048576
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 5,
"xref_count": 4,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_EDITING_TOOL_FINGERPRINT"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/modified-after-sign.pdf
ID: 00000000-0000-4000-8000-00000000000d
status: modified, marker HTPBE_POST_SIGNATURE_EDIT, modifications_after_signature: true.
{
"status": "modified",
"metadata": {
"creation_date": "2024-02-01T09:00:00.000Z",
"modification_date": "2024-02-10T14:00:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 1340000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 4,
"xref_count": 3,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": true,
"signature_count": 1,
"signature_removed": false,
"modifications_after_signature": true
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_POST_SIGNATURE_EDIT"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/signature-removed.pdf
ID: 00000000-0000-4000-8000-00000000000c
status: modified, marker HTPBE_SIGNATURE_REMOVED, signature_removed: true.
{
"status": "modified",
"metadata": {
"creation_date": "2024-01-10T10:00:00.000Z",
"modification_date": "2024-02-20T16:30:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 980000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 3,
"xref_count": 3,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": true,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_SIGNATURE_REMOVED"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/modified-critical.pdf
ID: 00000000-0000-4000-8000-000000000006
status: modified, marker HTPBE_SIGNATURE_REMOVED, signature_removed: true, has_javascript: true.
{
"status": "modified",
"metadata": {
"creation_date": "2023-12-01T10:00:00.000Z",
"modification_date": "2024-04-01T22:15:00.000Z",
"creator": "Microsoft Excel",
"producer": "iText 5.5.13",
"file_size": 2097152
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 8,
"xref_count": 6,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": true,
"modifications_after_signature": false
},
"threats": { "has_javascript": true, "has_embedded_files": false },
"modification_markers": ["HTPBE_SIGNATURE_REMOVED"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/both-threats.pdf
ID: 00000000-0000-4000-8000-000000000010
status: modified, marker HTPBE_SIGNATURE_REMOVED, signature_removed: true, has_javascript: true, has_embedded_files: true.
{
"status": "modified",
"metadata": {
"creation_date": "2024-02-15T10:00:00.000Z",
"modification_date": "2024-03-01T16:00:00.000Z",
"creator": null,
"producer": "iText 5.5.13",
"file_size": 3100000
},
"structure": {
"has_incremental_updates": true,
"update_chain_length": 7,
"xref_count": 5,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": true,
"modifications_after_signature": false
},
"threats": { "has_javascript": true, "has_embedded_files": true },
"modification_markers": ["HTPBE_SIGNATURE_REMOVED"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}URL: https://api.htpbe.tech/v1/test/date-sequence-invalid.pdf
ID: 00000000-0000-4000-8000-000000000012
status: modified, marker HTPBE_DATES_DISAGREE. The modification date is earlier than the creation date.
{
"status": "modified",
"metadata": {
"creation_date": "2024-05-01T12:00:00.000Z",
"modification_date": "2024-03-01T08:00:00.000Z",
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 512000
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": ["HTPBE_DATES_DISAGREE"],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "route_to_human_review",
"message": "Structural evidence of post-creation modification was found. Route this document to a human reviewer before any decision — do not use this verdict as the sole basis for an automatic adverse decision against a person."
}
}Key field: date_sequence_valid: false (omitted from the display-only grouping above but present in the real flat response).
URL: https://api.htpbe.tech/v1/test/outdated-version.pdf
ID: 00000000-0000-4000-8000-000000000013
Analyzed with algorithm version 1.0.0 — triggers outdated_warning in the result.
{
"status": "intact",
"metadata": {
"creation_date": "2023-06-01T10:00:00.000Z",
"modification_date": null,
"creator": "Adobe Acrobat Pro DC",
"producer": "Adobe PDF Library 15.0",
"file_size": 430080
},
"structure": {
"has_incremental_updates": false,
"update_chain_length": 1,
"xref_count": 1,
"pdf_version": "1.7"
},
"signatures": {
"has_digital_signature": false,
"signature_count": 0,
"signature_removed": false,
"modifications_after_signature": false
},
"threats": { "has_javascript": false, "has_embedded_files": false },
"modification_markers": [],
"usage_caution": {
"safe_for_automated_adverse_decision": false,
"recommended_action": "no_action",
"message": "No modification was detected. This is not a guarantee of authenticity — do not use this verdict as the sole basis for a consequential decision."
}
}Key field: algorithm_version: "1.0.0" (older than current) — the real response includes outdated_warning with a human-readable message recommending re-analysis.
- POST /api/v1/analyze — Full request/response reference
- GET /api/v1/result/{id} — Retrieve analysis results (live key and test key)
- GET /api/v1/checks — List all checks with filtering