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 BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
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 BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| id | | | Id do documento que é gerado automaticamente pela Gupy |
| name | | | Nome do documento padrão da Gupy, exemplo: Carteira de Identidade (RG) |
| values | | | Campos 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.
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| nome | | | Nome completo do pré-colaborador |
| nome-social | | | Nome social do pré-colaborador |
| etnia | Branca, \nPreta/Negra, \nAmarela, \nParda, \nIndígena | | |
| genero | Feminino, Masculino | | |
| uf-emissor | Consulte nossas tabelas auxiliares clicando aqui | | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| nome-da-mae | | | Nome completo da mãe do pré-colaborador |
| nome-do-pai | | | Nome completo do pai do pré-colaborador |
| estado-civil | Solteiro(a) \nCasado(a) \nSeparado(a) \nDivorciado(a) \nViúvo(a) | | |
| numero-do-rg | | | Essa informação é enviada sem máscara (sem pontos ou traços) |
| nacionalidade | Consulte **Nome do País ** em nossas tabelas auxiliares clicando aqui | | A Gupy envia o nome do país por extenso, exemplo: Brasil |
| orgao-emissor | | | |
| data-de-expedicao | | | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
| cidade-onde-nasceu | | | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE |
| data-de-nascimento | | | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
| estado-onde-nasceu | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | | Para esse campo a Gupy envia o nome do Estado por extenso, exemplo: "Alagoas" |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| tipo | Consulte nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | |
| bairro | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Bairro em que o pré-colaborador reside |
| cidade | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE |
| numero | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Número do logradouro |
| cep | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia a informação de CEP no formato 00000-000 |
| pais | Consulte** Nome do País** em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia o nome do país por extenso, exemplo: Brasil |
| estado | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Comprovante de residência | A Gupy envia nesse campo a informação do nome do Estado por extenso, exemplo: Alagoas |
| logradouro | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Rua em que o pré-colaborador reside |
| complemento | | Etapa envio de documentos, ao acessar o documento Comprovante de residência | Complemento do logradouro |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| categoria | A, B , C, D, E \nAB, AC, AD \nAE | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | |
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa 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 |
| validade | | Etapa 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-emissor | | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | |
| data-de-emissao | | Etapa 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-registro | | Etapa envio de documentos, ao acessar o documento Carteira de Habilitação (CNH) | |
| data-da-primeira-habilitacao | | Etapa 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 |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero | | Etapa envio de documentos, ao acessar o documento Cartão Nacional de Saúde (CNS) | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero-do-cpf | | Etapa envio de documentos, ao acessar o documento CPF | A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| grau_instrucao | Analfabeto, \nEnsino fundamental l incompleto, \nEnsino fundamental I completo, \nEnsino fundamental Il incompleto, \nEnsino fundamental IlI completo, \nEnsino médio incompleto, \nEnsino médio completo, \nEducação superior incompleta, \nEducação superior completa, \nPós-graduação completa, \nMestrado completo, \nDoutorado completo | Etapa envio de documentos, ao acessar o documento Comprovante de Escolaridade | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero | | Etapa envio de documentos, ao acessar o documento ** Comprovante de PIS/Pasep** | A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x \nO preenchimento desse campo é obrigatório mesmo para primeiro emprego. O número do PIS do primeiro emprego pode ser retirado na agência da Caixa ou enviado pela empresa. \nCaso a empresa tenha o 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. |
| true, false | Etapa envio de documentos, ao acessar o documento ** Comprovante de PIS/Pasep** | Campo obrigatório. |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero-ra | | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | A Gupy envia a informação no seguinte formato: xxx.xxxxx.xx-x |
| regiao-militar | | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | |
| orgao-expeditor | | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | |
| uf-de-expedicao | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | Para esse campo a Gupy envia a sigla de cada Estado, exemplo: "AL" para Alagoas |
| situacao-militar | | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | |
| categoria-militar | | Etapa envio de documentos, ao acessar o documento Certificado de Reservista | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero | | Etapa 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 |
| uf | | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | |
| data-de-emissao | | Etapa 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-expedicao | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa 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-registro | | Etapa 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-validade | | Etapa 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-profissional | Conselho Regional de Administração - CRA, \nConselho Regional de Artquitetura e Urbanismo - CAU, \nConselho Regional de Biblioteconomia - CRB, \nConselho Regional de Biologia - CRBIO, \nConselho Regional de Biomedicina - CRBM, \nConselho Regional de Contabilidade - CRC, \nConselho Regional de Corretores de Imóveis - CRECI, \nConselho Regional de Economia - CORECON, \nConselho Regional de Educação Física - CREF, \nConselho Regional de Educadores e Pedagogos - CREP, \nConselho Regional de Enfermagem - COREN, \nConselho Regional de Engenharia e Agronomia - CREA, \nConselho Regional de Farmácia - CRF, \nConselho Regional de Fisioterapia e Terapia Ocupacional - CREFITO, \nConselho Regional de Medicina - CRM, \nConselho Regional de Medicina Veterinária - CRMV, \nConselho Regional de Odontologia - CRO, \nConselho Regional de Psicologia - CRP, \nConselho Regional de Química - CRQ, \nConselho Regional de Relações Públicas - CONRERP, \nConselho Regional de Representantes Comerciais - CORE, \nConselho Regional de Serviço Social - CRESS, \nConselho Regional de Técnicos Agrícolas - CRTA, \nConselho Regional de Técnicos Industriais - CRT, \nConselho Regional e Fonoaudiologia - CREFONO, \nOrdem dos Advogados do Brasil - OAB, \nOrdem dos Músicos do Brasil - OMB | Etapa envio de documentos, ao acessar o documento Documento de Identificação Profissional (DIP) | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero | | Etapa envio de documentos, ao acessar o documento ** Título de Eleitor** | A Gupy envia a informação no seguinte formato: xxxx xxxx xxxx |
| zona | | Etapa envio de documentos, ao acessar o documento ** Título de Eleitor** | |
| secao | | Etapa envio de documentos, ao acessar o documento ** Título de Eleitor** | |
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa 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-emissao | | Etapa envio de documentos, ao acessar o documento ** Título de Eleitor** | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| tipo_deficiencia | Auditiva, \nFísica, \nIntelectual, \nMental, \nVisual | Etapa envio de documentos, ao acessar o documento ** Laudo Médico** | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| numero-ctps | | Etapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)** | |
| serie-ctps | | Etapa envio de documentos, ao acessar o documento ** Carteira de Trabalho (CTPS)** | |
| uf-emissor | Consulte o Código do Estado em nossas tabelas auxiliares clicando aqui | Etapa 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-emissao | | Etapa 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 |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| data_exame | | Etapa 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 |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| sexo | Feminino \nMasculino | Etapa 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 |
| casado | Sim, \nNão | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| filhos | Sim, \nNão | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| numero-crnm | | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| data-emissao | | Etapa 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 |
| classificacao | Fronteiriço, \nResidente, \nProvisório | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| data-validade | | Etapa 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 |
| nacionalidade | | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| nome-completo | | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| orgao-emissor | | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| data-nascimento | | Etapa 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-brasil | | Etapa 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-visto | Cortesia, \nDiplomático, \nOficial, \nPermanente, \nTemporário, \nTrânsito, \nTurista | Etapa envio de documentos, ao acessar o documento ** Carteira de Registro Nacional Migratório (CRNM)** | |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| banco | | Etapa envio de documentos, ao acessar o documento ** Dados bancários** | |
| conta | | Etapa envio de documentos, ao acessar o documento ** Dados bancários** | Esse campo não é passado com o dígito |
| digito | | Etapa envio de documentos, ao acessar o documento ** Dados bancários** | |
| agencia | | Etapa envio de documentos, ao acessar o documento ** Dados bancários** | Esse campo não é passado com o dígito. |
| CAMPO NO BACKEND | OPÇÕES BACKEND | CAMPO NO FRONTEND | OBSERVAÇÕES |
|---|
| cpf | | Etapa envio de documentos, ao acessar o documento ** Dependentes** | A Gupy envia a informação no seguinte formato: xxx.xxx.xxx-xx |
| birthDate | | Etapa envio de documentos, ao acessar o documento ** Dependentes** | O formato de data enviado pela Gupy é como no exemplo: 2029-12-12T03:00:00.000Z |
| name | | Etapa envio de documentos, ao acessar o documento ** Dependentes** | Nome do dependente |
| birthLocation | | Etapa envio de documentos, ao acessar o documento ** Dependentes** | Local de nascimento |
| handicapped | true, false | Etapa envio de documentos, ao acessar o documento ** Dependentes** | Campo que traz a informação se o dependente possui deficiencia |
| dependentTypeId | Consulte ID DO TIPO DE DEPENDENTE em nossas tabelas auxiliares para obter a lista de cada dependentTypeId, clicando aqui | Etapa 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. |
| gender | Feminino, \nMasculino | Etapa envio de documentos, ao acessar o documento ** Dependentes** | |
| cityOfOrigin | A Gupy envia o nome da cidade da mesma forma que está cadastrado no IBGE | Etapa envio de documentos, ao acessar o documento ** Dependentes** | Cidade de nascimento do dependente |
| stateOfOrigin | Consulte Nome do Estado em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento ** Dependentes** | Estado de nascimento do dependente |
| countryOfOrigin | Consulte **Nome do País ** em nossas tabelas auxiliares clicando aqui | Etapa envio de documentos, ao acessar o documento ** Dependentes** | País de nascimento do dependente |
| includeIncomeTax | true, false | Etapa 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." |
| includeSalarioFamilia | true, false | Etapa 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. |
| hasIdentificationDocument | true, false | Etapa envio de documentos, ao acessar o documento ** Dependentes** | |
| tipo-deficiencia | Auditiva, \nFísica, \nIntelectual \nMental, \nVisual | Etapa envio de documentos, ao acessar o documento ** Dependentes** | |
🚧
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.
