Turnover
O serviço de Turnover retorna dados sobre a rotatividade profissional da entidade consultada, com foco em aspectos temporais e qualitativos.
Quando usar
Descrição
O serviço de Turnover fornece informações agregadas de dados relacionados à rotatividade profissional da entidade consultada, enfatizando características temporais e qualitativas.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/pessoas/turnover
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CPF da pessoa, com ou sem máscara. |
{
"document": "000.000.000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
AvgYearsBetweenProfessionalTurnover |
texto |
MaxYearsBetweenProfessionalTurnover |
texto |
MinYearsBetweenProfessionalTurnover |
texto |
TotalProfessionalTurnover |
número |
TotalProfessionalTurnoverIn15Years |
número |
TotalProfessionalTurnoverIn10Years |
número |
TotalProfessionalTurnoverIn5Years |
número |
CompaniesWorkedFor[] |
texto |
AgeOfFirstJob |
número |
FirstJobAdmissionDate |
data |
IsCurrentlyEmployed |
booleano |
IsEntrepeneur |
booleano |
HasWorkedInPublicSector |
booleano |
HasWorkedInPrivateSector |
booleano |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Turnover",
"query_slug": "turnover",
"data": {
"AvgYearsBetweenProfessionalTurnover": "texto",
"MaxYearsBetweenProfessionalTurnover": "texto",
"MinYearsBetweenProfessionalTurnover": "texto",
"TotalProfessionalTurnover": 0,
"TotalProfessionalTurnoverIn15Years": 0,
"TotalProfessionalTurnoverIn10Years": 0,
"TotalProfessionalTurnoverIn5Years": 0,
"CompaniesWorkedFor": [
"texto"
],
"AgeOfFirstJob": 0,
"FirstJobAdmissionDate": "2026-01-01",
"IsCurrentlyEmployed": false,
"IsEntrepeneur": false,
"HasWorkedInPublicSector": false,
"HasWorkedInPrivateSector": false
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.100"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido