HelpFraud · Ontwikkelaarsdocumentatie

Verbind uw server met de HelpFraud Business API.

API-sleutels OpenAPI 3.0.3 Nieuwe domeinen

Authorization · BUSINESS

Stuur Authorization: Bearer hf_live_example. Dit is geen echte sleutel. Bewaar sleutels op uw server, nooit in een browser of URL.

Sleutels authenticeren je verzoeken aan de HelpFraud API. De volledige sleutel wordt maar één keer getoond.

US$ 4,99 / Maandelijks

Jouw controles

Gebruik input en optioneel type. Vaste endpoints kiezen hun controle. Dit zijn risicosignalen, geen bewijs van fraude; externe aanbieders zijn niet verbonden.

Bulk accepteert 1–50 items. Elk verbruikt één maandelijkse API-eenheid. Fouten worden per item teruggegeven. Maximaal 256 KiB per verzoek.

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'

Snelheidslimiet

Business: 60 eenheden per voortschrijdende minuut en 5.000 eenheden per kalendermaand. Fouten: error.code, error.message, error.request_id. 429 bevat 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

Nieuwe domeinen · Waarschuwingen

Domeinen komen uit echte publieke aggregaten. Eerste waarneming is geen registratiedatum. Meldingen behoren alleen aan de sleuteleigenaar.

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