Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Documentos e tipos de pessoas por contexto
Loading...
Loading...
Listagem de documentos
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Entendendo a API do Unico People
A API do unico | people utiliza uma arquitetura em REST e comunicação padrão em JSON. É possível encontrar mais detalhes, nos links a seguir, sobre os temas: REST e JSON.
O primeiro passo é adquirir uma conta de serviço e se autenticar, detalhado no tópico Autenticação.
Para criação de Posição, exportação em formato JSON ou alteração de Status de Posição, acesse aqui.
Caso esteja buscando chamadas de criar ou listar Cargos, ou Departamentos acesse os links.
Caso esteja buscando as chamadas de Exportação de Posição em arquivo (csv, txt, xml...), ou a listagem completa de campos e documentos, veja a seção UNICO PEOPLE V2.
Para utilizar interações server-to-server, é preciso solicitar a criação da conta de serviço com o gerente de projetos responsável pela sua empresa enviando os seguintes dados: nome da empresa, nome da aplicação, nome, e-mail e celular do responsável pela aplicação na empresa. É preciso criar contas diferentes para os ambientes de Homologação e Produção.
Após o recebimento desses dados, será criada uma conta de serviço responsável por autenticar a sua aplicação e enviaremos um e-mail para que seja gerado o par de chaves para a conta.
Uma credencial de conta de serviço inclui um nome único de conta, um identificador da empresa (Tenant ID) e ao menos um par de chaves (pública e privada). Ao final da geração das chaves, você recebe apenas a chave privada (arquivo .key.pem), bem como o payload que deve ser utilizado para montar o JWT. Este payload terá o seguinte formato:
Caso precise da chave pública para configurar em seu sistema, contate o gerente de projetos responsável por sua conta. Também é possível gerar uma chave pública através do comando openssl a seguir:
account*
string
UID da account
order*
string
Ordena o resultado dos grupos de benefícios de forma crescente e decrescente ("desc" e "asc").
sort
string
Ordena o resultado dos grupos de benefícios por "name", "title", "created" e "updated".
skip
integer
Indica a quantidade de grupos de benefícios que serão pulados (paginação).
limit
integer
Limite de grupos de benefícios que serão listados(paginação).
category*
string
UID da categoria que deseja filtrar.
Modelos de carta para abertura de conta bancária
GET
https://api.acessorh.com.br/v1/models
Este endpoint lista os modelos de carta cadastrados na empresa.
Query Parameters
sort*
string
Ordena os resultados dos modelos por "name" e "updated".
type*
string
UID do tipo de modelo cadastrado.
skip
integer
Indica a quantidade de modelos que serão pulados(paginação)
limit
integer
Limite de modelos que serão listados(paginação)
account*
string
UID da empresa onde os modelos estão cadastrados.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (Bearer).
Padrão de contratação aplicado com base nas leis e princípios do Brasil.
Criação e exportação de posições
Posições são as vagas, convites para os candidatos iniciarem o preenchimento do "application" (formulário). Dentro da position estarão todos os dados preenchidos na criação da vaga, quanto os dados preenchidos pelo candidato (Pessoas e Documentos).
POST
https://api.acessorh.com.br/v2/positions
Cria uma posição na filial selecionada. Caso utilize as funcionalidades de Guia de Exame Médico e Carta de Abertura de Conta Bancária, será necessário antes criá-las através da chamada de Upload de Arquivos e então referenciar seus UIDs nos campos de Guia e Carta.
Path Parameters
Authorization*
string
Token ded acesso adquirido pela plataforma Identity(Bearer)
Chave
Tipo
Descrição
numMatricula
string
Número da matrícula
limitDate*
string, format("YYYY-mm-dd")
Data limite para o preenchimento do cadastro
admissionDate
string, format("YYYY-mm-dd")
Data de admissão
costCenter
string
Centro de custo
posNumber
string
Número da posição
role*
string
UID ou código do cargo indicado para a vaga
department*
string
UID ou código do departamento indicado para a vaga
unitID*
string
UID da filial onde a posição será criada.
pagamento*
object
Informações sobre o pagamento
deficiencia*
boolean
Indica se a vaga é PCD
jornada
string
Informações sobre a jornada de trabalho
profile*
object
Informações de contato do candidato
exame*
object
Informações sobre o agendamento de exame médico
docs
array[string]
UIDs dos documentos adicionais a serem solicitados para a vaga
benefits
array[string]
UIDs dos grupos de benefícios.(Obs.: Deverá ter apenas um por categoria.)
sendSMS*
boolean
Indica a necessidade do envio da notificação para o candidato através de um SMS
sendEmail*
boolean
Indica a necessidade do envio da notificação para o candidato através de um e-mail
Chave
Tipo
Descrição
vinculo*
string (options)
Vínculo empregatício
valor
string
Valor da remuneração
recorrencia
string (options)
Recorrência do pagamento
dataInicio
string, format("YYYY-mm-dd")
Data de início do contrato de estágio ou aprendiz
dataTermino
string, format("YYYY-mm-dd")
Data de término do contrato de estágio ou aprendiz
agenteIntegrador
string(options)
Agente integrador do contrato de estágio ou aprendiz
contaBancaria
object
Dados referentes à configuração de cartas de abertura de conta
Os campos de recorrencia
e de valor
são interdependentes. Caso um seja preenchido o outro se torna required.
Opções de vínculo
Opções de recorrência
Opções de agente integrador
Conta bancária
Chave
Tipo
Descrição
banco*
string(options)
Código do banco do qual a carta de abertura de conta se refere
carta
string
UID do arquivo contendo a carta de abertura de conta
template*
string
UID do modelo de abertura de conta
Caso queira criar a posição com uma carta de abertura de conta anexada, é necessário realizar o seu upload antes.
Apenas uma opção deve ser escolhida: carta ou template.
O ID do modelo de carta pode ser encontrado no próprio módulo de criação dentro do Acesso RH.
Opções de banco
Profile
Chave
Tipo
Descrição
name*
string
Nome do candidato
email*
string
E-mail do candidato
mobile*
string, format("11911111111")
Número do celular do candidato
Exame
Chave
Tipo
Descrição
clinica*
string
UID ou código da clínica
data
string, format("YYYY-mm-dd")
Data do agendamento
hora
string, format("HH:MM")
Hora do agendamento
obs
string
Observações do agendamento
guia
string
UID do arquivo contendo a guia do exame médico
Obs: Os campos data, hora e obs, não são obrigatórios mas é indicado que eles sejam preenchidos pois são essas informações que serão disponibilizadas para os candidatos no momento do preenchimento da vaga.
*guia: Caso queira criar a posição com uma guia de exame médico anexada, é necessário realizar o seu upload antes.
POST
https://api.acessorh.com.br/v2/positions/export
Exporta posições conforme o filtro informado no formato selecionado.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Chave
Tipo
Descrição
account
string
UID da empresa
units
array[string]
UID das filiais
limit
integer
Quantidade limite de resultados (paginação)
skip
integer
Quantidade de resultados a serem pulados (paginação)
template*
string(options)
Formatação do resultado da consulta
templateOptions
object
Opções complementares à formatação do resultado
sort
string(options)
Ordenação dos resultados
status
string(options)
Filtro de status das posições
dates
object
Filtro de resultado por data
Um dos dois parâmetros,account
ou units,
deve ser enviado.
O máximo de resultados permitidos em uma requisição é 100. Caso o parâmetro limit
não seja enviado, ele será definido como 100.
Opções de sort
As opções que contem o símbolo -
no início, são utilizadas quando a ordenação desejada é decrescente.
Opções de status
Status
Descrição
pending
Posições pendentes de preenchimento
review
Posições em correção após análise
validation
Posições em análise
completed
Posições preenchidas e validadas
archived
Posições arquivadas
Filtro por data
Chave
Tipo
Descrição
admissionDate
object
Range da data de admissão do candidato
Range de datas
Chave
Tipo
Descrição
start*
string
Data início
end*
string
Data fim
Criação e listagem de webhooks
Webhook é o serviço de notificação sistêmica, que permite a integração assíncrona entre sistemas, notificando o outro sistema através de um gatilho.
Ao configurar um webhook você poderá utilizar alguns modelos de autenticação, que garantem maior confiança na fonte que está se comunicando com o seu endpoint.
O webhook possui uma função de Retry, a qual irá realizar uma nova tentativa a cada 5 segundos por 3 dias (quando a requisição será abandonada). Durante o período, todas as requisições deste webhook que falharem ficarão em fila, sendo apenas uma tentativa (desta configuração de webhook) a cada 5 segundo. Uma vez que o serviço receba o Ok de seu endpoint, as requisições serão liberadas em sequência, ou seja, uma de cada vez.
POST
https://api.acessorh.com.br/v1/integrations/webhook
Cria uma integração via webhook que é disparado para a api cadastrada quando determinados eventos relacionados a posição ocorrerem.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
account*
string
UID da empresa desejada.
unit
string
UID da filial desejada.
authorization
object
Método de autenticação a ser realizado.
data*
object
Configuração do callback que será realizado.
Caso o parâmetro unit
não seja passado, o callback será executado para todas as filiais da empresa.
Authorization
Para proteger as requisições de callback do webhook, é possível selecionar três opções: basic , secret ou apiKey. Cada uma das opções requer configurações diferentes as quais você pode encontrar mais abaixo.
Chave
Tipo
Descrição
kind*
string (options)
Tipo da autenticação que será realizada.
data*
object
Configuração do tipo de autenticação escolhido.
Opções de kind
Authorization: data (basic)
Na opção basic, o callback será executado com um header Authorization: basic <credenciais>. As credenciais serão o usuário e senha concatenados por dois pontos (:) e codificados em base64.
Chave
Tipo
Descrição
username*
string
Nome do usuário.
password*
string
Senha do usuário.
Authorization: data (secret)
Na opção secret, a intenção é que o recebedor consiga se certificar de que o callback recebido foi realizado pelo Acesso RH. Por isso, o callback será executado com um header Acesso-Signature: <assinatura>, sendo a assinatura um hash criado para cada payload. O Acesso RH utiliza um HMAC em conjunto com uma chave sha256 e o secret configurado para calcular e gerar esta assinatura, codificando-a em base64. O mesmo procedimento deve ser realizado na aplicação que receberá esta requisição, comparando a chave gerada e a presente no header. Aqui alguns exemplos de como criar esta verificação.
Chave
Tipo
Descrição
secret*
string
Chave que assinará a requisição.
ApiKey: data (apiKey)
Na opção apiKey, o callback será executado com um header Authorization: <prefix> <key>. Onde o prefix é um campo opcional e key a chave da apiKey. Prefix e key são separados por um espaço em branco.
key*
string
Chave da apiKey
prefix
string
Prefixo opcional que pode acompanhar o valor da apiKey.
Data
Neste ponto serão cadastrados o gatilho ou "trigger" do webhook (motivo pelo qual a chamada do webhook acontecerá), e a URL a qual receberá este aviso.
Chave
Tipo
Descrição
url*
string
URL para a execução do callback. Aceito apenas
endereços HTTPS.
events*
Lista de eventos que este webhook irá acompanhar
para executar o callback.
Eventos monitorados
Os eventos que poderão ser acompanhados pelos webhooks são:
position-created (uma posição foi criada na empresa/filial configurada);
position-applied (um candidato aplicou em uma posição na empresa/filial configurada);
position-completed (uma posição foi concluída pela análise do Acesso RH ou manualmente pelo DP da empresa/filial configurada);
position-archived (uma posição foi arquivada pelo DP da empresa/filial configurada);
position-declined (uma posição que foi declinada da vaga).
Abaixo, seguem alguns exemplos de códigos para calcular a assinatura do payload quando a opção secret for configurada nos webhooks:
C#
Go
Java
Python 3
Headers
Header
Descrição
Acesso-Delivery-Id
UID do callback
Acesso-Signature
Caso a opção Secret tenha sido selecionada em
Authorization, armazena a assinatura do body da requisição
Authorization
Caso a opção Basic ou ApiKey tenha sido selecionada em Authorization. Para Basic esse header armazena o usuário e senha concatenados e
codificados em base64, enquanto para ApiKey será a própria key pura com o prefixo caso tenha sido cadastrado.
Content-Type
Identifica o tipo do body da requisição
Body
PUT
https://api.acessorh.com.br/v1/integrations/webhook
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Chave
Tipo
Descrição
id*
string
UID do webhook a ser atualizado.
account*
string
UID da empresa do webhook a ser atualizado.
unit*
string
UID da filial a ser atualizado no webhook.
authorization*
object
Método de autenticação a ser atualizado.
data*
object
Configurações do webhook que serão atualizados.
Para atualização, pelo menos um dos campos unit
, authorization
edata
deverão ser preenchidos.
Qualquer um dos campos unit
, authorization
e data
, caso não preenchidos, manterão as informações anteriores.
GET
https://api.acessorh.com.br/v1/integrations/webhooks
Query Parameters
account*
string
UID da empresa onde os webhooks serão listados.
skip
integer
Indica a quantidade de webhooks que serão pulados (paginação).
limit
integer
Limite de webhooks que serão listados (paginação).
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Caso não seja inserido os parâmetros limit
e skip
, os valores padrões serão, respectivamente, 100 e 0.
O parâmetro limit
tem o seu valor máximo como 100.
DELETE
https://api.acessorh.com.br/v1/integrations/webhook
Query Parameters
uid*
string
UID do webhook a ser removido.
account*
string
UID da empresa onde o webhook será removido.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
POST
https://api.acessorh.com.br/v1/integrations/webhook/ping
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Chave
Tipo
Descrição
id*
string
UID do webhook que será testado.
account*
string
UID da empresa do webhook que será testado.
GET
https://api.acessorh.com.br/v1/integrations/webhook/deliveries
Query Parameters
uid*
string
UID do webhook onde as entregas serão listadas.
account**
string
UID da empresa na qual o webhook pertence.
skip
string
Indica a quantidade de entregas que serão puladas (paginação)
limit
string
Limite de entregas que serão listadas (paginação)
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
GET
https://api.acessorh.com.br/v1/integrations/webhook/delivery
Query Parameters
uid*
string
UID da entrega a ser exibida.
account*
string
UID da empresa do webhook do qual a entrega solicitada pertence.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Consulta e listagem de organização, grupos, empresas e filiais
Por organização nos referimos ao ambiente, instância, conjunto de empresas, grupos e filiais. Organização é o maior nível que engloba todos os abaixo, seguido por grupo (group), empresa (account) e filial (unit).
GET
https://api.acessorh.com.br/v2/organization
Lista todos os grupos e empresas da organização.
Headers
Documento adicional. Antecedentes criminal emitido pela delegacia
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Carta de referência de um antigo empregador
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Apólice do seguro veicular do CPF.
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Antecedentes criminal emitido pela Polícia Federal
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Informações referente à pessoa, não estando relacionado à um documento
Campos
O campo união estável
é obrigatório quando o campo estado civil
tiver o valor "solteiro".
Os campos dataAposentadoria
e numeroBeneficio
serão obrigatórios quando o campo aposentado
for true
.
O campo incapaz
é obrigatório apenas quando a pessoa for um dependente.
O campo paisOrigem
é obrigatório quando o campo tipoNacionalidade
tiver o valor "estrangeiro".
Opções de sexo
Opções de identidade de gênero
Opções de orientação sexual
Opções de etnia
Opções de tipo de nacionalidade
Campos
Campos
Opções de relacionamento
Campos
Opções de parentesco
Campos
Documento adicional. Situção cadastral do CPF junto à Receita Federal
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
array[]
Nome
Tipo
Observações
nome*
string
length(1, 255)
nomeSocial
string
length(1, 255)
sexo*
string(options)
identidade de gênero
string(options)
orientação sexual
strings(options)
dataNascimento*
string
format("YYYY-mm-dd")
etnia*
string(options)
estadoCivil*
string(options)
uniaoEstavel*
boolean
celular*
string
length(1, 255)
nacionalidade*
string
tipoNacionalidade*
string(options)
incapaz*
boolean
nomeMae*
string
length(0, 255)
nomePai
string
length(0, 255)
aposentado*
boolean
dataAposentadoria*
string
format("YYYY-mm-dd")
numeroBeneficio*
string
length(1, 255)
paisNascimento
string
length(1, 255)
paisOrigem*
string
length(1, 255)
dataNaturalizacao
string
format("YYYY-mm-dd")
selfie*
voucher
Nome
Tipo
Observações
dependente*
boolean
filhosBrasileiros*
boolean
Nome
Tipo
Observações
relacionamento
string(options)
dependente
boolean
dataCasamento
string
format("YYYY-mm-dd")
Nome
Tipo
Observações
parentesco*
string(options)
length(0, 255)
naoPossuiRg
boolean
ensinoSuperior*
boolean
impostoRenda*
boolean
salarioFamilia*
boolean
Nome
Tipo
Observações
parentesco*
string
length(0, 255)
Nome
Tipo
Observações
numero required
string
length(1, 255)
uf required
string(options)
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
numero
required
string
length(1,255)
placa
optional
string
length(1,255)
comprovantes
[]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
numero
required
string
length(1, 255)
horaEmissao
required
string
format("HH:MM")
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Documento obrigatório. Comprovante de estado civil de Divorciado
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento obrigatório. Comprovante de estado civil de Casado
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Certificado de Capacidade Técnica emitido pela ANAC
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
funcao
required
string(options)
length(1, 255)
ccts
required
[ ]string(options)
length(1, 255)
comprovantes
[ ]voucher
Opções de função
Opções de CCTs
As opções selecionadas definirão quais os comprovantes serão requisitados.
Comprovantes
Nome
Tipo
ppa
optional
voucher
pph
optional
voucher
pca
optional
voucher
pch
optional
voucher
pla
optional
voucher
plh
optional
voucher
ppl
optional
voucher
cpr
optional
voucher
cpd
optional
voucher
cpdct
optional
voucher
inva
optional
voucher
invh
optional
voucher
invp
optional
voucher
invd
optional
voucher
ifr
optional
voucher
rvfra
optional
voucher
rvfrh
optional
voucher
rifra
optional
voucher
rifrh
optional
voucher
rcpd
optional
voucher
cms
optional
voucher
mcv
optional
voucher
dovmodi
optional
voucher
dovmodii
optional
voucher
avi
optional
voucher
cel
optional
voucher
gmp
optional
voucher
Documento adicional. Registro de atualizações junto ao Conselho Regional de Farmacêuticos
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
pagina2
required
voucher
pagina3
required
voucher
pagina5
required
voucher
Documento obrigatório. Comprovante de emancipação de um menor de idade
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento obrigatório. Certificado de dispensa do serviço militar
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
categoria
required
string(options)
length(1, 255)
ra
required
string
length(1, 255)
numero
optional
string
length(1, 255)
serie
optional
string
length(1, 255)
comprovantes
[ ]voucher
Opções de categoria
Comprovantes
Nome
Tipo
Observações
frente
required
voucher
verso
required
voucher
Documento adicional. Carteira Nacional de Saúde, também conhecido como número do SUS
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento obrigatório. Comprovante de União Estável
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento obrigatório. Comprovante de estado civil de Separado
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Nome
Tipo
Observações
numero
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
pagina1
required
voucher
pagina2
required
voucher
pagina3
required
voucher
pagina4
required
voucher
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
inscricao
required
string
length(1,255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
Nome
Tipo
Observações
filiacao1
required
string
filiacao2
optional
string
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Documento adicional. Certificado de conclusão do curso específico de bombeiro
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Certificado de conclusão do curso específico de vigilante
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
optional
voucher
Documento adicional. Carteira Nacional de Habilitação emitido pelo DETRAN
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
validade
required
string
format("YYYY-mm-dd")
dataEmissao
required
string
format("YYYY-mm-dd")
dataPrimeira
required
string
format("YYYY-mm-dd")
orgaoEmissor
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
categoria
required
string
length(1, 255)
remunerado
required
string
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Certificado de atualização do curso específico
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
optional
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
dataEmissao
required
string
format("YYYY-mm-dd")
registro
required
string
length(1,255)
comprovantes
[]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Federal de Educação Física
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
conselho
required
string
length(1, 255)
categoria
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
dataExpedicao
required
string
format("YYYY-mm-dd")
dataValidade
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Certificado de conclusão do curso específico de Vigilante de Segurança Particular Privada
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
optional
voucher
Listagem de anexos
GET
https://api.acessorh.com.br/v1/attachments/:acc
Busca todos os anexos atrelados a uma account.
Path Parameters
acc*
String
ID da account
Query Parameters
limit
String
Quantidade de anexos que devem ser retornados na consulta. Caso não seja passado será retornado os 100 primeiros resultados.
skip
String
Indica a quantidade de anexos que serão pulados (paginação).
Headers
Authorization*
String
Token de acesso adquirido pela plataforma Identity (bearer)
Criação, listagem e delete de cargos
O cargo a ser selecionado na criação de vaga do candidato. Os campos de código, CBO (Classificação Brasileira de Ocupações) e escolaridade mínima são opcionais.
Escolaridade mínima é uma configuração que impede a seleção de uma escolaridade inferior por parte do candidato, assim bloqueando a admissão em caso de ser um pré-requisito para o cargo.
A Classificação Brasileira de Ocupações (CBO) são códigos pré-determinados, padronizados pelo Ministério do Trabalho na tentativa de retratar a realidade das profissões do mercado de trabalho brasileiro. O código a ser inserido deve ser válido. mais info.
Código é um campo aberto para uso de outros sistemas em caso de integração, sendo assim não existe validações neste campo.
POST
https://api.acessorh.com.br/v1/role/json/:acc
Cria um cargo na empresa selecionada.
Path Parameters
acc*
string
UID da empresa onde o cargo será criado
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
code*
string
Código do cargo
name*
string
Nome do cargo
object
Informações específicas por país
Context
object
Informações específicas para o Brasil
Brazil
Chave
Tipo
Descrição
cbo
string
Número do CBO
escolaridadeMinima
Escolaridade mínima permitida para o cargo
Opções de escolaridade mínima
GET
https://api.acessorh.com.br/v1/role/:acc
Lista os cargos da empresa selecionada.
Path Parameters
acc*
string
UID da empresa de onde os cargos serão listados
Query Parameters
limit*
string
Limite de cargos que serão listados (paginação)
skip*
string
Indica a quantidade de cargos que serão pulados (paginação)
code*
string
Código do cargo que deverá ser filtrado
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Caso não seja inserido os parâmetros limit
e skip
, os valores padrões serão, respectivamente, 1000 e 0.
O parâmetro limit
tem o seu valor máximo como 1000.
DELETE
https://api.acessorh.com.br/v1/role
Deleta um cargo da empresa selecionada.
Query Parameters
uid*
string
UID do cargo a ser deletado.
acc*
string
UID da empresa de onde o cargo será deletado.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Após a criação e configuração de uma conta de serviço, sua aplicação precisa completar as seguintes etapas:
Criar um JSON Web Token (JWT), que inclui cabeçalho, payload e assinatura;
Requisitar um token de acesso (AccessToken) da plataforma de autenticação OAuth2;
Tratar a resposta JSON que a plataforma de autenticação retornará.
Se na resposta estiver incluso um token de acesso, você poderá usá-lo para fazer requisições às APIs dos produtos da unico para os quais a conta de serviço possui permissão de acesso. (Se na resposta não estiver incluso um token de acesso, seu JWT e requisição de obtenção do token podem estar incorretos ou a conta de serviço pode não ter as permissões necessárias para acessar os recursos solicitados.)
O token de acesso gerado na requisição mencionada acima tem validade padrão de 3600 segundos, podendo variar de acordo com a configuração de segurança estabelecida para sua empresa. Quando o token de acesso expirar, sua aplicação deverá gerar um novo JWT, fazer a assinatura e requisitar um novo token de acesso na plataforma de autenticação.
Um JWT é composto por três partes: um cabeçalho, um payload e uma assinatura. O cabeçalho e o payload são objetos JSON. Esses objetos JSON são serializados em UTF-8 e então codificados usando codificação Base64url¹. Esta codificação provê resliência contra alterações de codificação em casos de repetidas operações de codificação. O cabeçalho, o payload e a assinatura são concatenadas com um caractere de ponto final ..
Um JWT é composto da seguinte forma:
O texto base para a assinatura é composto pela seguinte forma:
O cabeçalho consiste em dois campos que indicam o algorítimo de assinatura e o formato do token. Ambos os campos são obrigatórios e cada campo possui apenas um valor. Contas de serviço dependem do algorítimo RSA SHA-256 e do formato de token JWT. Como resultado, a representação JSON do cabeçalho se dá da seguinte forma:
A representação em Base64url se dá da seguinte forma:
O payload JWT contém informações sobre o JWT, incluindo as permissões sendo requisitadas (scopes), a conta solicitando acesso, o emissor, o momento em que o token foi emitido e o tempo de vida do token. A maioria dos campos são obrigatórios. Assim como o cabeçalho JWT, o payload é um objeto JSON e é usado na composição da assinatura.
Os campos obrigatórios no JWT são mostrados na tabela abaixo. Eles podem aparecer em qualquer ordem dentro do payload.
iss
O identificador da conta de serviço na empresa.
scope
Uma lista delimitada por espaços ou pelo sinal de positivo +
das permissões que a aplicação está requisitando. Se todas as permissões da conta forem necessárias, utilizar o sinal de asterisco *
para tal.
aud
exp
O tempo de expiração do token, especificado em segundos desde 00:00:00 UTC, 1 de Janeiro de 1970. Este valor tem um tempo máximo de 1 hora após o momento da emissão do JWT. Este valor deve ser numérico. Casos recorrentes que NÃO funcionam: - Uso de aspas na delimitação do valor. Ex.: “1524161193” é uma string e não funcionará. Já 1524161193 é um número e funcionará.
iat
O momento da emissão do JWT, especificado em segundos desde 00:00:00 UTC, 1 de Janeiro de 1970. Este valor deve ser numérico. - Uso de aspas na delimitação do valor. Ex.: “1524161193” é uma string e não funcionará. Já 1524161193 é um número e funcionará.
Entenda como funciona a conversão para os campos de emissão (iat) e expiração (exp) do jwt, e veja também exemplos de utilização dos valores dos campos aqui. Além disso, o campo “iat” deve ser o horário atual no formato exigido e o “exp” deve respeitar a conta abaixo:
A representação dos campos JSON obrigatórios no payload do JWT se dá da seguinte forma:
A especificação JSON Web Signature (JWS)² é a mecânica que guia o cálculo da assinatura para um JWT. O conteúdo de entrada para o cálculo da assinatura é o byte array do seguinte conteúdo:
O mesmo algoritmo sinalizado no cabeçalho do JWT precisa ser utilizado para o cálculo da assinatura. O único algorítimo de assinatura suportado pela plataforma de autenticação OAuth2 é o RSA usando SHA-256. Ele é expressado como RS256 no campo alg do cabeçaho do JWT.
Assine a representação UTF-8 do conteúdo de entrada utilizando SHA256withRSA (também conhecido como RSASSA-PKCS1-V1_5-SIGN com o hash SHA-256) com a chave privada que foi criada e associada à conta de serviço (arquivo .key.pem gerado pela solicitação recebida por e-mail). O conteúdo de saída será um byte array.
A assinatura precisará ser então codificada em Base64url. O cabeçalho, o payload e a assinatura deverão ser concatenadas com o caractere de ponto final .
. O resultado é o JWT. Ele deve ser da seguinte forma:
A seguir está um exemplo de token JWT antes da codificação em Base64url:
Abaixo está um exemplo do JWT que foi assinado e está pronto para transmissão:
Também é possível utilizar bibliotecas previamente estabelecidas para realizar a criação do JWT. Como referência, é possível encontrar uma lista de bibliotecas no site jwt.io.
Após a geração do JWT assinado, uma aplicação pode utilizá-lo para requisitar um token de acesso (Access Token). A requisição do token de acesso é uma requisição POST HTTPS e o corpo deve ser URL encoded. A URL é a mostrada abaixo:
Copiar
Os parâmetros abaixo são obrigatórios na requisição POST HTTPS:
grant_type
Utilize o seguinte texto, URL-encoded se necessário: urn:ietf:params:oauth:grant-type:jwt-bearer
assertion
O JWT, incluindo a assinatura.
Se o JWT e a requisição do token de acesso foram formados apropriadamente e a conta de serviço tem as permissões necessárias, então a resposta da plataforma de autenticação retorna um objeto JSON contendo um token de acesso. Segue um exemplo de resposta da plataforma:
Copiar
O token de acesso retornado no campo “acess_token” do objeto JSON também é um token JWT que deverá ser utilizado nas APIs dos Produtos da unico. Caso retorne um erro na requisição, é possível consultar o tipo do erro na tabela de erros clicando aqui.
A duração do token de acesso é variável. Sua duração é especificada no campo “expires_in”, retornado juntamente com o token de acesso. Deve-se utilizar o mesmo token de acesso durante a sua validade para todas as chamdas às APIs dos produtos.
Não solicite um novo token de acesso até que a validade do token atual esteja chegando ao fim. Sugerimos uma margem de 600 segundos (10 minutos). Para isso execute o cálculo:
Sendo que token.exp é o timestamp da expiração do token.
Por padrão, o token enviado para a empresa tem duração de 1h, mas pode ser alterado. A sugestão é sempre usar o expires_in como base e subtrair 600s dele para pedir um novo token.
Exemplos:
Um novo token de acesso pode ser solicitado quando faltar 10 minutos pra expirar.
Não utilize um tempo fixo para a obtenção de um novo token, pois o tempo de duração do token recebido pode ser menor que o tempo estabelecido, o que ocasionará falha na utilização dos serviços.
¹ De acordo com o RFC 4648 de codificação BaseN, o formato Base64url é similar ao formato Base64, com exceção do caracter = que deve ser omitido, e dos caracteres + e / que devem ser substituídospor - e _, respectivamente.
² JSON Web Signature: https://tools.ietf.org/html/rfc7515.
Nesta seção, você encontrará toda a especificação técnica sobre a forma de autenticação para utilização das APIs REST do Unico People
Para utilizar a plataforma IDCloud é necessário se autenticar via token de acesso, utilizando o sistema de autenticação conhecido como OAuth2.
O sistema de autenticação OAuth2 da unico suporta a interação server-to-server entre uma aplicação web e os serviços da unico.
Para este cenário, você precisará de uma conta de serviço, que é uma conta impessoal que pertence à sua aplicação e não a um usuário individual. Sua aplicação chama as APIs da unico em nome da conta de serviço, portanto usuários não estão diretamente envolvidos. Este cenário é chamado “two-legged OAuth”, ou “2LO”. Tipicamente, uma aplicação utiliza uma conta de serviço quando a aplicação chama as APIs da unico para trabalhar com seus próprios dados ao invés dos dados do usuário.
Este é o passo zero para iniciar sua implementação, portanto não pule esta etapa.
Dúvidas?
Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da .
Upload de arquivos temporários, download e conversão de documentos e imagens
Todas as chamadas de arquivo utilizam o Path (caminho do diretório onde está armazenado o arquivo) como referência. No caso de uma chamada PUT, é utilizado o Path da máquina onde encontra-se armazenado (Exemplo: C:\Computador\Downloads\Arquivo.pdf). Já nas chamadas de GET, utiliza-se o Path do diretório do Acesso RH, que pode ser encontrado na chamada Get Position (Exemplo: "individual/23bcac75-5722-4e14-96a4-72f69322671e/document/7d58e6f3-5201-40b3-b1fb-3e6949d19960/362f2533-b537-4a99-2329-7b56ffb77bfa.jpg")
No caso de precisar enviar um arquivo em alguma chamada (Exemplo: Guia do Exame Médico durante a criação de uma Posição) é necessário que seja feito o upload do arquivo por antecedência e em seguida, seja referenciado na chamada de Create Position usando o UID enviado na response.
Ao realizar o upload de um arquivo, ele permanecerá armazenado por até 15 minutos para que o UID de resposta possa ser utilizado em uma próxima requisição. Caso o UID retornado não seja utilizado durante este tempo, o arquivo será excluído.
As requisições podem ser realizadas em paralelo, mesmo que para a mesma posição, no intuito de reduzir o tempo total de transferência de arquivos.
PUT
https://api.acessorh.com.br/v1/upload
Upload de arquivos temporários
Headers
Request Body
GET
https://api.acessorh.com.br/v1/r/:path
Download de imagens e/ou arquivos no formato original.
Path Parameters
Headers
GET
https://api.acessorh.com.br/v1/t/:options/:path
Download de imagens modificadas pelos parâmetros selecionados.
Path Parameters
Headers
Opções de tamanho e qualidade do arquivo
1000x - tamanho horizontal em pixels da imagem;
1000y - tamanho vertical em pixels da imagem;
80q - diminui a qualidade da imagem para 80%.
Os valores acima são apenas exemplos e podem ser alterados.
O valor t
funciona apenas para arquivos de imagens. Caso queira alterar o tamanho da imagem mantendo a proporção, utilize apenas um dos parâmetros x ou y.
GET
https://api.acessorh.com.br/v1/c/:format/:path
Download de imagens convertidas no formato desejado.
Path Parameters
Headers
Consulta e listagem de organização, grupos, empresas e filiais
Por organização nos referimos ao ambiente, instância, conjunto de empresas, grupos e filiais. Organização é o maior nível que engloba todos os abaixo, seguido por grupo (group), empresa (account) e filial (unit).
GET
https://api.acessorh.com.br/v1/accounts
Lista todos os grupos e empresas da organização.
Headers
GET
https://api.acessorh.com.br/v1/accounts/:account
Lista todas as filiais de uma empresa.
Path Parameters
Headers
Documento obrigatório. Comprovante da escolaridade do candidato
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
As opções do campo instrucao
serão limitadas conforme a escolaridade mínima escolhida nas configurações do cargo.
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento obrigatório. Comprovante do Endereço residencial do candidato
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Opções de titular
Comprovantes
O comprovante declaracao
será requisitado apenas se o valor do campo titular
for "terceiro".
Documento adicional. Carteira Nacional de Vigilante
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Caso o campo possui
possua o valor false
, apenas o comprovante carimbo
será solicitado.
Documento adicional. Carteira e/ou comprovantes de vacinação
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
O campo salarioFamilia
só é solicitado para dependentes.
Comprovantes
Os comprovantes vacina1
, vacina2
, vacina3
e vacina4
são solicitados apenas para o candidato. O comprovante vacina2
será obrigatório apenas se o campo possui
for true
. Os comprovantes capa
e vacinas
são solicitados apenas para dependentes.
Criação, listagem e delete de departamentos
POST
https://api.acessorh.com.br/v1/department/json/:acc
Cria um departamento na empresa selecionada.
Path Parameters
Headers
GET
https://api.acessorh.com.br/v1/department/:acc
Lista os departamentos da empresa selecionada.
Path Parameters
Query Parameters
Headers
Caso não seja inserido os parâmetros limit
e skip
, os valores padrões serão, respectivamente, 1000 e 0.
O parâmetro limit
tem o seu valor máximo como 1000.
DELETE
https://api.acessorh.com.br/v1/department
Deleta um departamento da empresa selecionada.
Query Parameters
Headers
string()
Endereço da plataforma de autenticação que faz a emissão de tokens de acesso. Este valor deverá ser sempre e exatamente Casos recorrentes que NÃO funcionam: - Inserção de uma barra ao final do endereço: - Uso do protocolo HTTP ao invés de HTTPS:
path*
string
Caminho do arquivo desejado
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
options*
string
Opções de modificação do arquivo
path*
string
Caminho do arquivo desejado
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
format*
string
Formato no qual o arquivo será convertido
path*
string
Caminho do arquivo desejado
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
account
string
UID da empresa desejada
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Nome
Tipo
frente
required
voucher
declaracao
required
voucher
acc*
string
UID da empresa de onde os departamentos serão listados
limit
string
Limite de departamentos que serão listados (paginação)
skip
string
Indica a quantidade de cargos que serão pulados (paginação)
code*
string
Código do departamento a ser filtrado
Authorization
string
Token de acesso adquirido pela plataforma de Identity (bearer)
uid*
string
UID do departamento a ser deletado.
acc*
string
UID da empresa de onde o departamento será deletado.
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
Nome
Tipo
Observações
instrucao
required
string(options)*
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
comprovantes
[]voucher
Nome
Tipo
cnis
required
voucher
Nome
Tipo
Observações
cep
required
string
length(1, 255)
tipoLogradouro
required
string(options)
length(1, 255)
logradouro
required
string
length(1, 255)
numero
required
string
length(1, 255)
complemento
optional
string
length(1, 255)
bairro
required
string
length(1, 255)
cidade
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
titular
required
string(options)
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
possui
required
boolean
comprovantes
[ ]voucher
Nome
Tipo
frente
required*
voucher
verso
required*
voucher
carimbo
required
voucher
Nome
Tipo
Observações
possui
required
boolean
salarioFamilia
required*
boolean
comprovantes
[ ]voucher
Nome
Tipo
vacina1
required*
voucher
vacina2
required*
voucher
vacina3
optional*
voucher
vacina4
optional*
voucher
capa
required*
voucher
vacinas
required*
voucher
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
file*
string
Path do arquivo que será carregado
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
acc*
string
UID da empresa onde o cargo será criado
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
code*
string
Código do departamento
name*
string
Nome do departamento
Listagem de códigos IBGE
GET
https://api.acessorh.com.br/v1/ibge/code
Lista o código IBGE do município.
Query Parameters
uf*
string
Sigla do estado a ser consultado.
city*
string
Município a ser consultado.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (Bearer)
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Identificação dos dados bancários para pagamento de salário
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campo
Nome
Tipo
Observações
banco
required
string
length(1, 255)
tipo_conta
required
string(options)
length(1, 255)
agencia
required
string
length(1, 255)
conta
required
string
length(1, 255)
digito
required
string
length(1, 255)
comprovantes
[ ]voucher
Opções de tipo de conta
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Comprovante de voto
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Comprovante de vacinação COVID-19
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
doses
required
string(options)
Referente a quantidade de doses de vacinas contra o COVID-19 que a pessoa tomou. Se a pessoa não tomou nenhuma dose, os campos abaixo não serão solicitados.
vacinas
*required
[ ]vacinas
Informações sobre as vacinas tomadas.
certificadoSUS
*required
bool
Indica se a pessoa possui ou não o certificado digital do conect SUS.
comprovantes *required
[ ]voucher
Foto dos comprovantes de vacinação. Se a pessoa informar que possui o certificado digital, apenas um voucher será solicitado. Caso contrário, duas fotos serão solicitadas.
Os campos de vacinas, certificadoSUS e comprovantes só serão obrigatórios quando o o candidato informar que tomou uma ou mais doses .
Quando o candidato não possuir o esquema vacinal completo(nenhuma dose ou apenas uma dose de qualquer vacina que não seja a janssen), uma pendência será gerada para esse candidato e será exibida no dashboard.
Opções de doses
Vacinas
nome required
Lista com o nomes das vacinas disponíveis.
data required
string
Data que a pessoa domou a vacina. format("YYYY-mm-dd")
Opções de nomes de vacinas
Comprovantes
capa required
Foto da capa da carteirinha física ou foto do certificado digital. voucher
interior
required
Foto do interior da carteirinha física. voucher
Criação e listagem de posições
Posições são as vagas, convites para os candidatos iniciarem o preenchimento do "application" (formulário). A criação da posição é uma replica do preenchimento no Dashboard, passando as informações básicas para a identificação do candidato e geração do check-list.
Caso utilize as funcionalidades de Guia de Exame Médico e Carta de Abertura de Conta Bancária, será necessário antes criá-las através da chamada de Upload de Arquivos e então referenciar seus UIDs nos campos de Guia e Carta.
POST
https://api.acessorh.com.br/v1/account/:unit/json/position
Cria uma posição na filial selecionada.
Path Parameters
unit*
string
UID da filial onde a posição será criada.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Caso a requisição seja realizada com sucesso, o header position-id
, contendo o UID da position criada, será enviado na resposta.
Chave
Tipo
Descrição
num_matricula
string
Número da matrícula
limit_date*
string, format("YYYY-mm-dd")
Data limite para o preenchimento do cadastro
admission_date
string, format("YYYY-mm-dd")
Data de admissão
cost_center
string
Centro de custo
pos_number
string
Número da posição
role*
string
UID ou código do cargo indicado para a vaga
department*
string
UID ou código do departamento indicado para a vaga
pagamento*
object
Informações sobre o pagamento
deficiencia*
boolean
Indica se a vaga é PCD
jornada
string
Informações sobre a jornada de trabalho
profile*
object
Informações de contato do candidato
exame
object
Informações sobre o agendamento de exame médico
docs
array[string]
UIDs dos documentos adicionais a serem solicitados para a vaga
benefits
array[string]
UIDs dos grupos de benefícios.(Obs.: Deverá ter apenas um por categoria.)
send_sms*
boolean
Indica a necessidade do envio da notificação para o candidato através de um SMS
send_email*
boolean
Indica a necessidade do envio da notificação para o candidato através de um e-mail
Pagamento
Chave
Tipo
Descrição
vinculo*
string (options)
Vínculo empregatício
valor
string
Valor da remuneração
recorrencia
string (options)
Recorrência do pagamento
dataInicio
string, format("YYYY-mm-dd")
Data de início do contrato de estágio ou aprendiz
dataTermino
string, format("YYYY-mm-dd")
Data de término do contrato de estágio ou aprendiz
agenteIntegrador
string(options)
Agente integrador do contrato de estágio ou aprendiz
contaBancaria
object
Dados referentes à configuração de cartas de abertura de conta
Os campos de recorrencia
e de valor
são interdependentes. Caso um seja preenchido o outro se torna required.
Opções de vínculo
Opções de recorrência
Opções de agente integrador
Conta bancária
Chave
Tipo
Descrição
banco*
string(options)
Código do banco do qual a carta de abertura de conta se refere
carta
string
UID do arquivo contendo a carta de abertura de conta
template
string
UID do modelo de abertura de conta
Caso queira criar a posição com uma carta de abertura de conta anexada, é necessário realizar o seu upload antes.
Apenas uma opção deve ser escolhida: carta ou template.
O ID do modelo de carta pode ser encontrado no próprio módulo de criação dentro do Acesso RH.
Opções de banco
Profile
Chave
Tipo
Descrição
name*
string
Nome do candidato
email*
string
E-mail do candidato
mobile*
string, format("11911111111")
Número do celular do candidato
Exame
Chave
Tipo
Descrição
clinica*
string
UID ou código da clínica
data
string, format("YYYY-mm-dd")
Data do agendamento
hora
string, format("HH:MM")
Hora do agendamento
obs
string
Observações do agendamento
guia
string
UID do arquivo contendo a guia do exame médico
Obs: Os campos data, hora e obs, não são obrigatórios mas é indicado que eles sejam preenchidos pois são essas informações que serão disponibilizadas para os candidatos no momento do preenchimento da vaga.
*guia: Caso queira criar a posição com uma guia de exame médico anexada, é necessário realizar o seu upload antes.
GET
https://api.acessorh.com.br/v1/positions/:position
Exibe a posição selecionada.
Path Parameters
position*
string
UID ou código da posição desejada
Query Parameters
unit*
string
UID da filial do qual a posição pertence
includes
string
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Campos opcionais | includes
GET
https://api.acessorh.com.br/v1/positions
Lista posições na empresa ou filial selecionada.
Query Parameters
admission_date
string
Data de admissão início e fim Formato: AAAA-MM-DD,AAAA-MM-DD
acc
string
UID da empresa ou da filial que será filtrada
status
string
Filtro de status das posições
position_number
string
Código da posição desejada
limit
string
Limite de posições que serão listadas (paginação)
skip
string
Indica a quantidade de posições que serão puladas (paginação)
sort
string
Configura um parâmetro de ordenação do resultado da listagem de posições com base nas opções.
order
string
Ordena o resultado de forma crescente e decrescente ("asc" e "desc").
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Caso não seja inserido os parâmetros limit
e skip
, os valores padrões serão, respectivamente, 100 e 0.
O parâmetro limit
tem o seu valor máximo como 100.
Parâmetros para ordenação das posições
limit_date
string
Data limite para o preenchimento do cadastro.
admission_date
string
Data de admissão preenchida no cadastro da vaga.
created_date
string
Data em que o cadastro foi criado.
updated_date
string
Ultima data de atualização do cadastro.
completed_date
string
Data de finalização do cadastro.
Opções de ordenação
asc
string
Ordena de forma crescente.
desc
string
Ordena de forma decrescente.
Lista de status
PUT
https://api.acessorh.com.br/v1/positions/status/:position
Altera o status de uma posição.
Path Parameters
position*
string
UID ou código da posição a ser alterada
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Chave
Tipo
Descrição
unit*
string
UID da filial do qual a posição pertence
status*
string(options)
Status no qual a posição será alterada
decline
object
Decline é a estrutura com as informações dos motivos de declínio da posição. *Esse campo é required apenas quando o campo de status for igual a "declined".
Opções de status
A posição só poderá ser arquivada, se ela já estiver completa ou declinada.
Não é possível declinar posições que estão arquivadas.
type*
string
Indica qual foi o lado responsável por decidir declinar do processo de admissão: Candidato (DECLINED_BY_USER) Empresa (DECLINED_BY_HR)
reason*
string(options)
Motivo que levou essa posição a ser declinada. Os motivos devem está de acordo com o type indicado.
description
string
Detalhes do motivo que levou essa posição ser declinada.
message
string
Mensagem customizada que fará parte do e-mail que será enviada para o candidato que teve sua posição declinada.
Tipos de declínio com seus respectivos motivos
sem-retorno-candidato
falta-documento
escolaridade-inferior
sem-vacina-covid
outro
motivos-pessoais
proposta-melhor
nao-tem-interesse
sem-retorno
outro
DELETE
https://api.acessorh.com.br/v1/positions
Deleta uma posição.
Query Parameters
uid*
string
UID da posição a ser deletada.
unit*
string
UID da filial de onde a posição será deletada.
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
PATCH
https://api.acessorh.com.br/v1/positions/:position/benefits
Adiciona e/ou remove benefícios de uma posição
Path Parameters
position*
string
UID ou número da posição a ser alterada
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Chave
Tipo
Descrição
unit*
string
UID da filial onde a posição se encontra
add
array[string]
UIDs dos grupos de benefícios a serem adicionadas na posição
remove
array[string]
UIDs dos grupos de benefícios a serem
removidos da posição
Um dos campos add
ou remove
deverão ser preenchidos.
Não é possível adicionar ou remover benefícios para posições declinadas
POST
https://api.acessorh.com.br/v1/positions/:position_id/signature-envelopes
Realiza o envio do kit admissional para candidatos concluídos.
Path Parameters
position_id*
string
UID da posição que deve receber o kit de documentos para assinatura.
Chave
Tipo
Descrição
account*
string
UID da empresa.
unit*
string
UID da filial onde a posição se encontra.
models*
array[string]
Lista com os UID dos
modelos de documentos
que devem ser enviados
para assinatura.
Não é possível enviar o kit admissional para posições:
Em andamento
Arquivadas
Declinadas
GET
https://api.acessorh.com.br/v1/admissions/invite/:pos
Exibe os link's do convite enviado para a posição iniciar o processo de cadastro dos documentos.
Path Parameters
pos*
string
UID da posição desejada
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Documento obrigatório. Identificação da CTPS do candidato
ID
Slugi
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
serie
required
string
length(1, 255)
uf
required
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
dataValidade
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
O campo dataValidade
só é obrigatório quando o campo tipoNacionalidade
da pessoa tiver o valor "estrangeiro".
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
pagina22
required
voucher
anotacoes
required
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Dados para a emissão do Crachá
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Conselho Regional de Enfermagem
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento obrigatório. Comprovante do Cadastro de Pessoas Físicas
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
string()
Lista com os que podem ser visualizados separados por vírgula
string()
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYY-MM-DD")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
Nome
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
cracha
required
voucher
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
validade
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
numero
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
inscricao
required
string
length(1,255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[]voucher
Nome
Tipo
frente
required
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataExpedicao
required
string
format("YYY-MM-DD")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Engenharia e Agronomia
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
registro
required
string
length(1, 255)
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
voucher
verso
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
cota
required
bool
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
laudoMedico
required
voucher
Documento adicional. Conselho Regional de Contabilidade
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
categoria
required
string
length(1, 255)
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Farmácia
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
tipo
required
string(options)
numero
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
dataValidade
required*
string
format("YYYY-mm-dd")
dataEmissao
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Os campos dataValidade
e dataEmissao
são obrigatórios apenas quando o campo tipo
estiver com o valor "provisoria".
Opções de tipo
Comprovantes
Nome
Tipo
frente
required
voucher
Documento obrigatório. Comprovante de estado civil de Viúvo
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Medicina
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataInscricao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Informações adicionais de certidões
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
data_estado_civil
required
string
format("YYYY-mm-dd")
Documento adicional. Carteira de Habilitação Técnica emitido pela ANAC
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
funcao
required
string
length(1, 255)
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Nutrição
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Informações adicionais referentes ao documento Exame Médico
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Nome
Tipo
Observações
numero
required
string
length(1, 255)
tipo
required
string
length(1, 255)
dataValidade
required
string
format("YYYY-mm-dd")
dataEmissao
required
string
format("YYYY-mm-dd")
conselho
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
banco
required
string
length(1, 255)
agencia
required
string
length(1, 255)
conta
required
string
length(1, 255)
digito
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
crm
required
string
length(1, 255)
data
required
string
format("YYYY-mm-dd")
uf
required
string(options)
medico
required
string
length(1, 255)
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataExpedicao
required
string
format("YYYY-MM-DD")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Imagens das páginas de Contrato de Tabalho da CTPS
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
pagina1
required
voucher
pagina2
optional
voucher
pagina3
optional
voucher
pagina4
optional
voucher
pagina5
optional
voucher
pagina6
optional
voucher
pagina7
optional
voucher
pagina8
optional
voucher
pagina9
optional
voucher
pagina10
optional
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
pagina1
required
voucher
pagina2
optional
voucher
pagina3
optional
voucher
pagina4
optional
voucher
pagina5
optional
voucher
pagina6
optional
voucher
pagina7
optional
voucher
pagina8
optional
voucher
pagina9
optional
voucher
pagina10
optional
voucher
Documento obrigatório. Comprovante do Contrato de Estágio
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
instrucao
required
string(options)
length(0, 255)
nome
required
string
length(0, 255)
cep
required
string
length(1, 255)
tipoLogradouro
required
string(options)
length(0, 255)
logradouro
required
string
length(0, 255)
numero
required
string
length(1, 255)
complemento
optional
string
length(0, 255)
bairro
required
string
length(1, 255)
cidade
required
string(options*)
length(0, 255)
uf
required
string(options)
length(0, 255)
cnpj
required
string
length(0, 255)
nivel
required
string
length(0, 255)
comprovantes
[ ]voucher
As opções do campo cidade
dependem do valor selecionado no campo uf
.
Comprovantes
Nome
Tipo
primeiraPagina
required
voucher
assinaturas
required
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
ano
required
string
length(1, 255)
placa
required
string
length(1, 255)
possuiGnv
required
bool
terceiro
required
bool
adquiridoRecente
required
bool
cpfProprietario
required
string
length(1, 255)
renavam
required
string
length(1, 255)
chassi
optional
string
length(1, 255)
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
certificadoSeguranca
required*
voucher
procuracaoTerceiro
required*
voucher
certificadoCompraVenda
required*
voucher
O voucher certificadoSeguranca
só será obrigatório quando o campo possuiGnv
for true
.
O voucher procuracaoTerceiro
só será obrigatório quando o campo terceiro
fortrue
.
O voucher certificadoCompraVenda
só será obrigatório quando o campo adquiridoRecente
for true
Documento obrigatório. Laudo de comprovação de deficiência
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
deficiencias
required
[ ]string(options)
comprovantes
[ ]voucher
Opções de deficiências
Comprovantes
Nome
Tipo
frente
required*
voucher
verso
required*
voucher
fisica
required
voucher
visual
required
voucher
auditiva
required
voucher
mental
required
voucher
reabilitado
required
voucher
fisicaMTE
required
voucher
visualMTE
required
voucher
auditivaMTE
required
voucher
mentalMTE
required
voucher
reabilitadoMTE
required
voucher
Os comprovantes frente
e verso
serão solicitados apenas para os dependentes do candidato. Todos os demais comprovantes serão solicitados caso o candidato os tenha selecionado no campo deficiencias
.
Documento adicional. Comprovante do ASO
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Ordem dos Advogados do Brasil
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Nome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
numero
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento obrigatório. Comprovante dos dados do candidato em caso de estrangeiro
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
pais
required
string(options)
length(1, 255)
tipoVisto
required
string
length(1, 255)
rne
required
string
length(1, 255)
classificacao
required
string
length(1, 255)
orgaoEmissor
required
string
length(1, 255)
dataChegada
required
string
format("YYYY-mm-dd")
validade
required
string
format("YYYY-mm-dd")
dataExpedicao
required
string
format("YYYY-mm-dd")
numeroPortaria
required*
string
length(1, 255)
dataNaturalizacao
required*
string
format("YYYY-mm-dd")
dataPortaria
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Os campos numeroPortaria, dataNaturalizacao
e dataPortaria
são obrigatórios apenas quando o candidato for naturalizado brasileiro.
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento obrigatório. Registro Geral
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
numero
required
string
length(1, 255)
orgaoEmissor
required
string(options)
uf
required
string(options)
dataExpedicao
required
string
format("YYYY-mm-dd")
naturalidadeEstado
required
string(options)
naturalidadeCidade
required
string(options*)
filiacao1
required*
string
length(1, 255)
filiacao2
optional
string
length(1, 255)
comprovantes
[ ]voucher
Os campos filiacao1
e filiacao2
serão solicitados apenas para dependentes e cônjuge.
As opções do campo naturalidadeCidade
dependem do valor selecionado no camponaturalidadeEstado
.
Opções de órgão emissor
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
lista
required
[ ]nr
comprovantes
[ ]voucher
Norma Regulamentadora
Nome
Tipo
Observações
numero
required
string(options)
length(1, 255)
descricao
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
Opções de número
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Comprovantes do formulário de benefícios
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
foto1
required
voucher
foto2
optional
voucher
foto3
optional
voucher
foto4
optional
voucher
foto5
optional
voucher
foto6
optional
voucher
foto7
optional
voucher
foto8
optional
voucher
foto9
optional
voucher
foto10
optional
voucher
Documento obrigatório. Número do PIS/NIS/PASEP
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
primeiroEmprego
required
boolean
possui
required*
boolean
numero
required*
string
length(1, 255)
dataCadastramento
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Caso o campo primeiroEmprego
possua o valor true
, o campo possui
será obrigatório. Caso o campo possui
seja true
, os campos numero
e dataCadastramento
serão obrigatórios. Os campos numero
e dataCadastramento
também serão obrigatórios quando o campo primeiroEmprego
for false
.
Comprovantes
Nome
Tipo
frente
required*
voucher
carteiraTrabalho
required*
voucher
O comprovante frente
só será obrigatório quando o campo primeiroEmprego
for false
, ou quando for true
e o campo possui
também for true
. O comprovante carteiraTrabalho
so será obrigatório quando o campo primeiroEmprego
for true
e o campo possui
for false
.
Documento adicional. Informações acadêmicas
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
graduacao
required
string
length(1, 255)
instituicao
required
string
dataConclusao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
voucher
verso
voucher
Documento obrigatório. Título de Eleitor
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
As opções do campo municipio
dependem do valor selecionado no campo uf
.
Comprovantes
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Informações complementares de dependentes
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
As opções do campo naturalidadeCidade
dependem do valor selecionado no camponaturalidadeEstado
.
Este documento adicional pertence apenas a dependentes, não sendo disponibilizado à outras pessoas (candidatos, cônjuge/companheiro, responsáveis).
Documento adicional. Imposto sobre a Propriedade de Veículos Automotores
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
Documento adicional. Informações complementares
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Documento adicional
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Opções de semestre
Opções de turno
Opções de dias de estágio
Nome
Tipo
Observações
numero
required
string
length(1, 255)
zona
required
string
length(1, 255)
secao
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
municipio
required
string(options*)
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
Nome
Tipo
Observações
emBranco
required
boolean
comprovantes
[ ]voucher
Nome
Tipo
penultima
required
voucher
ultima
required
voucher
Nome
Tipo
Observações
estadoNaturalidade
required
string(options)
municipioNaturalidade
required
string(options*)
estadoCivil
required
string(options)
nivelEscolaridade
required
string(options)
Nome
Tipo
Observações
numero
required
string
length(1, 255)
dataPagamento
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Nome
Tipo
Observações
atividadeParalela
required
boolean
atividade
string
Obrigatório em caso de atividade paralela.
cracha
required
string
possuiPai
boolean
dataNascimentoPai
string
format("YYYY-mm-dd")
dataNascimentoMae
required
string
format("YYYY-mm-dd")
Nome
Tipo
Observações
nomeInstituicao
required
string
length(1, 255)
cnpj
required
string
tipoLogradouro
required
string(options)
logradouro
required
string
complemento
string
numero
required
string
uf
required
string
cidade
required
string
nomeCurso
required
string
ano
required
string
semestre
required
string(options)
matricula
required
string
conclusao
required
string
format("YYYY-mm")
turno
required
string(options)
nomeCoordenador
required
string
obrigatorio
boolean
tempoMaximo
required
string
cargaHoraria
required
string
intervalo
required
string
horarioEntrada
required
string
horarioSaida
required
string
diasEstagio
required
[ ]string(options)
Templates de extração para arquivos CSV
Código: csv-v1.0
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: não
Cabeçalho: sim
Código: csv-v1.1
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim
Código: csv-v2.0
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: não
Cabeçalho: sim
Código: csv-v2.1
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim
Código: csv-v2.3
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim
Código: csv-v3.0
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim
Código: csv-v3.1
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim
Código: csv-v3.2
Delimitador: ;
Quebra de linha: crlf
Tratamento de dados: caixa alta e não acentuados
Cabeçalho: sim