Cancel Bre-B Key
Overview
This endpoint revokes (cancels) a previously issued Bre-B Key. Once canceled, the key can no longer be used to authorize transactions or operations associated with the customer’s account.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts/keys/{key_id} |
| Method | DELETE |
| Headers | Accept-Language, Content-Length, Content-Type: application/json, Authorization |
| Authentication | Access Token (Bearer Token) |
Request Body
| Field | Type | Description |
|---|---|---|
| id | String | Unique identifier of the Bre-B Key to be deleted. |
Example Request
6
curl --location --request DELETE 'https://bre-b-develop.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts/keys/b0b0a96d-ac4b-43ec-a802-a4e2221d87d0' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer <YOUR_ACCES_TOKEN>' \--data '{ "id": "b0b0a96d-ac4b-43ec-a802-a4e2221d87d0"}'Response
- HTTP Status Code 200 OK.
There is no response body returned on success.
Common Errors and Handling
| HTTP Status Code | Meaning | Description |
|---|---|---|
| 400 | Bad Request | Malformed or missing id in path/body |
| 401 | Unauthorized | Missing/expired bearer token, or token lacks key cancellation scope |
| 403 | Forbidden | Caller does not have permission to cancel this key |
| 404 | Not Found | The key with the given id does not exist or has already been canceled |
| 500 | Server Error | Unexpected error; retry or contact support |
Best Practices
- Always include the key identifier in both the path and the request body to ensure consistency.
- Treat
200 OKas a confirmation of success. - Revoke keys immediately if you suspect compromise or misuse.