pre employee moved event

Essa documentação se refere ao glossário do webhook de dados de admissão para sistema de folha do cliente.

Esse webhook é disparado toda vez que uma pessoa pré-colaboradora é movida entre etapas do Gupy Admissão.

A partir dele é possível desenvolver o fluxo de admissão para a folha de pagamento utilizada pela sua empresa, fazer envio dos dados para exame médico e também para provisionamento de equipamentos para a nova pessoa colaboradora. Para ver o contrato JSON desse webhook clique aqui.

❗️

Mapeamento de campos obrigatórios

Preste atenção aos campos obrigatórios exigidos pelo seu sistema ao desenvolver a integração, pois caso o documento não esteja como obrigatório dentro do template de admissão pode ocorrer da pessoa pré-colaboradora não realizar o preenchimento.

Caso você não tenha acesso aos templates e documentos solicitados à pessoa pré-colaboradora no Gupy Admissão, faça o alinhamento com o time de Departamento Pessoal da sua empresa, levantando quais campos são necessários para que a integração ocorra com sucesso.

CAMPO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
companyNameNome da empresa
idNão visívelId do evento
eventNão visívelvalor fixo = "pre-employee.moved"
dateNão visívelData em que foi realizada a movimentação de gatilho para disparo do webhook
job.idNúmero gerado automaticamente pela Gupy ao criar uma vaga (conhecido como jobId). Na tela de gestão de admissões, a coluna Código e nome da vagaRetorno results.id ao criar uma vaga utilizando o endpoint creating a job. Essa informação será nula para Inserções Diretas de Pré-Colaboradores no Gupy Admissão
job.codeNa tela de gestão de admissões, a coluna Código e nome da vagaEssa informação é gerada automaticamente ao criar vagas e também pode ser editada ao atualizar a vaga ou ao Inserir Pré-Colaboradores Diretamente no Gupy Admissão
job.nameNa tela de gestão de admissões, a coluna Código e nome da vagaNome da vaga da em que o candidato foi contratado
job.typevacancy_type_apprentice
vacancy_type_associate
vacancy_type_talent_pool
vacancy_type_effective
vacancy_type_internship
vacancy_type_summer
vacancy_type_temporary
vacancy_type_outsource
vacancy_type_trainee
vacancy_type_volunteer
vacancy_legal_entity
vacancy_type_lecturer
vacancy_type_freelancer
vacancy_type_autonomous
Tipo da vaga
job.department.idNão visívelCódigo do departamento/área gerado automaticamente na criação.
job.department.codeNão visívelQuando uma área é criada através da plataforma esse campo fica "null", mas ao utilizar o endpoint creating a department é possível atribuir um valor para esse campo. É muito utilizado para realizar integrações com sistemas de folha onde é preciso enviar o código da área em que o candidato foi contratado.
job.department.nameNome da área da vaga em que o candidato foi contratado
job.department.similarityfinancial_management
agronomy
architecture
audit_or_quality
attendance
sales
purchases
communication_or_design
marketing
accounting_or_controlling
engineering_or_maintenance
technical_services
legal
innovation_or_product
logistics
operations
project_or_processes
human_resources
security
technology
Visível no setup de áreas
job.role.idNão visívelCódigo do cargo gerado automaticamente na criação.
job.role.nameAo acessar uma admissão a informação **Cargo **no lado esquerdo da telaNome do cargo da vaga em que o candidato foi contratado
job.role.codeNão visívelQuando um cargo é criado através da plataforma esse campo fica "null", mas ao utilizar o endpoint creating a role é possível atribuir um valor para esse campo. É muito utilizado para realizar integrações com sistemas de folha onde é preciso enviar o código do cargo em que o candidato foi contratado.
job.role.similarityanalyst
apprentice
auxiliary
consultant
coordinator
developer
director
intern
specialist
supervisor
manager
operator
technician
trainee
Visível no setup de cargos
job.branch.idNão visívelCódigo da filial/estrutura organizacional gerado automaticamente na criação.
job.branch.codeNão visível
job.branch.nameNome da filial/estrutura organizacional da vaga em que o candidato foi contratado
job.customfields.idNão visívelId gerado automaticamente ao criar um campo customizado na plataforma
job.customfields.titleNome do campo customizado criado no Gupy R&S
job.customfields.valueValor que está atribuído ao campo no momento em que o evento foi disparado. (Caso a opção do campo customizada seja alterada e o evento seja disparado novamente ele carregará a nova opção que foi atribuída)
applicationGerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga.Essa informação será nula para Inserções Diretas de Pré-Colaboradores no Gupy Admissão
application.idNúmero gerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga. Ao acessar uma candidatura o Id aparece na URL após /jobs/jobId/candidatesRetorno results.id ao criar uma candidatura utilizando o endpoint creating an application
application.scoreNa lista de candidatos em uma vaga é a porcentagem antes do nome do candidato e ao acessar uma candidatura, na tela principal é o valor definido para "Afinidade"Aderência do candidato à vaga
application.partnerName99hunters
catho
facebook_jobs
geekhunter
glassdoor
google_for_jobs
indeed
indeed_sponsored
jooble
linkedin
netvagas
riovagas
trampos
gupy_opportunities
gupy_opportunities_recommended
gupy_public_page
gupy_public_page_event
Nome do parceiro que gerou a candidatura. Em casos de inserção manual, essa informação só é preenchida após o candidato aceitar o convite.
application.tagsAo acessar uma candidatura, menu de Avaliação do Candidato no lado direito da telaTags relacionadas à candidatura, se houverem.
currentStep.idAo editar uma etapa, o seu Id aparecerá na URL. Como nesse caso, a etapa que pessoa candidata está quando vai para o Admissão é sempre a padrão de Contratação o Id estará ao final da URL logo após /step/finalId da etapa em que o candidato estava quando foi para o Gupy Admissão
currentStep.nameNa lista de candidatos em uma vaga, o nome da etapa está logo abaixo do nome do candidato e ao abrir uma candidatura, tela principal do candidato, logo abaixo do nome.Nome da etapa em que o candidato estava no Gupy R&S quando foi para o Gupy Admissão (Nesse caso sempre será "Contratação"
currentStep.typeno caso desse webhook o type será "final"Não visívelEsse campo pega as informações do Gupy R&S e lá esses campos possuem os seguintes valores: register: etapa de cadastro
online: etapa customizada quando há alguma ação automática (teste, envio de vídeos, disparo de e-mail)
offline: etapa customizada que há algum tipo de ação fora da plataforma (entrevista, agendamentos)
candidate.idNão visívelId do candidato, gerado na primeira vez em que ele se inscreve em alguma vaga na Gupy. Essa informação será nula para Inserções Diretas de Pré-Colaboradores no Gupy Admissão enquanto o Pré-Colaborador não aceitar o convite para o processo
candidate.nameNa gestão de admissões, a coluna Pré-colaboradorNome do candidato
candidate.lastNameNa gestão de admissões, a coluna Pré-colaboradorSobrenome do candidato
candidate.emailAo acessar uma admissão, no lado esquerdo da tela abaixo do número de celular do pré-colaborador.E-mail do candidato
candidate.countryOfOriginAo acessar uma candidatura no Gupy R&S, aba CadastroPaís de origem do candidato
candidate.birthdateAo acessar uma candidatura no Gupy R&S, aba CadastroData de aniversário do candidato
candidate.addressZipCodeAo acessar uma candidatura no Gupy R&S, aba CadastroCEP da residência do candidato
candidate.addressStreetAo acessar uma candidatura no Gupy R&S, aba CadastroLogradouro da residência do candidato
candidate.addressNumberAo acessar uma candidatura no Gupy R&S, aba CadastroNúmero da residência do candidato
candidate.addressCityAo acessar uma candidatura no Gupy R&S, aba CadastroCidade da residência do candidato
candidate.addressStateAo acessar uma candidatura no Gupy R&S, aba CadastroEstado onde o candidato reside
candidate.addressStateShortNameAo acessar uma candidatura no Gupy R&S, aba CadastroAbreviação do nome do Estado onde o candidato reside
candidate.addressCountryAo acessar uma candidatura no Gupy R&S, aba CadastroPaís de residência do candidato
candidate.addressCountryShortNameAo acessar uma candidatura no Gupy R&S, aba CadastroAbreviação do nome do país onde o candidato reside
candidate.mobileNumberAo acessar uma admissão, no lado esquerdo da tela logo abaixo o nome do pré-colaboradorTelefone celular do candidato
candidate.phoneNumberAo acessar uma candidatura no Gupy R&S, aba Cadastro

As informações dos documentos que o pré-colaborador subiu na plataforma são entregues no array de documentos:

admission.documents.preEmployee

O array é composto pelos seguintes campos:

CAMPO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
idId do documento que é gerado automaticamente pela Gupy
nameNome do documento padrão da Gupy, exemplo: Carteira de Identidade (RG)
valuesCampos que compõem o documento

Os values são os valores que cada campo de cada documento recebe quando o pré-colaborador preenche a documentação. Abaixo iremos trazer todos os values de cada documento padrão da Gupy. Caso um campo de um documento não seja respondido ele não é enviado no webhook.

name: Carteira de Identidade (RG)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
nomeEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Nome completo do pré-colaborador
nome-socialEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Nome social do pré-colaborador
etniaBranca
Preta/Negra
Amarela
Parda
Indígena
Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)
generoFeminino
Masculino
Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)
uf-emissorConsulte nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
nome-da-maeEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Nome completo da mãe do pré-colaborador
nome-do-paiEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Nome completo do pai do pré-colaborador
estado-civilSolteiro(a)
Casado(a)
Separado(a)
Divorciado(a)
Viúvo(a)
Etapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)
numero-do-rgEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Essa informação é enviada sem máscara (sem pontos ou traços)
nacionalidadeConsulte Nome do País em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)A Gupy envia o nome do país por extenso, exemplo: Brasil
orgao-emissorEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)
data-de-expedicaoEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
cidade-onde-nasceuEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE
data-de-nascimentoEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
estado-onde-nasceuConsulte Nome do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Carteira de Identidade (RG)Para esse campo a Gupy envia o nome do Estado por extenso, exemplo: "Alagoas"

