Listar Clientes
Visión General
Este endpoint permite crear un Cliente (Customer) dentro de la API de Passport proporcionando los datos de identificación necesarios. Una solicitud exitosa retorna el ID del cliente y la información de confirmación del recurso creado.
Detalles del Endpoint
| Parámetro | Descripción |
|---|---|
| Endpoint | https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers |
| Método | GET |
| Encabezados | Content-Type: application/json, Authorization |
| Autenticación | Token de Acceso (Bearer Token) |
Cuerpo de la Solicitud
Este endpoint no requiere cuerpo de solicitud (Request Body).
Ejemplo de Solicitud
2
2
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers' \--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'Cuerpo de la Respuesta
- Código HTTP: 200 OK
Ejemplo de Respuesta
32
32
{ "pagination_info": { "total_elements": 2, "first_request_timestamp": "2025-09-11T12:32:05.618Z", "current_page": 1, "total_pages": 1 }, "customers": [ { "id": "9e7e1545-7c84-40b8-aa7d-e8dc27261179", "mobile_phone_number": "573167224040", "identification_type": "NIT", "identification_number": "607756868", "type": "BUSINESS", "email": "hChN66dr@example.com", "business_name": "Merchant J2QNY", "created_at": "2025-09-10T16:42:37.644Z", "updated_at": "2025-09-10T16:42:37.644Z" }, { "id": "7cb9de1b-d4b4-4036-9b7d-a49104a8f7f9", "mobile_phone_number": "573956158117", "identification_type": "NIT", "identification_number": "187111855", "type": "BUSINESS", "email": "eAqpUh6u@example.com", "business_name": "changing", "created_at": "2025-09-10T16:42:53.38Z", "updated_at": "2025-09-10T22:27:12.191Z" } ]}Errores Comunes y Manejo
| Código HTTP | Significado | Descripción |
|---|---|---|
| 400 | Bad Request | Formato de solicitud inválido. |
| 401 | Unauthorized | Token Bearer ausente, expirado o sin alcance paas.core.entity_customers.list.get. |
| 403 | Forbidden | El solicitante no tiene permisos para listar los clientes. |
| 404 | Not Found | No existen clientes registrados para la entidad. |
| 500 | Server Error | Error inesperado en el servidor; reintente o contacte soporte. |
Buenas Prácticas
- Usa pagination_info para recuperar todos los clientes cuando la lista sea extensa.
- Combina con Obtener Cliente (GET /customers/{id}) para acceder a información detallada de un cliente en particular.
- Implementa conciliaciones periódicas entre los clientes listados en este endpoint y tus sistemas internos para garantizar consistencia.
- Evita exponer directamente datos sensibles como números de identificación o correos electrónicos en logs o interfaces públicas.