Delete a Pix key

​

Deletes a Pix key from the DICT. The key must belong to the requesting participant.

Path Parameters
  • key
    Type: string
    required

    Pix key value to delete (CPF, CNPJ, phone, email, or EVP)

Query Parameters
  • reason
    Type: string enum
    required

    Reason for the key deletion

    Reason for the key operation (creation, update, or deletion)

    values
    • USER_REQUESTED
    • RECONCILIATION
    • ACCOUNT_CLOSURE
    • BRANCH_TRANSFER
    • FRAUD
    • DEFAULT_OPERATION
    • RFB_VALIDATION
Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for delete/api/v1/keys/{key}
curl 'http://localhost/api/v1/keys/{key}?reason=USER_REQUESTED' \
  --request DELETE \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "scheduleId": "string",
  "requestId": "string",
  "operationType": "CREATE",
  "status": "PENDING",
  "message": "string",
  "createdAt": "2026-09-16T19:14:18.843Z"
}

Operation accepted and scheduled. Vsync is currently active.