name: Comprovante de residência

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
tipoConsulte nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Comprovante de residência
bairroEtapa envio de documentos, ao acessar o documento Comprovante de residênciaBairro em que o pré-colaborador reside
cidadeEtapa envio de documentos, ao acessar o documento Comprovante de residênciaA Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE
numeroEtapa envio de documentos, ao acessar o documento Comprovante de residênciaNúmero do logradouro
cepEtapa envio de documentos, ao acessar o documento Comprovante de residênciaA Gupy envia a informação de CEP no formato 00000-000
paisConsulte** Nome do País** em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Comprovante de residênciaA Gupy envia o nome do país por extenso, exemplo: Brasil
estadoConsulte Nome do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Comprovante de residênciaA Gupy envia nesse campo a informação do nome do Estado por extenso, exemplo: Alagoas
logradouroEtapa envio de documentos, ao acessar o documento Comprovante de residênciaRua em que o pré-colaborador reside
complementoEtapa envio de documentos, ao acessar o documento Comprovante de residênciaComplemento do logradouro

name: Carteira de Habilitação (CNH)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
categoriaA
B
C
D
E
AB
AC
AD
AE
Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)
uf-emissorConsulte o Código do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
validadeEtapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
orgao-emissorDenatran
Senatran
Outro (essa opção abre um campo texto livre)
Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)
data-de-emissaoEtapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
numero-de-registroEtapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)
data-da-primeira-habilitacaoEtapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z

