Activate Key
Overview
This endpoint is used to reactivate a previously suspended Bre-B key, restoring its active status.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts/keys/activate |
| Method | PATCH |
| Headers | Content-Type: application/json, Authorization |
| Authentication | Access Token (Bearer Token) |
Request Body
| Field | Type | Description |
|---|---|---|
| id | String | The unique identifier of the key to activate. |
Example Request
x
1
1
Response
- HTTP Status Code: 200 OK.
- The response will contain the key status:
ACTV(Active)
Example of Response
3
3
{ "key_status": "ACTV"}Common Errors and Handling
| HTTP Status Code | Meaning | Description |
|---|---|---|
| 400 | Bad Request | Missing or invalid id field |
| 401 | Unauthorized | Missing or invalid bearer token |
| 403 | Forbidden | Insufficient scope or access rights |
| 404 | Not Found | Key with given id does not exist |
Best Practices
- Refresh OAuth tokens before they expire to avoid authentication failures.
- Validate input data before sending to reduce 400 Errors.