Atualizar Employee

Atualiza os dados cadastrais de um trabalhador existente. A atualização impacta os próximos fluxos de simulação e contratação — operações já em andamento não são afetadas retroativamente.

Quando usar

  • Correção de dados informados incorretamente no cadastro

  • Atualização de telefone ou e-mail de contato

  • Alteração de dados pessoais

circle-info

A atualização substitui todos os campos do cadastro. Envie o payload completo, mesmo para os campos que não foram alterados. Os campos obrigatórios e opcionais são os mesmos de Criar Employee.

Atualizar Employee

put
/api/v1/originator/employees/{publicId}

Atualiza os dados cadastrais de um trabalhador existente. A atualização impacta os próximos fluxos de simulação e contratação.

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota
publicIdstringObrigatório

Public ID do employee

Corpo
cpfstring · mín: 11 · máx: 11Obrigatório

CPF do trabalhador contendo 11 dígitos numéricos, sem pontos ou traços.

Pattern: ^\d{11}$
namestring · máx: 100Obrigatório

Nome civil completo do trabalhador conforme documento oficial.

birthDatestring · dateOpcional

Data de nascimento no formato ISO (yyyy-MM-dd).

motherNamestring · máx: 100Opcional

Nome completo da mãe, utilizado para validação cadastral.

genderstring · enumOpcional

Gênero declarado pelo trabalhador.

Valor Significado
MALE Masculino
FEMALE Feminino
NOT_INFORMED Não informado
Valores possíveis:
idDocumentTypestring · enumOpcional

Tipo do documento de identificação (código retornado pela API).

Valor Significado
MARITIME_CARD Carteira de Marítimo
RESERVIST_CERTIFICATE Certidão de Reservista
DRIVERS_LICENSE CNH
WORK_CARD CTPS
PASSPORT Passaporte
GENERAL_REGISTRY RG
PROFESSIONAL_ID_CARD CIP
INDIGENOUS_BIRTH_REGISTRY RANI
ELECTRONIC_DRIVERS_LICENSE CNH-e
NATIONAL_ID DNI
PROVISIONAL_MIGRATION_REGISTRY DPRNM
MILITARY_ID_CARD CIM
FOREIGNER_REGISTRY RNE/CIE
Valores possíveis:
idDocumentNumberstring · máx: 50Opcional

Número do documento de identificação correspondente ao idDocumentType.

isPoliticallyExposedbooleanOpcional

Indica se o trabalhador é Pessoa Politicamente Exposta (PPE/PEP).

phonestring · máx: 20Opcional

Telefone de contato do trabalhador, preferencialmente com DDD.

emailstring · email · máx: 100Opcional

E-mail válido para comunicações operacionais e notificações.

partnerNamestring · máx: 100Opcional

Nome do cônjuge ou parceiro, quando aplicável.

Respostas
chevron-right
200

Employee atualizado com sucesso

application/json
idinteger · int64Opcional

Identificador interno do trabalhador no sistema.

publicIdstringOpcional

Identificador público (16 caracteres Base64 URL-safe). Ex. Kj8mP2xQ9nR4sT6v

cpfstringOpcional

CPF do trabalhador cadastrado.

namestringOpcional

Nome civil completo do trabalhador.

birthDatestring · dateOpcional

Data de nascimento registrada.

motherNamestringOpcional

Nome completo da mãe registrado.

genderstring · enumOpcional

Gênero no cadastro.

Valor Significado
MALE Masculino
FEMALE Feminino
NOT_INFORMED Não informado
Valores possíveis:
idDocumentTypestring · enumOpcional

Mesmos valores de CreateEmployeeRequest.idDocumentType (ver tabela).

Valores possíveis:
idDocumentNumberstringOpcional

Número do documento de identificação registrado.

isPoliticallyExposedbooleanOpcional

Indicador de Pessoa Politicamente Exposta no cadastro do trabalhador.

phonestringOpcional

Telefone de contato registrado.

emailstringOpcional

E-mail registrado para contato.

partnerNamestringOpcional

Nome do cônjuge/parceiro registrado.

statusstring · enumOpcional

Situação cadastral do trabalhador.

Valor Significado
ACTIVE Cadastro ativo, pode operar
INACTIVE Cadastro inativo (ex.: desligado)
REVOKED Acesso revogado pelo originator
Valores possíveis:
createdDatestring · date-timeOpcional

Data e hora de criação do cadastro no sistema (UTC).

lastModifiedDatestring · date-timeOpcional

Data e hora da última atualização do cadastro (UTC).

put
/api/v1/originator/employees/{publicId}

Atualizado