List Keys
Overview
This endpoint allows you to retrieve a list of all Bre-B key associated with your customers within the Passport API. The response includes key value, type, status, and associated entity details.
Endpoint Details
| Definition | Description |
|---|---|
| Endpoint | https://api.paas.sandbox.co.passportfintech.com/v1/keys |
| Method | GET |
| Headers | Content-Type: application/json, Authorization |
| Authentication | Access Token (Bearer Token) |
Request Body
- No request body
Example Request
2
2
curl --location --request GET 'https://api.paas.sandbox.co.passportfintech.com/v1/keys' \--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \Response Body
- HTTP Status Code: 200 OK.
- The response will contain the list of keys, along with its unique identifiers and details.
Example of Response
21
21
{ "keys": [ { "status": "ACTIVE", "key": { "key_type": "BCODE", "key_value": "0016027228" }, "account_id": "6c23f053-0e1a-46b4-b902-97ba47e351bc", "created_at": "2025-10-09T10:42:39.710Z", "updated_at": "2025-10-09T10:42:39.710Z", "id": "3184cbfd-73bd-4910-bd03-f8461e724247" } ], "pagination_info": { "first_request_timestamp": "2025-10-09T18:02:18.706Z", "current_page": 1, "total_pages": 1, "total_elements": 1 }}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 list the Keys. |
| 500 Internal Server Error | Server Error | An unexpected error occurred sending the request. |