HelpFraud · Documentation développeur

Connectez votre serveur à l’API Business HelpFraud.

Clés d’API OpenAPI 3.0.3 Nouveaux domaines

Authorization · BUSINESS

Envoyez Authorization: Bearer hf_live_example. Ce n’est pas une vraie clé. Gardez les clés sur votre serveur, jamais dans un navigateur ou une URL.

Les clés authentifient vos requêtes envoyées à l’API HelpFraud. La clé complète n’est affichée qu’une seule fois.

4,99 $US / Mensuel

Vos vérifications

Utilisez input et éventuellement type. Les endpoints dédiés choisissent leur analyseur. Indicateurs de risque, pas preuve de fraude ; aucun fournisseur externe connecté.

Bulk accepte 1–50 éléments. Chacun consomme une unité API mensuelle. Les erreurs sont renvoyées par élément. Limite : 256 Kio par requête.

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'

Limite de débit

Business : 60 unités par minute glissante et 5 000 unités par mois civil. Erreurs : error.code, error.message, error.request_id. 429 inclut 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

Nouveaux domaines · Alertes

Les domaines proviennent de vrais agrégats publics. Première observation ne signifie pas date d’enregistrement. Les alertes appartiennent au propriétaire de la clé.

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