name: Cartão Nacional de Saúde (CNS)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numeroEtapa envio de documentos, ao acessar o documento Cartão Nacional de Saúde (CNS)

name: CPF

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numero-do-cpfEtapa envio de documentos, ao acessar o documento CPFA Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx

name: Comprovante de Escolaridade

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
grau_instrucaoAnalfabeto
Ensino fundamental I incompleto
Ensino fundamental I completo
Ensino fundamental II incompleto
Ensino fundamental II completo
Ensino médio incompleto
Ensino médio completo
Educação superior incompleta
Educação superior completa
Pós-graduação completa
Mestrado completo
Doutorado completo
Etapa envio de documentos, ao acessar o documento Comprovante de Escolaridade

name: Contrato de estágio

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
nomeEtapa envio de documentos, ao acessar o documento Contrato de estágio
grau_instrucaoAnalfabeto
Ensino fundamental I incompleto
Ensino fundamental I completo
Ensino fundamental II incompleto
Ensino fundamental II completo
Ensino médio incompleto
Ensino médio completo
Educação superior incompleta
Educação superior completa
Pós-graduação completa
Mestrado completo
Doutorado completo
Etapa envio de documentos, ao acessar o documento Contrato de estágio
tipo-estagioEstágio remunerado
Estágio obrigatório ou curricular
Estágio supervisionado
Estágio não obrigatório ou voluntário.
Etapa envio de documentos, ao acessar o documento Contrato de estágio
numero-apoliceEtapa envio de documentos, ao acessar o documento Contrato de estágio
nivel-estagioMédio
Técnico
Superior
Etapa envio de documentos, ao acessar o documento Contrato de estágio
area-estagioEtapa envio de documentos, ao acessar o documento Contrato de estágio
cpf-coordenadorEtapa envio de documentos, ao acessar o documento Contrato de estágioA Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx
nome-coordenadorEtapa envio de documentos, ao acessar o documento Contrato de estágio
cnpj-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
nome-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
cep-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágioA Gupy envia a informação de CEP no formato 00000-000
tipo-logradouro-instituicaoConsulte nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Contrato de estágio
logradouro-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
numero-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
complemento-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
bairro-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio
uf-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágioPara esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
cidade-instituicaoEtapa envio de documentos, ao acessar o documento Contrato de estágio

