Listar Llaves

Visión General

Este endpoint permite recuperar una lista de todas las Llaves Bre-B asociadas a tus clientes dentro de la API de Passport. La respuesta incluye el valor de la llave, tipo, estado y detalles de la entidad asociada.

Detalles del Endpoint

Parámetro	Descripción
Endpoint	https://api.paas.sandbox.co.passportfintech.com/v1/keys
Método	GET
Encabezados	Content-Type: application/json, Authorization
Autenticación	Access Token (Bearer Token)

Parámetros de Consulta

Parámetros de Paginación

Parámetro	Descripción
page_params.page_size	Cantidad de registros a retornar por página.
page_params.page_number	Número de página a consultar.
page_params.first_request_timestamp.seconds	Segundos UTC desde Unix epoch (`1970-01-01T00:00:00Z`). Debe estar entre `0001-01-01T00:00:00Z` y `9999-12-31T23:59:59Z`(inclusive).
page_params.first_request_timestamp.nanos	Fracción en nanosegundos (0 a 999,999,999). Debe ser un valor no negativo y representa la fracción de segundo con resolución de nanosegundos.

Parámetros de Ordenamiento

Parámetro	Descripción
order_params.order_key	Campo utilizado para ordenar los resultados.
order_params.order_direction	Dirección del ordenamiento. Valores permitidos: `ORDER_DIRECTION_ENUM_UNSPECIFIED`, `ASC`, `DESC`.

Filtros de Llaves

Parámetro	Descripción
customer_id	Filtra por el identificador del cliente asociado a la llave.
account_id	Filtra por el identificador de la cuenta asociada a la llave.
key_type	Filtra por el tipo de llave (por ejemplo, teléfono, correo electrónico, documento, etc., según los valores soportados).
key_id	Filtra por el identificador único de la llave.
status	Filtra por el estado de la llave (por ejemplo, activa o suspendida).
key_value	Filtra por el valor de la llave.

Cuerpo de la Solicitud

No se requiere cuerpo en la solicitud para este endpoint.

Ejemplo de Solicitud

JSON
    
 
curl --location --request GET 'https://api.paas.sandbox.co.passportfintech.com/v1/keys' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
Copy

Cuerpo de la Respuesta

Código HTTP: 200 OK.
La respuesta contendrá la lista de llaves, junto con sus identificadores únicos y detalles.

Ejemplo de Respuesta

JSON
    
 
{
    "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
    }
}
Copy

Errores comunes y Manejo


400 Bad Request	Datos Inválidos	Faltan campos requeridos o contienen valores incorrectos.
401 Unauthorized	Token Expirado	El token de acceso es inválido o ha expirado.
403 Forbidden	Acceso Denegado	La solicitud no está autorizada para listar las Llaves.
500 Internal Server Error	Error del Servidor	La solicitud no está autorizada para listar las Llaves.

Última actualización el