HelpFraud · Developer documentation

Connect your server to the HelpFraud Business API.

Authorization · BUSINESS

Send Authorization: Bearer hf_live_example. The example is not a real key. Keep keys on your server; never in a browser or URL.

Keys authenticate your requests to the HelpFraud API. The full key is shown only once.

$4.99 / Monthly

Your checks

Use input and optional type. Fixed endpoints select their named checker. Responses contain risk indicators, not proof of fraud; external providers are not connected.

Bulk accepts 1–50 items. Each item consumes one monthly API unit. Row errors are returned separately. Bodies are limited to 256 KiB.

POST/api/v1/check

curl -X POST 'https://helpfraud.com/api/v1/check' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"https://example.com","type":"WEBSITE"}'

POST/api/v1/check/url

curl -X POST 'https://helpfraud.com/api/v1/check/url' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"https://example.com"}'

POST/api/v1/check/message

curl -X POST 'https://helpfraud.com/api/v1/check/message' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"Please verify this message."}'

POST/api/v1/check/email

curl -X POST 'https://helpfraud.com/api/v1/check/email' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"support@example.com"}'

POST/api/v1/check/phone

curl -X POST 'https://helpfraud.com/api/v1/check/phone' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"input":"+442079460123"}'

POST/api/v1/check/bulk

curl -X POST 'https://helpfraud.com/api/v1/check/bulk' \
  -H 'Authorization: Bearer hf_live_example' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"input":"https://example.com","type":"WEBSITE"}]}'

GET/api/v1/domain/{domain}

curl 'https://helpfraud.com/api/v1/domain/{domain}' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/domains/recent

curl 'https://helpfraud.com/api/v1/domains/recent' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/alerts

curl 'https://helpfraud.com/api/v1/alerts' -H 'Authorization: Bearer hf_live_example'

GET/api/v1/openapi.json

curl 'https://helpfraud.com/api/v1/openapi.json'

Rate limit

Business: 60 units per rolling minute and 5,000 units per calendar month. Errors use error.code, error.message and error.request_id. A 429 includes retry-after.

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "API request limit exceeded.",
    "request_id": "example-request-id"
  }
}

INVALID_REQUEST: 400
INVALID_INPUT: 400
INVALID_API_KEY: 401
PLAN_UPGRADE_REQUIRED: 403
FORBIDDEN: 403
NOT_FOUND: 404
CONFLICT: 409
PAYLOAD_TOO_LARGE: 413
UNSUPPORTED_MEDIA_TYPE: 415
RATE_LIMIT_EXCEEDED: 429
DATABASE_UNAVAILABLE: 503
INTERNAL_ERROR: 500

New domains · Alerts

Domains come only from real public-safe aggregates. First observed is not registration date. Alerts belong only to the key owner.

limit: 1–200 · page: 1–10,000 · since: ISO 8601 · unread: true/false