name: Comprovante de PIS/Pasep

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numeroEtapa envio de documentos, ao acessar o documento Comprovante de PIS/PasepA Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x
Esse é um campo de preenchimento obrigatório mesmo que seja o primeiro emprego da pessoa pré-colaboradora, pois o número do PIS pode ser retirado na agência da Caixa ou enviado pela empresa. Caso a empresa tenha esse cenário de que ela faz a qualificação o documento de comprovante de PIS/PASEP não precisa ser adicionado no check-list de admissão.
primeiro-empregotrue
false
Etapa envio de documentos, ao acessar o documento Comprovante de PIS/PasepPergunta obrigatória

name: Certificado de Reservista

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numero-raEtapa envio de documentos, ao acessar o documento Certificado de ReservistaA Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x
regiao-militarEtapa envio de documentos, ao acessar o documento Certificado de Reservista
orgao-expeditorEtapa envio de documentos, ao acessar o documento Certificado de Reservista
uf-de-expedicaoConsulte o Código do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Certificado de ReservistaPara esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
situacao-militarEtapa envio de documentos, ao acessar o documento Certificado de Reservista
categoria-militarEtapa envio de documentos, ao acessar o documento Certificado de Reservista

name: Documento de Identificação Profissional (DIP)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numeroEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x
ufEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)
data-de-emissaoEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
uf-de-expedicaoConsulte o Código do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
data-de-registroEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
data-de-validadeEtapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
associacao-profissionalConselho Regional de Administração - CRA
Conselho Regional de Artquitetura e Urbanismo - CAU
Conselho Regional de Biblioteconomia - CRB
Conselho Regional de Biologia - CRBIO
Conselho Regional de Biomedicina - CRBM
Conselho Regional de Contabilidade - CRC
Conselho Regional de Corretores de Imóveis - CRECI
Conselho Regional de Economia - CORECON
Conselho Regional de Educação Física - CREF
Conselho Regional de Educadores e Pedagogos - CREP
Conselho Regional de Enfermagem - COREN
Conselho Regional de Engenharia e Agronomia - CREA
Conselho Regional de Farmácia - CRF
Conselho Regional de Fisioterapia e Terapia Ocupacional - CREFITO
Conselho Regional de Medicina - CRM
Conselho Regional de Medicina Veterinária - CRMV
Conselho Regional de Odontologia - CRO
Conselho Regional de Psicologia - CRP
Conselho Regional de Química - CRQ
Conselho Regional de Relações Públicas - CONRERP
Conselho Regional de Representantes Comerciais - CORE
Conselho Regional de Serviço Social - CRESS
Conselho Regional de Técnicos Agrícolas - CRTA
Conselho Regional de Técnicos Industriais - CRT
Conselho Regional e Fonoaudiologia - CREFONO
Ordem dos Advogados do Brasil - OAB
Ordem dos Músicos do Brasil - OMB
Conselho Nacional de Técnicos em Radiologia - CONTER
Conselho Regional de Técnicos em Radiologia - CRTR
Conselho Nacional de Profissionais da Beleza - CNPB
Superintendência Regional do Trabalho e Emprego - SRTE
Ministério do Trabalho e Emprego - MTE
Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP)

