HonkIOHonkIO

Référence de l’API

Conformité / LPRPDE

Conformité en matière de protection de la vie privée et droit à l’effacement.

post/v1/compliance/erasure

Droit à l’effacement : supprimer toutes les données personnelles liées à un numéro de téléphone

Permissioncompliance:d

Conforme au droit à l’effacement prévu par la LPRPDE et la Loi 25 du Québec. Efface le corps des messages et les charges utiles des événements liés au numéro, et supprime ses enregistrements de consentement, ses vérifications, ses contacts et ses lettres mortes de webhook. Supprime aussi ses entrées de listes de contacts, sauf dans une liste DENY : cette entrée est conservée pour que le numéro reste bloqué. Les enregistrements de désabonnement sont conservés : la LCAP exige la preuve qu’un désabonnement a été respecté, donc cet appel n’en supprime jamais.

Nécessite compliance:d.

Paramètres

ParamètreTypeDescription
X-Step-Up-Tokenen-têtestring

Un jeton obtenu par POST /v1/auth/step-up avec la portée compliance:d. Nécessaire lorsque la clé appelante détient compliance:m mais pas compliance:d (p. ex. la clé de session du tableau de bord).

Corps de la requête

ChampTypeDescription
phone_numberobligatoirestring
reasonstring

Motif de la demande d’effacement (pour le journal d’audit)

  • Au plus 1000 caractères

Réponses

  • 200Effacé. Les enregistrements de désabonnement sont conservés.
    ChampTypeDescription
    statusobligatoirestring
    • Une valeur parmi : erased
    phone_numberobligatoirestring
    erased_atobligatoirestring
    • Format : date-time
    opt_outs_preservedobligatoireboolean
    • Une valeur parmi : true
  • 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
  • 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
  • 403FORBIDDEN (la clé n’a pas l’autorisation compliance:d et n’a envoyé aucun jeton de confirmation compliance:d) ou LIVE_KEY_REQUIRED (les clés de test ne peuvent pas effacer).Le corps d’erreur standard.
  • 422INVALID_PHONE_NUMBER, CANNOT_ERASE_OWN_NUMBER ou VALIDATION_ERROR.Le corps d’erreur standard.
  • 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
  • 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

cURL
curl -X POST https://api.honkio.ca/v1/compliance/erasure \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1613XXXXXXX"
  }'