{"openapi":"3.1.0","info":{"title":"Kivo RH — API pública","version":"1.0.0","description":"API de integração do Kivo RH. Cada chave pertence a um cliente (grupo) e só enxerga os dados dele.\n\nAutenticação: `Authorization: Bearer kv_…` (ou header `x-kivo-api-key`).\n\nLimite: 120 chamadas por minuto por chave; acima disso, 429 com Retry-After: 60.\n\nListas: `{ cliente, pagina, por_pagina, total, dados }`, até 100 por página. Erros: `{ erro, mensagem, detalhes? }`.\n\nCorpo JSON até 256 KB (7 MB na criação de documento de assinatura). Escritas aceitam `Idempotency-Key`.\n\nWebhooks: novas tentativas em 1 min, 5 min, 30 min, 2 h, 6 h, 12 h e 24 h; o webhook é desativado após 50 falhas seguidas e 3 dias sem sucesso.\n\nEscopos: `empresas:read` (Empresas e filiais do cliente, com códigos e CNPJ.); `pessoas:read` (Pessoas, vínculos e estrutura (cargos, departamentos, locais), sem dados sensíveis.); `pessoas:write` (Admitir, atualizar, movimentar, desligar e reativar); `dados_sensiveis:read` (CPF, RG, PIS, CTPS, nascimento, endereço, raça/cor e deficiência (eSocial) e salário); `dados_bancarios:read` (Banco, agência, conta e Pix); `epi:read` (Itens de EPI e entregas registradas.); `epi:write` (Registrar entregas de EPI para colaboradores.); `assinaturas:read` (Modelos, documentos, situação das assinaturas e arquivos PDF.); `assinaturas:write` (Criar e enviar documentos, cancelar, lembrar e gerar links de assinatura.); `recrutamento:read` (Vagas e candidaturas.); `eventos:read` (Fila de eventos do cliente (os mesmos enviados por webhook).).","contact":{"name":"Suporte Kivo RH","email":"suporte@kivorh.com.br","url":"https://kivorh.com.br"}},"servers":[{"url":"https://app.kivorh.com.br/api/public/v1"}],"security":[{"bearer":[]}],"tags":[{"name":"Diagnóstico"},{"name":"Empresas"},{"name":"Estrutura"},{"name":"Pessoas"},{"name":"Colaboradores"},{"name":"EPI"},{"name":"Assinaturas"},{"name":"Recrutamento"},{"name":"Eventos"}],"paths":{"/ping":{"get":{"tags":["Diagnóstico"],"summary":"Valida a chave e mostra cliente, responsável e escopos","operationId":"getPing","x-kivo-escopo":null,"parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/openapi.json":{"get":{"tags":["Diagnóstico"],"summary":"Esta especificação","operationId":"getOpenapiJson","security":[],"x-kivo-escopo":null,"parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}}}}},"/empresas":{"get":{"tags":["Empresas"],"summary":"Empresas e filiais do cliente","operationId":"getEmpresas","x-kivo-escopo":"empresas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/cargos":{"get":{"tags":["Estrutura"],"summary":"Lista cargos do grupo","operationId":"getCargos","x-kivo-escopo":"pessoas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/departamentos":{"get":{"tags":["Estrutura"],"summary":"Lista departamentos do grupo","operationId":"getDepartamentos","x-kivo-escopo":"pessoas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/centros-custo":{"get":{"tags":["Estrutura"],"summary":"Lista centros de custo do grupo","operationId":"getCentrosCusto","x-kivo-escopo":"pessoas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/locais":{"get":{"tags":["Estrutura"],"summary":"Lista locais do grupo","operationId":"getLocais","x-kivo-escopo":"pessoas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/equipes":{"get":{"tags":["Estrutura"],"summary":"Lista equipes do grupo","operationId":"getEquipes","x-kivo-escopo":"pessoas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pessoas":{"get":{"tags":["Pessoas"],"summary":"Lista pessoas do grupo","operationId":"getPessoas","x-kivo-escopo":"pessoas:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"situacao","in":"query","required":false,"schema":{"type":"string","description":"Situação da pessoa","enum":["ativa","inativa","todas"]}},{"name":"busca","in":"query","required":false,"schema":{"type":"string","description":"Busca por nome"}},{"name":"cpf","in":"query","required":false,"schema":{"type":"string","description":"CPF (exige o escopo dados_sensiveis:read)"}},{"name":"atualizado_desde","in":"query","required":false,"schema":{"type":"string","description":"Somente registros alterados desde (ISO 8601)","format":"date-time"}},{"name":"ordem","in":"query","required":false,"schema":{"type":"string","description":"Ordenação","enum":["nome","atualizado_em"]}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/pessoas/{id}":{"get":{"tags":["Pessoas"],"summary":"Obtém uma pessoa","operationId":"getPessoasId","x-kivo-escopo":"pessoas:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"patch":{"tags":["Pessoas"],"summary":"Atualiza contato e endereço da pessoa","operationId":"patchPessoasId","x-kivo-escopo":"pessoas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PessoaAtualizar"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores":{"get":{"tags":["Colaboradores"],"summary":"Lista vínculos (colaboradores)","operationId":"getColaboradores","x-kivo-escopo":"pessoas:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"empresa_id","in":"query","required":false,"schema":{"type":"string","description":"Empresa (matriz ou filial) do grupo","format":"uuid"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Situação do registro"}},{"name":"cargo_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"departamento_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"pessoa_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"matricula","in":"query","required":false,"schema":{"type":"string","description":"Matrícula"}},{"name":"cpf","in":"query","required":false,"schema":{"type":"string","description":"CPF (exige o escopo dados_sensiveis:read)"}},{"name":"busca","in":"query","required":false,"schema":{"type":"string","description":"Busca por nome"}},{"name":"atualizado_desde","in":"query","required":false,"schema":{"type":"string","description":"Somente registros alterados desde (ISO 8601)","format":"date-time"}},{"name":"ordem","in":"query","required":false,"schema":{"type":"string","description":"Ordenação","enum":["nome","atualizado_em"]}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"post":{"tags":["Colaboradores"],"summary":"Admite um colaborador","operationId":"postColaboradores","x-kivo-escopo":"pessoas:write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColaboradorAdmitir"}}}},"responses":{"201":{"description":"Criado","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito com o estado atual (ex.: segundo vínculo não confirmado)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores/{id}":{"get":{"tags":["Colaboradores"],"summary":"Obtém um vínculo","operationId":"getColaboradoresId","x-kivo-escopo":"pessoas:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"patch":{"tags":["Colaboradores"],"summary":"Atualiza dados do vínculo","operationId":"patchColaboradoresId","x-kivo-escopo":"pessoas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ColaboradorAtualizar"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores/{id}/movimentacoes":{"post":{"tags":["Colaboradores"],"summary":"Registra movimentação","operationId":"postColaboradoresIdMovimentacoes","x-kivo-escopo":"pessoas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Movimentacao"}}}},"responses":{"201":{"description":"Criado","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores/{id}/desligamento":{"post":{"tags":["Colaboradores"],"summary":"Desliga o colaborador","operationId":"postColaboradoresIdDesligamento","x-kivo-escopo":"pessoas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Desligamento"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/colaboradores/{id}/reativacao":{"post":{"tags":["Colaboradores"],"summary":"Reativa um vínculo desligado","operationId":"postColaboradoresIdReativacao","x-kivo-escopo":"pessoas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reativacao"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/epi/itens":{"get":{"tags":["EPI"],"summary":"Itens de EPI","operationId":"getEpiItens","x-kivo-escopo":"epi:read","parameters":[{"name":"busca","in":"query","required":false,"schema":{"type":"string","description":"Busca por nome"}},{"name":"ativo","in":"query","required":false,"schema":{"type":"string","description":"Filtrar itens ativos","enum":["true","false","todos"]}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/epi/entregas":{"get":{"tags":["EPI"],"summary":"Entregas de EPI","operationId":"getEpiEntregas","x-kivo-escopo":"epi:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"empresa_id","in":"query","required":false,"schema":{"type":"string","description":"Empresa (matriz ou filial) do grupo","format":"uuid"}},{"name":"colaborador_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"pessoa_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Situação do registro"}},{"name":"data_de","in":"query","required":false,"schema":{"type":"string","description":"Data inicial","format":"date"}},{"name":"data_ate","in":"query","required":false,"schema":{"type":"string","description":"Data final","format":"date"}},{"name":"atualizado_desde","in":"query","required":false,"schema":{"type":"string","description":"Somente registros alterados desde (ISO 8601)","format":"date-time"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"post":{"tags":["EPI"],"summary":"Registra entrega de EPI","operationId":"postEpiEntregas","x-kivo-escopo":"epi:write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntregaEpi"}}}},"responses":{"201":{"description":"Criado","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/epi/entregas/{id}":{"get":{"tags":["EPI"],"summary":"Obtém uma entrega","operationId":"getEpiEntregasId","x-kivo-escopo":"epi:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/modelos":{"get":{"tags":["Assinaturas"],"summary":"Modelos de documento","operationId":"getAssinaturasModelos","x-kivo-escopo":"assinaturas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/consumo":{"get":{"tags":["Assinaturas"],"summary":"Franquia de documentos do mês","operationId":"getAssinaturasConsumo","x-kivo-escopo":"assinaturas:read","parameters":[],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Franquia"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos":{"get":{"tags":["Assinaturas"],"summary":"Documentos de assinatura","operationId":"getAssinaturasDocumentos","x-kivo-escopo":"assinaturas:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Situação do registro"}},{"name":"colaborador_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"pessoa_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"empresa_id","in":"query","required":false,"schema":{"type":"string","description":"Empresa (matriz ou filial) do grupo","format":"uuid"}},{"name":"modelo_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"origem","in":"query","required":false,"schema":{"type":"string","description":"Origem do documento","enum":["manual","epi","admissao","lote","api"]}},{"name":"criado_de","in":"query","required":false,"schema":{"type":"string","description":"Criado a partir de","format":"date"}},{"name":"criado_ate","in":"query","required":false,"schema":{"type":"string","description":"Criado até","format":"date"}},{"name":"atualizado_desde","in":"query","required":false,"schema":{"type":"string","description":"Somente registros alterados desde (ISO 8601)","format":"date-time"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}},"post":{"tags":["Assinaturas"],"summary":"Cria e envia um documento para assinatura","operationId":"postAssinaturasDocumentos","x-kivo-escopo":"assinaturas:write","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentoCriar"}}}},"responses":{"201":{"description":"Criado","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos/{id}":{"get":{"tags":["Assinaturas"],"summary":"Obtém um documento","operationId":"getAssinaturasDocumentosId","x-kivo-escopo":"assinaturas:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos/{id}/cancelamento":{"post":{"tags":["Assinaturas"],"summary":"Cancela o documento","operationId":"postAssinaturasDocumentosIdCancelamento","x-kivo-escopo":"assinaturas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Motivo"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos/{id}/lembretes":{"post":{"tags":["Assinaturas"],"summary":"Envia lembrete agora","operationId":"postAssinaturasDocumentosIdLembretes","x-kivo-escopo":"assinaturas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":200},"description":"Repetir a mesma chave com o mesmo corpo devolve a resposta original (header Idempotent-Replayed: true)."}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Requisição com a mesma Idempotency-Key em andamento","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos/{id}/links":{"post":{"tags":["Assinaturas"],"summary":"Gera link de assinatura","operationId":"postAssinaturasDocumentosIdLinks","x-kivo-escopo":"assinaturas:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkAssinatura"}}}},"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/assinaturas/documentos/{id}/arquivo":{"get":{"tags":["Assinaturas"],"summary":"Baixa o PDF (final ou original)","operationId":"getAssinaturasDocumentosIdArquivo","x-kivo-escopo":"assinaturas:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"versao","in":"query","required":false,"schema":{"type":"string","description":"Versão do arquivo","enum":["final","original"],"default":"final"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"},"x-kivo-sha256":{"schema":{"type":"string"},"description":"SHA-256 do arquivo"}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"404":{"description":"Registro não encontrado no grupo da chave","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"409":{"description":"Conflito com o estado atual (ex.: segundo vínculo não confirmado)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/recrutamento/vagas":{"get":{"tags":["Recrutamento"],"summary":"Vagas","operationId":"getRecrutamentoVagas","x-kivo-escopo":"recrutamento:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Situação do registro"}},{"name":"atualizado_desde","in":"query","required":false,"schema":{"type":"string","description":"Somente registros alterados desde (ISO 8601)","format":"date-time"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/recrutamento/candidaturas":{"get":{"tags":["Recrutamento"],"summary":"Candidaturas","operationId":"getRecrutamentoCandidaturas","x-kivo-escopo":"recrutamento:read","parameters":[{"name":"pagina","in":"query","required":false,"schema":{"type":"integer","description":"Página (a partir de 1)","minimum":1,"default":1}},{"name":"por_pagina","in":"query","required":false,"schema":{"type":"integer","description":"Itens por página","minimum":1,"maximum":100,"default":50}},{"name":"vaga_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","description":"Situação do registro"}},{"name":"desde","in":"query","required":false,"schema":{"type":"string","description":"Candidaturas desde (ISO 8601)","format":"date-time"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lista"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}},"/eventos":{"get":{"tags":["Eventos"],"summary":"Eventos do cliente em ordem (mesmos do webhook)","operationId":"getEventos","x-kivo-escopo":"eventos:read","parameters":[{"name":"apos","in":"query","required":false,"schema":{"type":"string","description":"Cursor: devolve eventos depois deste id (ex.: evt_123)"}},{"name":"limite","in":"query","required":false,"schema":{"type":"integer","description":"Máximo de eventos","minimum":1,"maximum":500,"default":100}},{"name":"tipos","in":"query","required":false,"schema":{"type":"string","description":"Tipos de evento separados por vírgula"}}],"responses":{"200":{"description":"OK","headers":{"x-kivo-request-id":{"schema":{"type":"string","format":"uuid"},"description":"Id da requisição (informe ao suporte)"},"x-ratelimit-limit":{"schema":{"type":"integer"},"description":"Chamadas por minuto"},"x-ratelimit-remaining":{"schema":{"type":"integer"},"description":"Chamadas restantes no minuto"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Eventos"}}}},"401":{"description":"Chave ausente, inválida, expirada, revogada ou responsável sem acesso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"403":{"description":"A chave não tem o escopo exigido ou o módulo não está ativo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"422":{"description":"Dados inválidos","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"429":{"description":"Limite de chamadas por minuto excedido (header Retry-After: 60)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}},"500":{"description":"Erro interno","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Erro"}}}}}}}},"webhooks":{"colaborador.admitido":{"post":{"summary":"Novo vínculo cadastrado (admissão), por tela, importação ou API.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.admitido","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo","data_admissao":"2026-09-01","origem_cadastro":"api"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"colaborador.atualizado":{"post":{"summary":"Dados do vínculo alterados. Traz só os nomes dos campos alterados.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.atualizado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo","campos":["cargo_id","departamento_id"]}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"colaborador.movimentado":{"post":{"summary":"Movimentação aplicada: promoção, reajuste, transferência, jornada, afastamento.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.movimentado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"movimentacao_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","tipo":"promocao","data_efeito":"2026-10-01","contrato_id":"00000000-0000-0000-0000-000000000000"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"colaborador.desligado":{"post":{"summary":"Vínculo desligado.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.desligado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"desligado","data_desligamento":"2026-09-30","categoria":"sem_justa_causa"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"colaborador.reativado":{"post":{"summary":"Vínculo desligado voltou a ficar ativo.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.reativado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"colaborador.excluido":{"post":{"summary":"Vínculo excluído (cadastrado por engano).","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"colaborador.excluido","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"pessoa.criada":{"post":{"summary":"Pessoa nova no cadastro do grupo.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"pessoa.criada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"pessoa_id":"00000000-0000-0000-0000-000000000000","nome":"Maria Souza","situacao":"ativa","origem_cadastro":"api"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"pessoa.atualizada":{"post":{"summary":"Dados pessoais alterados. Traz só os nomes dos campos alterados.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"pessoa.atualizada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"pessoa_id":"00000000-0000-0000-0000-000000000000","nome":"Maria Souza","situacao":"ativa","campos":["telefone","endereco_cep"]}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.enviado":{"post":{"summary":"Documento enviado para assinatura.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.enviado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","status":"enviado","status_anterior":"rascunho","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","origem":"manual","lote_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.assinado":{"post":{"summary":"Um signatário assinou (colaborador, testemunha ou empresa).","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.assinado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","colaborador_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","signatario":{"id":"00000000-0000-0000-0000-000000000000","papel":"colaborador","funcao":null,"nome":"Maria Souza","assinado_em":"2026-09-28T12:00:00Z"}}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.concluido":{"post":{"summary":"Todos assinaram e o PDF final com selo está disponível.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.concluido","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","status":"concluido","status_anterior":"aguardando_empresa","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","origem":"manual","lote_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.recusado":{"post":{"summary":"Um signatário recusou o documento.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.recusado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","status":"recusado","status_anterior":"enviado","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","origem":"manual","lote_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.cancelado":{"post":{"summary":"Documento cancelado pelo RH ou pela API.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.cancelado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","status":"cancelado","status_anterior":"enviado","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","origem":"manual","lote_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"documento.expirado":{"post":{"summary":"Prazo de assinatura encerrado sem todas as assinaturas.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"documento.expirado","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"documento_id":"00000000-0000-0000-0000-000000000000","codigo_verificacao":"KV-7F3A-92C1","titulo":"Contrato de trabalho","status":"expirado","status_anterior":"enviado","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","modelo_id":"00000000-0000-0000-0000-000000000000","origem":"manual","lote_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"epi.entrega.registrada":{"post":{"summary":"Entrega de EPI registrada.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"epi.entrega.registrada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"entrega_id":"00000000-0000-0000-0000-000000000000","codigo":"EPI-000123","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","tipo":"entrega","data_entrega":"2026-09-28","status":"registrada","assinado":false}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"epi.entrega.assinada":{"post":{"summary":"Ficha da entrega assinada.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"epi.entrega.assinada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"entrega_id":"00000000-0000-0000-0000-000000000000","codigo":"EPI-000123","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","tipo":"entrega","data_entrega":"2026-09-28","status":"registrada","assinado":true}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"epi.entrega.cancelada":{"post":{"summary":"Entrega de EPI cancelada.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"epi.entrega.cancelada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"entrega_id":"00000000-0000-0000-0000-000000000000","codigo":"EPI-000123","empresa_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","tipo":"entrega","data_entrega":"2026-09-28","status":"cancelada","assinado":false}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"epi.devolucao.registrada":{"post":{"summary":"Devolução de um item de EPI registrada.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"epi.devolucao.registrada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"entrega_id":"00000000-0000-0000-0000-000000000000","entrega_codigo":"EPI-000123","entrega_item_id":"00000000-0000-0000-0000-000000000000","epi_item_id":"00000000-0000-0000-0000-000000000000","colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","quantidade":1,"devolvido_em":"2026-09-28T12:00:00Z","destino":"descarte"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"recrutamento.vaga.criada":{"post":{"summary":"Vaga criada.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"recrutamento.vaga.criada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"vaga_id":"00000000-0000-0000-0000-000000000000","numero":42,"titulo":"Analista de DP","status":"rascunho","status_anterior":null,"empresa_id":"00000000-0000-0000-0000-000000000000"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"recrutamento.vaga.atualizada":{"post":{"summary":"Situação da vaga mudou (aberta, fechada, rascunho).","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"recrutamento.vaga.atualizada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"vaga_id":"00000000-0000-0000-0000-000000000000","numero":42,"titulo":"Analista de DP","status":"aberta","status_anterior":"rascunho","empresa_id":"00000000-0000-0000-0000-000000000000"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"recrutamento.candidatura.criada":{"post":{"summary":"Nova candidatura em uma vaga.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"recrutamento.candidatura.criada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"candidatura_id":"00000000-0000-0000-0000-000000000000","vaga_id":"00000000-0000-0000-0000-000000000000","candidato_id":"00000000-0000-0000-0000-000000000000","etapa_id":"00000000-0000-0000-0000-000000000000","status":"em_andamento","status_anterior":null,"etapa_anterior_id":null}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"recrutamento.candidatura.atualizada":{"post":{"summary":"Candidatura mudou de etapa ou de situação (inclusive contratado).","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"recrutamento.candidatura.atualizada","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"candidatura_id":"00000000-0000-0000-0000-000000000000","vaga_id":"00000000-0000-0000-0000-000000000000","candidato_id":"00000000-0000-0000-0000-000000000000","etapa_id":"00000000-0000-0000-0000-000000000000","status":"em_andamento","status_anterior":"em_andamento","etapa_anterior_id":"00000000-0000-0000-0000-000000000000"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}},"webhook.teste":{"post":{"summary":"Enviado só pelo botão de teste do webhook.","parameters":[{"name":"Kivo-Evento","in":"header","schema":{"type":"string"}},{"name":"Kivo-Evento-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Entrega-Id","in":"header","schema":{"type":"string"}},{"name":"Kivo-Tentativa","in":"header","schema":{"type":"integer"}},{"name":"Kivo-Assinatura","in":"header","schema":{"type":"string"},"description":"t=,v1=; v1 = HMAC-SHA256(segredo inteiro do webhook, incluindo o prefixo whsec_, sobre `${t}.${corpo bruto}`)"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventoWebhook"},"example":{"id":"evt_1024","tipo":"webhook.teste","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"mensagem":"Teste de webhook do Kivo RH","webhook_id":"00000000-0000-0000-0000-000000000000","webhook_nome":"ERP"}}}}},"responses":{"2XX":{"description":"Recebido. Qualquer outro status (ou 3xx, ou mais de 10 s) conta como falha."}}}}},"x-kivo-escopos":[{"id":"empresas:read","rotulo":"Ler empresas","descricao":"Empresas e filiais do cliente, com códigos e CNPJ.","grupo":"Empresas","modulo":null},{"id":"pessoas:read","rotulo":"Ler pessoas e colaboradores","descricao":"Pessoas, vínculos e estrutura (cargos, departamentos, locais), sem dados sensíveis.","grupo":"Pessoas","modulo":"colaboradores"},{"id":"pessoas:write","rotulo":"Gravar pessoas e colaboradores","descricao":"Admitir, atualizar, movimentar, desligar e reativar","grupo":"Pessoas","modulo":"colaboradores"},{"id":"dados_sensiveis:read","rotulo":"Ler dados sensíveis","descricao":"CPF, RG, PIS, CTPS, nascimento, endereço, raça/cor e deficiência (eSocial) e salário","grupo":"Dados sensíveis","modulo":"colaboradores"},{"id":"dados_bancarios:read","rotulo":"Ler dados bancários","descricao":"Banco, agência, conta e Pix","grupo":"Dados sensíveis","modulo":"colaboradores"},{"id":"epi:read","rotulo":"Ler EPI","descricao":"Itens de EPI e entregas registradas.","grupo":"EPI","modulo":"epi"},{"id":"epi:write","rotulo":"Registrar entregas de EPI","descricao":"Registrar entregas de EPI para colaboradores.","grupo":"EPI","modulo":"epi"},{"id":"assinaturas:read","rotulo":"Ler assinaturas","descricao":"Modelos, documentos, situação das assinaturas e arquivos PDF.","grupo":"Assinaturas","modulo":"assinatura"},{"id":"assinaturas:write","rotulo":"Enviar documentos para assinatura","descricao":"Criar e enviar documentos, cancelar, lembrar e gerar links de assinatura.","grupo":"Assinaturas","modulo":"assinatura"},{"id":"recrutamento:read","rotulo":"Ler recrutamento","descricao":"Vagas e candidaturas.","grupo":"Recrutamento","modulo":"recrutamento"},{"id":"eventos:read","rotulo":"Ler eventos","descricao":"Fila de eventos do cliente (os mesmos enviados por webhook).","grupo":"Eventos","modulo":null}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"kv__"},"chaveHeader":{"type":"apiKey","in":"header","name":"x-kivo-api-key"}},"schemas":{"Franquia":{"type":"object","properties":{"mes":{"type":"string","description":"Mês de referência (AAAA-MM, horário de Brasília)"},"inicio":{"type":"string","description":"Início do mês","format":"date"},"reinicia_em":{"type":"string","description":"Dia em que o consumo volta a zero","format":"date"},"ilimitado":{"type":"boolean","description":"Sem limite de documentos"},"por_colaborador":{"type":"integer","description":"Documentos por funcionário no mês"},"base_colaboradores":{"type":"integer","description":"Funcionários usados na conta"},"base_origem":{"type":"string","description":"Base da conta","enum":["contratados","ativos"]},"adicionais":{"type":"integer","description":"Documentos adicionais no mês"},"excedente":{"type":"string","description":"O que acontece ao atingir a franquia","enum":["bloquear","permitir"]},"franquia":{"type":["integer","null"],"description":"Total do mês (null quando ilimitado)"},"usados":{"type":"integer","description":"Documentos enviados no mês"},"restantes":{"type":["integer","null"],"description":"Restantes no mês (null quando ilimitado)"},"excedentes":{"type":"integer","description":"Documentos acima da franquia (modo permitir)"},"percentual":{"type":["number","null"],"description":"Uso em % (null quando ilimitado)"},"bloqueado":{"type":"boolean","description":"Novos envios bloqueados"},"origens":{"type":"object","description":"De onde vem cada valor: cliente, plano ou padrão"}},"required":["mes","ilimitado","usados","bloqueado","excedente"],"example":{"mes":"2026-09","inicio":"2026-09-01","reinicia_em":"2026-10-01","ilimitado":false,"por_colaborador":5,"base_colaboradores":40,"base_origem":"contratados","adicionais":0,"excedente":"bloquear","franquia":200,"usados":9,"restantes":191,"excedentes":0,"percentual":4.5,"bloqueado":false,"origens":{"por_colaborador":"padrao","adicionais":"padrao","excedente":"padrao"}}},"Erro":{"type":"object","properties":{"erro":{"type":"string","description":"Código do erro","enum":["nao_autenticado","sem_permissao","nao_encontrado","conflito","dados_invalidos","limite_excedido","metodo_nao_permitido","erro_interno"]},"mensagem":{"type":"string","description":"Mensagem pronta para exibir, em português"},"detalhes":{"description":"Detalhes opcionais (ex.: campos inválidos)"}},"required":["erro","mensagem"],"example":{"erro":"dados_invalidos","mensagem":"Informe a data de admissão."}},"Lista":{"type":"object","properties":{"cliente":{"type":"integer","description":"Código do cliente dono da chave"},"pagina":{"type":"integer"},"por_pagina":{"type":"integer"},"total":{"type":"integer"},"dados":{"type":"array","items":{"type":"object"}}},"required":["cliente","pagina","por_pagina","total","dados"],"example":{"cliente":12,"pagina":1,"por_pagina":50,"total":1,"dados":[{"id":"00000000-0000-0000-0000-000000000000"}]}},"Eventos":{"type":"object","properties":{"cliente":{"type":"integer"},"dados":{"type":"array","items":{"$ref":"#/components/schemas/Evento"}},"proximo_apos":{"type":"string","description":"Cursor para a próxima chamada"},"tem_mais":{"type":"boolean"}}},"Evento":{"type":"object","properties":{"id":{"type":"string","description":"Ex.: evt_123"},"tipo":{"type":"string"},"criado_em":{"type":"string","format":"date-time"},"cliente":{"type":"integer"},"empresa_id":{"type":"string","format":"uuid"},"dados":{"type":"object"}},"required":["id","tipo","criado_em"],"example":{"id":"evt_1024","tipo":"colaborador.admitido","criado_em":"2026-09-28T12:00:00Z","cliente":12,"empresa_id":"00000000-0000-0000-0000-000000000000","dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo","data_admissao":"2026-09-01","origem_cadastro":"api"}}},"EventoWebhook":{"type":"object","properties":{"id":{"type":"string","description":"Id do evento (evt_…)"},"tipo":{"type":"string","description":"Tipo do evento","enum":["colaborador.admitido","colaborador.atualizado","colaborador.movimentado","colaborador.desligado","colaborador.reativado","colaborador.excluido","pessoa.criada","pessoa.atualizada","documento.enviado","documento.assinado","documento.concluido","documento.recusado","documento.cancelado","documento.expirado","epi.entrega.registrada","epi.entrega.assinada","epi.entrega.cancelada","epi.devolucao.registrada","recrutamento.vaga.criada","recrutamento.vaga.atualizada","recrutamento.candidatura.criada","recrutamento.candidatura.atualizada"]},"criado_em":{"type":"string","format":"date-time"},"cliente":{"type":"integer","description":"Código do cliente"},"empresa_id":{"type":"string","description":"Empresa (matriz ou filial) do evento","format":"uuid"},"tentativa":{"type":"integer","description":"Número da tentativa de entrega (1 = primeira)"},"dados":{"type":"object","description":"Dados do recurso. Em *.atualizado vêm só os nomes dos campos alterados."}},"required":["id","tipo","criado_em","cliente","tentativa","dados"],"example":{"id":"evt_1024","tipo":"colaborador.admitido","criado_em":"2026-09-28T12:00:00Z","cliente":1,"empresa_id":"00000000-0000-0000-0000-000000000000","tentativa":1,"dados":{"colaborador_id":"00000000-0000-0000-0000-000000000000","pessoa_id":"00000000-0000-0000-0000-000000000000","empresa_id":"00000000-0000-0000-0000-000000000000","matricula":"1024","nome":"Maria Souza","status":"ativo","data_admissao":"2026-09-01","origem_cadastro":"api"}}},"PessoaAtualizar":{"type":"object","properties":{"nome_social":{"type":"string"},"email_pessoal":{"type":"string"},"telefone":{"type":"string"},"telefone_alternativo":{"type":"string"},"estado_civil":{"type":"string"},"endereco_cep":{"type":"string"},"endereco_logradouro":{"type":"string"},"endereco_numero":{"type":"string"},"endereco_complemento":{"type":"string"},"endereco_bairro":{"type":"string"},"endereco_cidade":{"type":"string"},"endereco_uf":{"type":"string"}},"additionalProperties":false,"example":{"telefone":"(11) 99999-0000","endereco_cidade":"São Paulo"}},"ColaboradorAdmitir":{"type":"object","properties":{"empresa_id":{"type":"string","format":"uuid"},"nome_completo":{"type":"string"},"cpf":{"type":"string"},"data_admissao":{"type":"string","format":"date"},"matricula":{"type":"string"},"cargo_id":{"type":"string","format":"uuid"},"departamento_id":{"type":"string","format":"uuid"},"regime":{"type":"string","enum":["clt","pj","estagio","jovem_aprendiz","terceirizado","autonomo"]},"salario":{"type":"number"},"carga_horaria_semanal":{"type":"number"},"status":{"type":"string","enum":["ativo","pre_admissao"]},"categoria_trabalhador":{"type":"string"},"tipo_duracao_contrato":{"type":"string"},"email_pessoal":{"type":"string","format":"email"},"telefone":{"type":"string"},"data_nascimento":{"type":"string","format":"date"},"confirmar_segundo_vinculo":{"type":"boolean","description":"Confirme quando a pessoa já tem outro vínculo ativo"}},"required":["empresa_id","nome_completo","cpf","data_admissao"],"example":{"empresa_id":"00000000-0000-0000-0000-000000000000","nome_completo":"Maria Souza","cpf":"12345678909","data_admissao":"2026-10-01"}},"ColaboradorAtualizar":{"type":"object","properties":{"email_corporativo":{"type":"string"},"gestor_id":{"type":"string","format":"uuid"},"numero_folha":{"type":"string"},"codigo_holerite":{"type":"string"},"numero_identificador":{"type":"string"},"observacoes":{"type":"string"}},"additionalProperties":false},"Movimentacao":{"type":"object","properties":{"tipo":{"type":"string","description":"promocao, reajuste, transferencia, jornada, afastamento, retorno…"},"data_efeito":{"type":"string","format":"date"},"cargo_id":{"type":"string","format":"uuid"},"departamento_id":{"type":"string","format":"uuid"},"centro_custo_id":{"type":"string","format":"uuid"},"local_trabalho_id":{"type":"string","format":"uuid"},"equipe_id":{"type":"string","format":"uuid"},"novo_salario":{"type":"number"},"regime":{"type":"string"},"carga_horaria_semanal":{"type":"number"},"motivo":{"type":"string"},"motivo_afastamento":{"type":"string"},"previsao_retorno":{"type":"string","format":"date"}},"required":["tipo","data_efeito"]},"Desligamento":{"type":"object","properties":{"data_desligamento":{"type":"string","format":"date"},"categoria":{"type":"string"},"motivo":{"type":"string"},"causa":{"type":"string"},"aviso_previo_tipo":{"type":"string"},"aviso_previo_dias":{"type":"integer"},"aviso_previo_inicio":{"type":"string","format":"date"},"ciente_estabilidade":{"type":"boolean"},"justificativa_epi":{"type":"string"}},"required":["data_desligamento","categoria","motivo"]},"Reativacao":{"type":"object","properties":{"motivo":{"type":"string"}},"required":["motivo"]},"Motivo":{"type":"object","properties":{"motivo":{"type":"string"}},"required":["motivo"]},"EntregaEpi":{"type":"object","properties":{"colaborador_id":{"type":"string","format":"uuid"},"itens":{"type":"array","minItems":1,"items":{"type":"object","properties":{"epi_item_id":{"type":"string","format":"uuid"},"quantidade":{"type":"number"},"lote_id":{"type":"string","format":"uuid"},"unidade_serie_id":{"type":"string","format":"uuid"},"motivo":{"type":"string"}},"required":["epi_item_id","quantidade"]}},"empresa_id":{"type":"string","format":"uuid"},"data_entrega":{"type":"string","format":"date"},"tipo":{"type":"string","enum":["primeira_entrega","troca","reposicao"]},"almoxarifado_id":{"type":"string","format":"uuid"},"observacoes":{"type":"string"},"orientacoes_fornecidas":{"type":"boolean"},"manual_entregue":{"type":"boolean"},"treinamento_verificado":{"type":"boolean"},"justificativa_sem_treinamento":{"type":"string"},"orientacao_data":{"type":"string","format":"date"},"orientacao_observacoes":{"type":"string"}},"required":["colaborador_id","itens"]},"DocumentoCriar":{"type":"object","properties":{"colaborador_id":{"type":"string","format":"uuid"},"modelo_id":{"type":"string","format":"uuid"},"titulo":{"type":"string","description":"Obrigatório quando o modelo não gera o documento"},"arquivo_pdf_base64":{"type":"string","description":"PDF em base64 (até 5 MB e 30 páginas). Só para modelos sem texto."},"notificar":{"type":"boolean","description":"Enviar e-mail ao colaborador (padrão true)"},"signatarios_adicionais":{"type":"array","maxItems":4,"items":{"type":"object","properties":{"nome":{"type":"string"},"email":{"type":"string","format":"email"},"cpf":{"type":"string"},"funcao":{"type":"string"}},"required":["nome","email"]}}},"required":["colaborador_id","modelo_id"]},"LinkAssinatura":{"type":"object","properties":{"signatario_id":{"type":"string","description":"Testemunha na vez (vazio = colaborador)","format":"uuid"}}}}}}