name: Título de Eleitor

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numeroEtapa envio de documentos, ao acessar o documento ** Título de Eleitor**A Gupy envia a informação no seguinte formato: xxxx xxxx xxxx
zonaEtapa envio de documentos, ao acessar o documento ** Título de Eleitor**
secaoEtapa envio de documentos, ao acessar o documento ** Título de Eleitor**
uf-emissorConsulte o Código do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Título de Eleitor**Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
data-de-emissaoEtapa envio de documentos, ao acessar o documento Título de EleitorO formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
cidade-votacaoEtapa envio de documentos, ao acessar o documento Título de EleitorA Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE

name: Laudo Médico

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
tipo_deficienciaAuditiva, \nFísica, \nIntelectual, \nMental, \nVisual, \nReabilitadoEtapa envio de documentos, ao acessar o documento ** Laudo Médico**

name: Carteira de Trabalho (CTPS)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
numero-ctpsEtapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)**
serie-ctpsEtapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)**
uf-emissorConsulte o Código do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)**Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas
data-de-emissaoEtapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z

name: Atestado de Saúde Ocupacional (ASO)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
data_exameEtapa envio de documentos, ao acessar o documento ** Atestado de Saúde Ocupacional (ASO)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z

name: Carteira de Registro Nacional Migratório (CRNM)

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
sexoFeminino \nMasculinoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
casadoSim, \nNãoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
filhosSim, \nNãoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
numero-crnmEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
data-emissaoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
classificacaoFronteiriço, \nResidente, \nProvisório, \nVisto Permanente, \nVisto Temporário, \nAsilado, \nRefugiado, \nSolicitante de Refugio, \nResidente fora do Brasil, \nDeficiente físico e com mais de 50 anos, \nCom residência provisória e anistiado, em situação irregular, \nPermanência no Brasil em razão de filhos ou cônjuges brasileiros, \nBeneficiado pelo acordo entre países do Mercosul, \nDependente de agente diplomático e/ou consular, \nBenefic. pelo Tratado de Amizade, entre a Repúb. do Brasil e Repúb. PortuguesaEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
data-validadeEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
nacionalidadeEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
nome-completoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
orgao-emissorEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
data-nascimentoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
data-chegada-brasilEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
tipo-vistoCortesia, \nDiplomático, \nOficial, \nPermanente, \nTemporário, \nTrânsito, \nTuristaEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
nome-da-maeEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
nome-do-paiEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
naturalizado-brasileiroSim, NãoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**
numero-portaria-naturalizacaoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**Aparece apenas se naturalizado-brasileiro for Sim
data-portaria-naturalizacaoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**(Aparece apenas se naturalizado-brasileiro for Sim). O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
data-naturalizacaoEtapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)**(Aparece apenas se naturalizado-brasileiro for Sim). O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z

name: Passaporte

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
tipoEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo de texto livre (obrigatório)
paisEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo de texto livre (obrigatório)
numeroEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório
nomeEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório
data-de-nascimentoEtapa envio de documentos, ao acessar o documento ** Passaporte**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
sexoFeminino, MasculinoEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório
nacionalidadeConsulte **Nome do País ** em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório - A Gupy envia o nome do país por extenso, exemplo: Brasil
estadoConsulte Nome do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório - A Gupy envia nesse campo a informação do nome do Estado por extenso, exemplo: Alagoas
naturalidadeEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo obrigatório
nome-da-maeEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo de texto livre (obrigatório)
nome-do-paiEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo de texto livre
data-de-emissaoEtapa envio de documentos, ao acessar o documento ** Passaporte**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
data-de-validadeEtapa envio de documentos, ao acessar o documento ** Passaporte**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
orgao-emissorEtapa envio de documentos, ao acessar o documento ** Passaporte**Campo de texto livre

