Delete Key

Overview

This endpoint allows for the deletion of a Bre-B Key that was previously created. Deleting a key will update the federated node and synchronize with the centralized node managed by Banco de la Republica.

Information

Once cancelled, keys cannot be reactivated. However, it is possible to recreate them.

Endpoint Details

Definition	Description
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/keys/:key_id
Method	DELETE
Headers	Content-Type: application/json, Authorization
Authentication	Access Token (Bearer Token)

Request Body

No request body

Example Request

curl --location --request DELETE 'https://api.paas.sandbox.co.passportfintech.com/v1/keys/da096c03-890e-4dc4-bffa-e332fa69e3e1' \ --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \

Response Body

HTTP Status Code: 204 No Content.
No response body will be returned.

Common Errors and Handling

HTTP Status Code	Meaning	Description
400 Bad Request	Invalid Data	Required fields are missing or contain incorrect values.
401 Unauthorized	Expired Token	The access token is invalid or has expired.
403 Forbidden	Access Denied	The request is not authorized to delete a Key.
500 Internal Server Error	Server Error	An unexpected error occurred while deleting the Key.

Best Practices

Always include the key identifier in the path parameter.
Treat 204 No Content as a confirmation of success.
Revoke keys immediately if you suspect compromise or misuse.

Last updated on