Delete Pix Key

Delete a Pix key for a specific user document.

Endpoint

DELETE /partner/v1/pix-key/{document}

Request

Path parameters

Name	Type	Required	Description
document	string	Yes	User’s CPF (tax ID)

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key
Content-Type	string	Yes	application/json

Body

Field	Type	Required	Description
idempotency_key	string (UUID)	Yes	Unique key to prevent duplicate requests

{
  "idempotency_key": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Accepted (202 Accepted)

The deletion request was accepted and is being processed.

{
  "status": "accepted"
}

Already sent (200 OK)

A deletion request was already sent for this key.

{
  "status": "already_sent"
}

Succeeded (200 OK)

The key has already been successfully deleted.

{
  "status": "succeeded"
}

Not found (404 Not Found)

{
  "status": "not_found"
}

Invalid document (400 Bad Request)

{
  "status": "invalid_document"
}

Example

curl -X DELETE https://api.bipa.tech/partner/v1/pix-key/12345678900 \
  -H "X-API-Key: your_partner_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotency_key": "550e8400-e29b-41d4-a716-446655440000"
  }'

Pix key deletion is asynchronous. Monitor the Events endpoint for pix_key events with canceled kind to confirm deletion.