name: Dados bancários

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
bancoEtapa envio de documentos, ao acessar o documento ** Dados bancários**
contaEtapa envio de documentos, ao acessar o documento ** Dados bancários**Esse campo não é passado com o dígito
digitoEtapa envio de documentos, ao acessar o documento ** Dados bancários**
agenciaEtapa envio de documentos, ao acessar o documento ** Dados bancários**Esse campo não é passado com o dígito.

name: Dependentes v2

CAMPO NO BACKENDOPÇÕES BACKENDCAMPO NO FRONTENDOBSERVAÇÕES
cpfEtapa envio de documentos, ao acessar o documento ** Dependentes**A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx
birthDateEtapa envio de documentos, ao acessar o documento ** Dependentes**O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z
nameEtapa envio de documentos, ao acessar o documento ** Dependentes**Nome do dependente
birthLocationEtapa envio de documentos, ao acessar o documento ** Dependentes**Local de nascimento
handicappedtrue, falseEtapa envio de documentos, ao acessar o documento ** Dependentes**Campo que traz a informação se o dependente possui deficiencia
dependentTypeIdEtapa envio de documentos, ao acessar o documento ** Dependentes**Cada dependentTypeId está vinculado à um tipo de relação que o colaborador tem com o seu dependente. Cada Id desse relacionamento é único.
genderFeminino, \nMasculinoEtapa envio de documentos, ao acessar o documento ** Dependentes**
cityOfOriginA Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGEEtapa envio de documentos, ao acessar o documento ** Dependentes**Cidade de nascimento do dependente
stateOfOriginConsulte Nome do Estado em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Dependentes**Estado de nascimento do dependente
countryOfOriginConsulte **Nome do País ** em nossas tabelas auxiliares clicando aquiEtapa envio de documentos, ao acessar o documento ** Dependentes**País de nascimento do dependente
includeIncomeTaxtrue, falseEtapa envio de documentos, ao acessar o documento ** Dependentes**Campo traz a resposta para a pergunta se o dependente é incluído no Imposto de Renda. A dedução ao Imposto de Renda está elegível para TODAS as relações de dependentes, com exceção de "Ex-Cônjuge" e "Agregado/Outros."
includeSalarioFamiliatrue, falseEtapa envio de documentos, ao acessar o documento ** Dependentes**Campo traz a resposta para a pergunta se o dependente é incluído no Salário Família. O direito ao Salário Família está condicionado apenas à relação de "Filho(a) ou enteado(a)" de até 14 anos de idade. Caso seja um filho com incapacidade, este direito passa a não ser condicionado por idade.
hasIdentificationDocumenttrue, falseEtapa envio de documentos, ao acessar o documento ** Dependentes**
tipo-deficienciaAuditiva, \nFísica, \nIntelectual \nMental, \nVisualEtapa envio de documentos, ao acessar o documento ** Dependentes**
payPensionTrue, FalseEtapa envio de documentos, ao acessar o documento ** Dependentes**Campo traz a resposta para a pergunta: "Você paga pensão para esse dependente?" E só aparece se a relação for de filho e menor de idade.

🚧

Documentos customizados

Eventualmente, pode ocorrer a necessidade da criação de um documento customizado para atender alguma regra do seu sistema de folha ou do seu processo admissional. Nesse caso cada campo do documento será composto por um Id gerado automaticamente pela Gupy no momento da criação desse documento.

Para saber quais são os Ids e mapear os campos da integração, aconselhamos que seja feita a simulação do preenchimento da documentação através da visão de um candidato teste e após o envio dos documentos, seja feita a movimentação de etapa. Assim o webhook será disparado com as informações, possibilitando mapear também os campos do documento customizado.