Compliance / PIPEDA

Right to erasure: delete all personal data for a phone number

Complies with PIPEDA and Quebec Law 25 right to erasure. Scrubs message bodies and event payloads for the number, and deletes its consent records, verifications, contacts, and webhook dead letters. Deletes its contact-list entries too, except on a DENY list: that entry is kept so the number stays blocked. Opt-out records are kept: CASL requires proof an opt-out was honoured, so this call never deletes one. So is a block HonkIO placed on the number by revoking the upload it came from: erasure does not make its consent recordable again.

Requires compliance:d.

post/v1/compliance/erasure

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/compliance/erasure
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

x-step-up-tokenstring

A token from POST /v1/auth/step-up with the compliance:d scope. Needed when the calling key holds compliance:m but not compliance:d (e.g. the dashboard session key).

Request body

phone_numberstring required
reasonstring

Reason for erasure request (for audit log)

Response

Erased. Opt-out records are kept.

status'erased' required
phone_numberstring required
erased_atstring date-time required
opt_outs_preservedtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.