Consultando Usuarios
Obtener Todos los Usuarios
GET /api/v2/users?type=PERSON
type - PERSON o COMPANYid - ID de usuario específicoexternalId - ID del usuario de tu sistemafirstName, lastName - Búsqueda por nombreemail - Búsqueda por emailcustomerId - Filtrar por clientelimit, page - Paginación
Obtener Usuario por ID
GET /api/v2/users/{userId}
const getUser = async (userId) => {
const response = await fetch(
`https://teste-94u93qnn.uc.gateway.dev/api/v2/users/${userId}`,
{
headers: {
'Authorization': `Bearer ${accessToken}`
}
}
);
return await response.json();
};
Encontrar por ID Externo
GET /api/v2/users?externalId=user-12345
Usa externalId para encontrar rápidamente usuarios por tu ID de usuario interno sin almacenar el ID de usuario de KillB en todos lados.
Actualizando Usuarios
PATCH /api/v2/users/{userId}
{
"type": "PERSON",
"data": {
"email": "[email protected]",
"phone": "+573009876543",
"address": {
"street1": "Nueva Calle 456",
"city": "Medellín",
"state": "Antioquia",
"zipCode": "050001",
"countryCode": "CO"
}
}
}
Cambiar ciertos campos (como número de documento) puede activar re-verificación y establecer temporalmente el estado como PENDING.
Eliminando Usuarios
DELETE /api/v2/users/{userId}
const deleteUser = async (userId) => {
const response = await fetch(
`https://teste-94u93qnn.uc.gateway.dev/api/v2/users/${userId}`,
{
method: 'DELETE',
headers: {
'Authorization': `Bearer ${accessToken}`
}
}
);
if (response.ok) {
console.log('Usuario eliminado exitosamente');
}
};
La eliminación de usuario es una eliminación suave. Los datos del usuario se retienen para cumplimiento pero se marcan como inactivos.
Próximos Pasos
