Consultando Usuários
Obter Todos os Usuários
GET /api/v2/users?type=PERSON
type - PERSON ou COMPANYid - ID de usuário específicoexternalId - ID do usuário do seu sistemafirstName, lastName - Busca por nomeemail - Busca por emailcustomerId - Filtrar por clientelimit, page - Paginação
Obter Usuário 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
Use externalId para encontrar rapidamente usuários pelo seu ID de usuário interno sem armazenar o ID de usuário da KillB em todos os lugares.
Atualizando Usuários
PATCH /api/v2/users/{userId}
{
"type": "PERSON",
"data": {
"email": "[email protected]",
"phone": "+5511987654321",
"address": {
"street1": "Nova Rua 456",
"city": "São Paulo",
"state": "SP",
"zipCode": "01234-567",
"countryCode": "BR"
}
}
}
Alterar certos campos (como número de documento) pode acionar re-verificação e definir temporariamente o status como PENDING.
Excluindo Usuários
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('Usuário excluído com sucesso');
}
};
A exclusão de usuário é uma exclusão suave. Os dados do usuário são retidos para conformidade mas marcados como inativos.
Próximos Passos
