Criar Employee

Cadastra um novo trabalhador (employee) vinculado ao originador autenticado. Os dados enviados serão utilizados nas validações de elegibilidade, simulação, proposta e formalização contratual.

Dados obrigatórios

Campo
Tipo
Descrição

cpf

string

CPF do trabalhador (11 dígitos, sem pontuação)

name

string

Nome civil completo conforme documento oficial

Dados opcionais

Campo
Tipo
Descrição

birthDate

string

Data de nascimento (YYYY-MM-DD)

motherName

string

Nome completo da mãe

gender

string

Gênero (MALE, FEMALE, NOT_INFORMED)

idDocumentType

string

Tipo do documento de identificação (ver tabela abaixo)

idDocumentNumber

string

Número do documento de identificação

isPoliticallyExposed

boolean

Indica se é Pessoa Politicamente Exposta (PPE/PEP)

phone

string

Telefone de contato com DDD

email

string

E-mail para comunicações e notificações

partnerName

string

Nome do cônjuge ou parceiro

Tipos de documento (idDocumentType)

Valor
Significado

GENERAL_REGISTRY

RG

DRIVERS_LICENSE

CNH

ELECTRONIC_DRIVERS_LICENSE

CNH-e

NATIONAL_ID

DNI

WORK_CARD

CTPS

PASSPORT

Passaporte

MILITARY_ID_CARD

CIM

RESERVIST_CERTIFICATE

Certidão de Reservista

MARITIME_CARD

Carteira de Marítimo

PROFESSIONAL_ID_CARD

CIP

INDIGENOUS_BIRTH_REGISTRY

RANI

PROVISIONAL_MIGRATION_REGISTRY

DPRNM

FOREIGNER_REGISTRY

RNE/CIE

circle-exclamation

Próximo passo

Após criar o employee, envie a autorização Dataprev para consulta de dados.

Criar Employee

post
/api/v1/originator/employees

Cria o cadastro de um trabalhador (employee) vinculado ao originator autenticado. Os dados enviados serão utilizados nas validações de elegibilidade, simulação, proposta e formalização contratual.

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

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
post
/api/v1/originator/employees

Atualizado