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...
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.
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 Central de Ajuda.
Here are the articles in this section:
Posições são as vagas, convites para os candidatos iniciarem o preenchimento do "application" (formulário).
Abaixo temos a lista de api's disponíveis para as funcionalidades do Unico People, que tem uma ação direta para as posições.
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
uid*
string
UID da posição a ser deletada. Consulte aqui.
unit*
string
UID da filial de onde a posição será deletada. Consulte aqui.
curl --location --request DELETE 'https://api.acessorh.com.br/v1/positions?uid=uid%20do%20candidato&unit=uid%20da%20unidade' \
--header 'Authorization: Bearer token de autenticação'200 - OK
"ok"Exibe os link's do convite enviado para a posição iniciar o processo de cadastro dos documentos.
GET
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/admissions/invite/:pos
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
pos*
string
UID da posição desejada
curl --location 'https://api.acessorh.com.br/v1/admissions/invite/:pos' \
--header 'Authorization: Bearer token de autenticação'{
"data": {
"expiresAt": "2022-02-06 17:17:55",
"longURL": "hhttps://form.rh.qa2.acesso.dev/profile/intro/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJraW5kIjoiYWRtaXNzaW9uIiwib3JnIjoiN2MxNTAxN2ItM2M5Zi00NWU5LTk4MzMtNTNmY2M4MjI0N2E4IiwicG9zIjoiMGJhMDJkMjItMzZiNy00YmQ0LWJkZjctZTVmMGUxZTk1ZDJmIn0.Hm9VSbWQjWRGER_jE2UWAhtpk5_-XpniEnPRJzdxNbO",
"shortURL": "https://aces.so/U3u6Jve"
},
"error": null,
"status": 200
}Listagem de document types e respectivos slugs (identificadores dos documentos)
POST
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/config/available-documents
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
curl --location 'https://api.acessorh.com.br/v1/config/available-documents' \
--header 'Authorization: Bearer TOKEN DE AUTENTICAÇÃO'{
"data": [
{
"id": "91b8e5ca-3817-4a82-b9e8-87d4a50421a4",
"slug": "vspp",
"title": "vspp",
"kind": "hardcoded"
},
{
"id": "6d58e6f3-5501-40b3-b1fb-3e6949d19960",
"slug": "cpf",
"title": "cpf",
"kind": "hardcoded"
},
{
"id": "93c3527c-1bed-45d0-8725-1705e580357d",
"slug": "escolaridade",
"title": "escolaridade",
"kind": "hardcoded"
},
.
.
.
]
}Padrão de contratação aplicado com base nas leis e princípios do Brasil.
Adiciona e/ou remove benefícios de uma posição.
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
position*
string
UID ou número da posição a ser alterada. Consulte aqui.
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. Consulte aqui.
remove
array[string]
UIDs dos grupos de benefícios a serem
removidos da posição. Consulte aqui.
{
"unit": "4bdaa0d3-f3e4-4520-b64e-6a22508bebc9",
"add": ["c4c17fd1-9c93-4dbf-bca8-bded7fd97287"],
"remove": ["87a6e88f-c318-416b-830e-8cf446f535fe"]
}"ok"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
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
[
{
"name": "21st Century Fox",
"description": "",
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
"accounts": [
{
"uid": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"name": "Fox Entertainment Group",
"description": "",
"fields": [],
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
}
],
}
]GET https://api.acessorh.com.br/v1/accounts/:account
Lista todas as filiais de uma empresa.
Path Parameters
account
string
UID da empresa desejada
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
[
{
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
"description": "Exemplo 1",
"fields": [],
"name": "Fox Searchlight Pictures",
"uid": "8f41346e-ea5d-43c1-aeff-df44b24b15ce"
},
{
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
"description": "Exemplo 2",
"fields": [],
"name": "Blue Sky Studios",
"uid": "8c461157-a348-4243-8f25-e85630e8df2f"
}
]Realiza o envio do kit admissional para candidatos concluídos e arquivados.
POST
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/positions/:position_id/signature-envelopes
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
position_id*
string
UID da posição que deve receber o kit de documentos para assinatura.
account*
string
UID da empresa.
unit*
string
UID da filial onde a posição se encontra.
documents
array[string]
Para modelos PDF que serão enviados
para assinatura.
models
array[string]
Para modelos de texto que serão enviados
para assinatura.
Não é possível enviar o kit admissional para posições:
Em andamento
Declinadas
{
"account": "4aca3203-e791-41e1-b5d7-6ef02d152787",
"unit": "8eff6480-1e71-468b-ae4d-eefe3cd3e03d2",
"documents": [
{
"uid": "204b1007-ddaf-4854-b96c-01277c1f5a6a",
"name": "nome do modelo 1",
"source": "sign"
},
{
"uid": "46582069-598b-4ac9-9ab2-50d3f23ab4e2",
"name": "nome do modelo 2",
"source": "sign"
}
],
"models": [
"8946efe8-e100-4497-907e-3803bb048b47",
"62766bb0-b5ac-4462-8478-062950577067"
]
}{
"code": 200,
"messages": null,
"result": {
"uid": "6416fc22-4953-43d0-8db6-c96a908cf574"
},
"status": "ok"
}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
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
[
{
"name": "21st Century Fox",
"description": "",
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
"accounts": [
{
"uid": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"name": "Fox Entertainment Group",
"description": "",
"fields": [],
"customFields": {
"name": null,
"tradingName": null,
"cnpj": null,
"phone": null,
"email": null,
"zipCode": null,
"address": null,
"city": null,
"state": null,
"brand": null
},
}
],
}
]Documento adicional. Antecedentes criminal emitido pela delegacia
ID
d015d73e-8884-4212-9bcf-72ad95203961Slug
antecedentes_estadualUtilizar 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)
uf required
string(options)
length(1, 255)
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional
ID
2b1b8b7a-44c4-4aed-b4f2-d27ea86fb57bSlug
certidao_nada_constaUtilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
inscricao
required
string
length(1,255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documentos e tipos de pessoas por contexto
Altera o status de uma posição.
PUT
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/positions/status/:position
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
position*
string
UID ou código da posição a ser alterada
status*
string(options)
Status no qual a posição será alterada
Opções de status.
"completed", "archived", "declined"unit
string
UID da filial do qual a posição pertence. .
decline
object
Decline é a estrutura com as informações dos motivos de declínio da posição. *Esse campo é obrigatório apenas quando o campo de status for igual a "declined".
Motivos (reason) de declínio para cada type.
DECLINED_BY_USER
motivos-pessoais
proposta-melhor
nao-tem-interesse
sem-retorno
outro
DECLINED_BY_HR
sem-retorno-candidato
falta-documento
escolaridade-inferior
sem-vacina-covid
outro
Importante! Não é possível declinar posições que estão arquivadas.
{
"unit": "84ef8cd7-76ee-4b10-a77b-e0201cdcd117",
"status": "declined",
"decline":{
"type": "DECLINED_BY_HR",
"reason": "falta-documento",
"description": "descrição",
"message":"messagem de declino para o candidato",
}
}"ok"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.
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 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 .
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:
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 .
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.
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: .
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
DELETE https://api.acessorh.com.br/v1/department
Deleta um departamento da empresa selecionada.
Query Parameters
Headers
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
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. 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. 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
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
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
{
"code": "ti",
"name": "Tecnologia da Informação"
}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)
[
{
"acc": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"code": "financ",
"id": "2f642a78-8fa7-4a05-8bb3-b6d25ddbd6fa",
"name": "Financeiro"
}
]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).
account*
string
UID da empresa onde os modelos estão cadastrados. (Único parâmetro obrigatório)
sort
string
Ordena os resultados dos modelos por "name" e "updated".
type
string
Filtra pelo 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)
Authorization*
string
Token de acesso adquirido pela plataforma Identity (Bearer).
[
{
"code": "",
"context": "brazil",
"id": "b61a61e0-3824-4f1c-8044-adae53cba91e",
"name": "Modelo 1",
"sendToSignature": false,
"signatureRequired": false,
"template": {
"path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/model/template/67dbabcc-d04b-4e2b-b5b4-064507eb9111/67dbabcc-d04b-4e2b-b5b4-064507eb9111.html",
"mime": "text/html",
"size": 29085,
"name": ""
},
"type": "b4b89b51-bfe8-42fb-938c-0223aa56fbf4",
"typeName": "Nome do tipo de modelo"
}
]f815dbd8-a5cc-4845-98c4-a160e2989b98antecedentes_federalNome
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
35e0ebd9-c248-4dff-b671-54ffa8a46501nascimentoNome
Tipo
Observações
filiacao1
required
string
filiacao2
optional
string
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
32e00f6d-e847-4ac8-be6e-13b8c36b7a27susNome
Tipo
Observações
numero
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
d62749ab-1bd2-44ee-89c7-bd06f717d94fcnvNome
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
0dc3f588-ef55-41d8-bc33-1c88d1542df8crachaNome
Tipo
Observações
Nome
required
string
length(1, 255)
comprovantes
[ ]voucher
Nome
Tipo
cracha
required
voucher
{Cabeçalho em Base64url}.{Payload em Base64url}.{Assinatura em Base64url}{Cabeçalho em Base64url}.{Payload em Base64url}{"alg":"RS256","typ":"JWT"}eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9iss
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
Endereço da plataforma de autenticação que faz a emissão de tokens de acesso. Este valor deverá ser sempre e exatamente https://identityhomolog.acesso.io Casos recorrentes que NÃO funcionam: - Inserção de uma barra ao final do endereço: https://identityhomolog.acesso.io/ - Uso do protocolo HTTP ao invés de HTTPS: http://identityhomolog.acesso.io
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á.
exp = iat + 3600{
"iss": "service_account_name@tenant_id.iam.acesso.io",
"aud": "https://identityhomolog.acesso.io",
"scope": "*",
"exp": 1626296976, // Este é apenas um exemplo. Utilize aqui o valor atual gerado.
"iat": 1626293376 // Este é apenas um exemplo. Utilize aqui o valor atual gerado.
}{Cabeçalho em Base64url}.{Payload em Base64url}{Cabeçalho em Base64url}.{Payload em Base64url}.{Assinatura em Base64url}{"alg":"RS256","typ":"JWT"}.
{
"iss": "service_account_name@tenant_id.iam.acesso.io",
"aud": "https://identityhomolog.acesso.io",
"scope": "*",
"exp": 1626296976, // Este é apenas um exemplo. Utilize aqui o valor atual gerado.
"iat": 1626293376 // Este é apenas um exemplo. Utilize aqui o valor atual gerado.
}.
[byte array da assinatura]eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzZXJ2aWNlX2FjY291bnRf
bmFtZUB0ZW5hbnRfaWQuaWFtLmFjZXNzby5pbyIsImF1ZCI6Imh0dHBzOi8vaWRlbnRpdHlob21vbG9nLmFjZXNzby5pbyIsInNjb
3BlIjoiKiIsImV4cCI6MTYyNjI5Njk3NiwiaWF0IjoxNjI2MjkzMzc2fQ.JsymP3NZdgCSqeNlgsOM2
-AQ7M450NxFnZnnaKSu4Q8g12QGEIvvM4EhCokUHfwk5s7pOpm2UD_Ng3Hb5g_wgrjfiVSLWH5Q2wYg1AvfLqo
YSoJWaMHm9KL0kpv32XdDD8TZVR-MVd2VBHmCMVbV6gvk8buUoK1HZDN7g84PaY3bfgcB3RKU-
H55lR8yyJjZxToIv17-wfla2G99uaMEFNGX0ZSE7ETn5Z8-WypmFrNAK0TM58upzvfVI6_-
gY4cj4iQvmRbuvxsAaGiHA2xd0RVm2Mrx-gQtdPqtbZPuQcH7k64Z_EOQBgiGTgVjucyHD6zBijr_P-
2mhIxuecNSwhttps://identityhomolog.acesso.io/oauth2/tokengrant_type
Utilize o seguinte texto, URL-encoded se necessário: urn:ietf:params:oauth:grant-type:jwt-bearer
assertion
O JWT, incluindo a assinatura.
POST /oauth2/token HTTP/1.1
Host: identityhomolog.acesso.io
Content-Type: application/x-www-form-urlencoded
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-
bearer&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzZXJ2aWNlX2FjY
291bnRfbmFtZUB0ZW5hbnRfaWQuaWFtLmFjZXNzby5pbyIsInN1YiI6InVzZXJfaWRlbnRpZmllciIs
ImF1ZCI6Imh0dHBzOi8vaWRlbnRpdHlob21vbG9nLmFjZXNzby5pbyIsInNjb3BlIjoiKiIsImV4cCI
6MTMyODU1NDM4NSwiaWF0IjoxMzI4NTUwNzg1fQ.TjH-mTtwP6tBB93O1sDPaAA6yUF7N2-HZDlpIPz
bf_dxO8A6KZuRWG8ZnICrxX56qj0HREiMlYy27XJgxowrUa0JHvbqc8HJkT7-6Mh7J67UnubZKG1-hi
6jDtkC9BIXBcOhtkNUfZvZetXjLzsRsSDkqxdMtzYZwkRlocvaxL5QXiQhweeEwK_Ux81Adh3z0EIhT
yl7CKJLJ69PuHS7s9IdrjUl79owipp4LF1FvtMhoe7YIL69ohPgFqSv_-Y9qpPdW6be3OEAyKlOM08S
ZBbHBwW4XMvw3uZjTY1sgJ4cBoxrftDpjYOw34oPOKxirqc5-90uOCYe1O1hRtG45w{
"access_token": "<access_token>",
"token_type": "Bearer",
"expires_in": "3600"
}token decodificado:
new Date(token.exp - 600)Cenário padrão:
expires_in: 3600 (1h) - Geração do token as 14h42
Solicitar um novo token somente as 15h32 ou seja, 14:42 + (3600 - 600)Cenário com a duração alterada:
expires_in: 7200 (2h) - Geração do token as 14h42
Solicitar um novo token somente as 16h32 ou seja, 14:42 + (7200 - 600)
uf*
string
Sigla do estado a ser consultado.
city*
string
Município a ser consultado.
Authorization*
string
Token de acesso adquirido pela plataforma Identity (Bearer)
{
"code": "2338990"
}"not found"Documento adicional
ID
66b5e48f-c1aa-4ba1-8ced-d193db1e2ff4Slug
certidao_negativa_debitosUtilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Nome
Tipo
Observações
inscricao
required
string
length(1,255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento obrigatório. Comprovante de União Estável
ID
eb43bf16-4b80-461d-9a0c-70094d5822a0Slug
uniao_estavelUtilizar 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
5bb67d91-99ef-469c-ae73-f51498621acb Slug
alistamentoUtilizar 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
"1ª CATEGORIA: EXERCITO MARINHA OU AERONAUTICA", "2ª CATEGORIA: TIRO DE GUERRA", "3ª CATEGORIA: DISPENSADO DO SERVICO MILITAR"Comprovantes
Nome
Tipo
Observações
frente
required
voucher
verso
required
voucher
Documento adicional. Imagens das páginas de Contrato de Tabalho da CTPS
ID
502b9d12-5f3c-4bd9-b3c2-1b0f9e0346a5Slug
contrato_trabalhoUtilizar 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
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)
{
"total": 1,
"attachments": [
{
"categoryID": "fa650c17-1b9d-4189-a02c-bdf23df7ce7c",
"categoryName": "Anexo tipo A",
"attachmentID": "7d197b75-e876-4c63-9c11-9631918b5acc",
"file": {
"path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/attachments/category/fa650c17-1b9d-4189-a02c-bdf23df7ce7c/attachment/7d197b75-e876-4c63-9c11-9631918b5acc/5535ed24-50e1-4879-93a2-6ac9e4941047.pdf",
"mime": "application/pdf",
"size": 319626,
"name": ""
},
},
],
}{
"total": 0,
"attachments": null
}Documento adicional
ID
5c1ae1df-33e7-4df3-b872-24a102c4a374Slug
certidao_prontuario_cnhUtilizar 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
required
voucher
pagina3
required
voucher
pagina4
required
voucher
Documento obrigatório. Comprovante da escolaridade do candidato
ID
93c3527c-1bed-45d0-8725-1705e580357dSlug
escolaridadeUtilizar 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(1, 255)
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Enfermagem
ID
c8cbc02a-8603-47b0-8336-9d1ce270b597Slug
corenUtilizar 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")
validade
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional. Conselho Regional de Medicina
ID
3ccf559e-a07a-4e10-9659-db55b353f963Slug
crmUtilizar 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
ID
0ec90ec6-1076-4bf1-b766-12a36a6417d8Slug
crtrUtilizar 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("YYYY-MM-DD")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional
ID
79d6c0b0-f31c-4c33-9285-13795dc65674Slug
cota_pcdUtilizar 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 obrigatório. Comprovante de estado civil de Divorciado
ID
ce23d991-d28a-4610-815d-30b4b1ffddf6Slug
divorciadoUtilizar 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
ID
4ea6b6da-29d8-4855-bae3-724a1cec2594Slug
conselho_regionalUtilizar 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 do ASO
ID
5895b5c9-35e5-4630-be67-2dc877a5fef8Slug
exameUtilizar 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. Situção cadastral do CPF junto à Receita Federal
ID
33eebebc-55d5-4c07-8faf-b7f28992930cSlug
receita_federalUtilizar 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. Comprovante do Cadastro de Pessoas Físicas
ID
6d58e6f3-5501-40b3-b1fb-3e6949d19960Slug
cpfUtilizar 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)
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Apólice do seguro veicular do CPF.
ID
8c73d917-bb46-47da-a180-333c145260dfSlug
apolice_seguro_veicularUtilizar 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)
placa
optional
string
length(1,255)
comprovantes
[]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional
ID
a8c4028e-7f1d-4ff3-8a9d-701b3f33f4acSlug
crbmUtilizar 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
3c2f5eee-971c-4964-a955-4efa07c7024eSlug
creaUtilizar 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. Informações adicionais referentes ao documento Exame Médico
ID
6f3ce851-f6c6-4a7b-a6b6-a5e45f088002Slug
dados_complementares_asoUtilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
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)
Documento obrigatório. Comprovante de emancipação de um menor de idade
ID
c9902d62-590e-40db-90cb-b990d4953701Slug
emancipadoUtilizar 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
ID
52e3a9dc-7e3c-435c-84b6-7644b3fb9b76Slug
crbioUtilizar 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("YYY-MM-DD")
comprovantes
[ ]voucher
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Listagem de documentos
Alteração de dados contratuais dos candidatos, individual ou em lote.
PUT
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/account/:acc/admissions/batch-update
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
acc*
string
UUID da empresa.
O payload funciona em batch, com um array de posições diferentes para alterações em lote.
position*
string
Identificador da posição/admissão a ser alterada.
Apesar de opcionais, é necessário pelo menos um para que a alteração seja feita.
role
string
UID do novo
department
string
UID do novo
limitDate
string
Nova data limite, formato YYYY-MM-DD.
additional
object
Campos adicionais (abaixo).
Campos adicionais do cadastro
employeeCode
string
Nova matricula do candidato.
admissionDate
string(data)
Data de admissão, formato YYYY-MM-DD.
admissionDateReason
string
Motivo da alteração da data de admissão.
positionNumber
string
Novo numero da posição.
costCenter
string
Novo centro de custos.
Importante!
Não é possível alterar dados contratuais de posições que estão arquivadas.
Apenas os campos enviados no payload são alterados. Campos omitidos permanecem inalterados.
{
curl --location --request PUT 'https://api.acessorh.com.br/v1/account/1761b1b8-1111-2222-3333-10d2435ea1f5/admissions/batch-update' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '[
{
"position": "b1e2c3d4-5678-1234-9abc-def012345678",
"role": "a1b2c3d4-1111-2222-3333-444455556666",
"department": "d1e2f3g4-7777-8888-9999-000011112222",
"limitDate": "2025-07-01",
"additional": {
"employeeCode": "123456",
"admissionDate": "2025-06-16",
"admissionDateReason": "Ajuste por acordo sindical",
"costCenter": "CC-7890"
}
},
{
"position": "a9b8c7d6-4321-8765-0fed-cba987654321",
"additional": {
"positionNumber": "POS-002"
}
}
]'
"[
{
"position": "b1e2c3d4-5678-1234-9abc-def012345678",
"success": true
},
{
"position": "a9b8c7d6-4321-8765-0fed-cba987654321",
"success": false,
"error": "unit not found for position"
}
]
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
Comprovantes
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
Comprovantes
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
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. 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
Opções de tipo
Comprovantes
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
Comprovantes
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
Comprovantes
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
Comprovantes
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
Comprovantes
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
Comprovantes
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
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 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
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
ID
Slug
Utilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
Comprovantes
0f98ddee-7bb0-4b32-a849-99d297202a81carteira_trabalhoNome
Tipo
Observações
numero
required
string
length(1, 255)
serie
required
string
length(1, 255)
uf
required
string(options)
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
dataValidade
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
pagina22
required
voucher
anotacoes
required
voucher
b508549a-c45a-425f-8773-d60dc7484750cnhNome
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
Nome
Tipo
frente
required
voucher
verso
required
voucher
023d7037-ff3f-474b-9afa-5b6095a9f472reciclagemNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
optional
voucher
35f15759-737a-4915-a438-c2cebdf7c57acarta_referenciaNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
3bc522e4-5cb0-4611-a51b-161cac50ca5acrfNome
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
"provisoria", "definitiva"Nome
Tipo
frente
required
voucher
3725c5f3-9ca1-4d2a-86fd-ee063e10c632carteira_marromNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
pagina2
required
voucher
pagina3
required
voucher
pagina5
required
voucher
4c92e63b-5e92-4499-979f-4f3e233d596episNome
Tipo
Observações
primeiroEmprego
required
boolean
possui
required*
boolean
numero
required*
string
length(1, 255)
dataCadastramento
required*
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required*
voucher
carteiraTrabalho
required*
voucher
7dff436c-d450-4a75-8af5-7934ab1bb71ccertidao_casamentoNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
6ee7563f-7488-42d3-881a-320e27ad68fechtNome
Tipo
Observações
funcao
required
string
length(1, 255)
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
e255a269-f80e-4751-9f52-d4fb04778e09crcNome
Tipo
Observações
categoria
required
string
length(1, 255)
numero
required
string
length(1, 255)
dataEmissao
required
string
format("YYYY-mm-dd")
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
36c1e6b6-0803-4f73-9780-8c11d9fa11b2bombeiroNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
6eac031e-66b0-4bc6-9f00-8e8a62fec29bcftNome
Tipo
Observações
dataEmissao
required
string
format("YYYY-mm-dd")
registro
required
string
length(1,255)
comprovantes
[]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
1fa9f399-8fe7-4545-9aaa-005d2f4bd010dados_complementares_certidaoNome
Tipo
Observações
numero
required
string
length(1, 255)
data_estado_civil
required
string
format("YYYY-mm-dd")
127b68c0-d9df-42d0-b74a-46a3ea7e8170reembolsoNome
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
aba90218-8608-4c31-9add-6e199145dcadqualificacao_civilNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
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.
PUT https://api.acessorh.com.br/v1/upload
Upload de arquivos temporários
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Request Body
file*
string
Path do arquivo que será carregado
"bcaaf3a8-b682-4809-83a7-83a73e867cb6"GET https://api.acessorh.com.br/v1/r/:path
Download de imagens e/ou arquivos no formato original.
Path Parameters
path*
string
Caminho do arquivo desejado
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
GET https://api.acessorh.com.br/v1/t/:options/:path
Download de imagens modificadas pelos parâmetros selecionados.
Path Parameters
options*
string
Opções de modificação do arquivo
path*
string
Caminho do arquivo desejado
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
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%.
GET https://api.acessorh.com.br/v1/c/:format/:path
Download de imagens convertidas no formato desejado.
Path Parameters
format*
string
Formato no qual o arquivo será convertido
path*
string
Caminho do arquivo desejado
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Documento obrigatório. Comprovante do Endereço residencial do candidato
ID
7d5eb9da-b50e-49f7-8c3e-3ee5877eb620Slug
enderecoUtilizar apenas o "id" como chave, uma vez que o "slug" é uma descrição e poderá ser alterado livremente.
Campos
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
Opções de titular
"proprio", "pai_mae", "conjuge", "terceiro"Comprovantes
Nome
Tipo
frente
required
voucher
declaracao
required
voucher
Documento adicional. Comprovantes do formulário de benefícios
ID
9f4f3301-aae7-49aa-8e1b-c8aa1769353dSlug
formulario_beneficiosUtilizar 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 adicional
ID
24180d63-f366-4e10-9e8d-78fc12af1b07Slug
nrsUtilizar 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
"NR-01", "NR-02", "NR-03", "NR-04", "NR-05", "NR-06", "NR-07", "NR-08", "NR-09", "NR-10", "NR-11", "NR-12", "NR-13", "NR-14", "NR-15", "NR-16", "NR-17", "NR-18", "NR-19", "NR-20", "NR-21", "NR-22", "NR-23", "NR-24", "NR-25", "NR-26", "NR-27", "NR-28", "NR-29", "NR-30", "NR-31", "NR-32", "NR-33", "NR-34", "NR-35", "NR-36"Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento adicional
ID
3e93cbcb-3aad-4e8b-a353-d32bffd0ffa7Slug
crlvUtilizar 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
Documento obrigatório. Comprovante dos dados do candidato em caso de estrangeiro
ID
db38fec5-5cca-43e7-94bd-42da518d17c3Slug
estrangeiroUtilizar 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
Comprovantes
Nome
Tipo
frente
required
voucher
Documento obrigatório. Registro Geral
ID
c2069ecf-ea5d-4029-9960-6f802392c6d7Slug
rgUtilizar 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
Opções de órgão emissor
"CGPI", "CGPI/DUREX/DPF", "CGPMAF", "CLA", "CNIG", "CORECON", "COREN", "CRAS", "CSC", "CNT", "CTPS", "DGPC", "DIREX", "DPMAF", "DPT", "DIC", "FGTS", "FIPE", "FLS", "GESP", "GEJ", "GEJ/SPC", "GOVGO", "IFP", "IPF", "IGP", "IIMG", "IPC", "IML", "MTE", "MMA", "MAE", "MEX", "PM", "PTC", "PC", "POF", "POM", "SES", "SJS", "SEDS", "SSDC", "SECCDE", "SEPC", "SESC", "SESDC", "SNJ", "SJTS", "SPTC", "SSP", "SSPDC", "SESP", "SESPDC", "SECC", "SDS", "SESPAP", "SSPDS", "SESPDS", "SEJSP", "SSDS", "SJ", "SJTC", "SPC", "SJSP", "ZZZ"Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
voucher
Documento obrigatório. Comprovante de estado civil de Separado
ID
f67d6cba-607f-48bf-8bd1-ac57d5c17044Slug
separadoUtilizar 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
Documento adicional. Certificado de conclusão do curso específico de Vigilante de Segurança Particular Privada
ID
91b8e5ca-3817-4a82-b9e8-87d4a50421a4Slug
vsppUtilizar 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
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": 201,
"messages": null,
"result": {
"uid": "3a46ca19-506f-4e80-a217-891d48a2a0ac"
},
"status": "ok"
}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
string()
Escolaridade mínima permitida para o cargo
Opções de escolaridade mínima
"analfabeto", "5_ano_fundamental_incompleto", "5_ano_fundamental_completo", "6_9_fundamental_incompleto", "fundamental_completo", "medio_incompleto", "medio_completo", "superior_incompleto", "superior_completo", "pos_graduacao", "especializacao", "mestrado", "doutorado", "phd"{
"code":"an-prog-jr",
"name": "Analista Programador Jr",
"context": {
"brazil": {
"cbo": "789",
"escolaridadeMinima": "superior_completo"
}
}
}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)
[
{
"acc": "bf63e2bd-da94-4bc3-862d-49daf9fadb87",
"code": "an-prog-jr",
"context": {
"brazil": {
"cbo": "789",
"escolaridadeMinima": "superior_completo"
}
},
"id": "3a46ca19-506f-4e80-a217-891d48a2a0ac",
"name": "Analista Programador Jr"
}
]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).
Documento adicional. Comprovante de vacinação COVID-19
ID
9634af89-da58-49ef-aac1-82a06c8cdb93Slug
comprovante-vacinacao-covidUtilizar 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.
Opções de doses
"nenhuma dose", "uma dose", "duas doses"Vacinas
nome required
string()
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
"corona-vac", "astra-zeneca", "pfizer", "janssen"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
Lista posições na empresa ou filial selecionada.
GET
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint:/v1/positions
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
acc*
string
UID da empresa ou da filial que será filtrada. Consulte aqui.
admission_date
string
Data de admissão início e fim Formato: AAAA-MM-DD,AAAA-MM-DD
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. O valor máximo é 100 por pagina. (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").
210
Invited
Posição criada e convite enviado para o candidato
220
Pending
Candidato iniciou o processo de admissão, mas ainda não finalizou a entrega dos documentos.
230
Review
Posição já analisada pela mesa, mas pendente de correção pelo candidato.
240
Analisys
Todos os documentos entregues, aguardando análise da mesa.
400
Completed
Documentos entregues e validados ou posição completada manualmente pelo RH.
500
Archived
Posição arquivada.
501
Declined
Posição declinada.
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.
curl --location 'https://api.acessorh.com.br/v1/positions?acc=UID%20da%20empresa&admission_date=2024-08-17%2C2024-09-16&limit=100&skip=0&status=500&order=asc&sort=admission_date' \
--header 'Authorization: Bearer Token de autorização' \
--data ''200 OK
{
"offset": 0,
"limit": 100,
"count": 1,
"positions": [
{
"admission_date": "2019-05-17T00:00:00Z", //deprecated
"cost_center": "anywhere",
"exame": {
"clinica": "bcaaf3a8-b682-4809-83a7-83a73e867cb6",
"comprovante": {
"filename": "exame.jpg",
"id": "5f0676ab-648a-4c3f-92c7-eedd1802d719",
"mimetype": "image/jpeg",
"path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/position/9e70b644-fce0-442a-af8a-40b00cbbb437/context/brazil/exame/5f0676ab-648a-4c3f-92c7-eedd1802d719.jpg"
},
"data": "2019-05-11T00:00:00Z",
"hora": "2006-01-02T13:04:00Z",
"nome": "Clinica Saude",
"observacoes": "chegar cedo"
},
"id": "e8efddec-4a9e-4153-9e61-ce0056edf542",
"jornada": "De segunda a sexta das 15 as 19",
"num_matricula": "4242424",
"pagamento": {
"agente_integrador": null,
"data_inicio": null,
"data_termino": null,
"deficiencia": false,
"recorrencia": "mensalista",
"valor": 4200,
"vinculo": "clt"
},
"position_number": "pos-test",
"profile": {
"email": "[email protected]",
"id": "72421b50-c882-4684-8e10-c5a0522978e1",
"mobile": "11991111111",
"name": "John Doe",
"photo": {
"filename": "foto-perfil.png",
"id": "c8d1c2a7-75d2-4615-a9e1-d93bd09570b6",
"mimetype": "image/png",
"path": "individual/23beac75-4722-4e14-96a4-72f69322471e/person/brazil/c8d1c2a7-75d2-4615-a9e1-d93bd09570b6.png"
}
},
"decline": {
"type": "DECLINED_BY_HR",
"reason": "sem-retorno-candidato",
"description": "descricao",
"message": "declinado pela empresa",
"creationDate": "31/03/2023 16:42:44"
},
"dates": {
"limit_date": "2019-05-30T00:00:00Z",
"admission_date": "2019-05-17T00:00:00Z"
},
"status": {
"code": 501,
"name": "decline"
},
"updated": "2019-04-23T18:10:16.892Z"
}
]
}Documento adicional. Certificado de Capacidade Técnica emitido pela ANAC
ID
a755f742-9339-41a8-8d4c-2dbc1dc47cebSlug
cctUtilizar 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
"piloto", "mecanico_voo", "comissario", "mecanico_manutencao", "despachante", "operador_equipamentos"Opções de CCTs
"ppa", "pph", "pca", "pch", "pla", "plh", "ppl", "cpr", "cpd", "cpdct", "inva", "invh", "invp", "invd", "ifr", "rvfra", "rvfrh", "rifra", "rifrh", "rcpd", "cms", "mcv", "dovmodi", "dovmodii", "avi", "cel", "gmp"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 obrigatório. Laudo de comprovação de deficiência
ID
313c92f4-f293-4849-bba5-3083960b24cfSlug
laudo_medicoUtilizar 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
"paraplegia", "paraparesia", "monoplegia", "monoparesia", "tetraplegia", "nanismo", "ostomia", "tetraparesia", "triplegia", "triparesia", "hemiplegia", "hemiparesia", "amp_ausencia_membro", "paralisia_cerebral", "deformidade_cong_adqu", "cegueira", "baixa_visao", "soma_camp_vis_igual_ou_inf_60", "monocular", "bilateral", "unilateral", "comunicacao", "cuidado_pesso", "habl_social", "util_rec_comu", "saude_seguran", "hab_academica", "media_lazer", "trabalho", "reabilitado_inss"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
Documento adicional
ID
f55615ad-aee3-41e9-bfa2-5d6da26c5931Slug
cnisUtilizar 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
cnis
required
voucher
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:
openssl req -x509 -new -nodes -sha256 -days 720 \
-key fileName.key.pem -out fileName.cert.pem
Documento adicional
ID
502b9d12-5f3c-4bd9-b3c2-1b0f9e0346a5Slug
contrato_trabalhoUtilizar 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 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
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
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
Comprovantes
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
Comprovantes
dd7a89d7-d400-4f7b-a394-7a10e5e9737fviuvoNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
verso
required
voucher
c9e26093-5e0c-4bd2-bea3-ac5182a6179foabNome
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
78c34ba6-213a-4c11-9894-b68871c68592vacinacaoNome
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
2520641d-bc94-4c83-86b4-0e20c02f0bb3ultimo_votoNome
Tipo
Observações
comprovantes
[ ]voucher
Nome
Tipo
frente
required
voucher
Documento adicional. Conselho Federal de Educação Física
ID
0e7d7327-5d6b-441e-a68a-cdfe4a8410f9Slug
confefUtilizar 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. Identificação dos dados bancários para pagamento de salário
ID
a8a89892-c9fd-40df-8dfd-5fa694c59ddfSlug
dados_bancariosUtilizar 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
"conta_corrente", "conta_conjunta", "conta_salario", "conta_poupanca"Comprovantes
Nome
Tipo
frente
required
voucher
Documento adicional. Certificado de conclusão do curso específico de vigilante
ID
ba5ed899-9574-4d42-866d-73ab2d0448bbSlug
vigilanteUtilizar 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. Conselho Regional de Nutrição
ID
5ab21c17-85b2-4b85-b654-f173a6044d91Slug
crnUtilizar 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)
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
Comprovantes
Nome
Tipo
frente
required
voucher
verso
required
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
Comprovantes
0b9e8da2-f82f-447b-a8d4-00458cf8282econtrato_estagioNome
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
Nome
Tipo
primeiraPagina
required
voucher
assinaturas
required
voucher
Listagem de grupos e respectivos benefícios
GET https://api.acessorh.com.br/v1/benefit/groups
Lista grupos de benefícios separados por categoria e ordenado por título.
Query Parameters
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.
[
{
"uid": "28640fba-9757-411b-bfca-04d1bb2c0286",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"title": "Teste alimentação",
"description": "Teste de alimentação",
"canOpt": true,
"context": "brazil",
"category": {
"type": "b26803a7-3a7c-48d1-8a66-70a5e59f68fe",
"slug": "alimentacao",
"title": {
"pt_BR": "Alimentação"
},
"data": {
"flexivel": null
}
},
"benefits": [
{
"uid": "52b554d1-37ca-493a-b583-4830fd4c28ef",
"type": "08662463-4bd9-4224-8e27-09fcac91a1c8",
"slug": "combo-vrva",
"title": {
"pt_BR": "Combo VR/VA"
},
"data": {
"flexivel": true,
"frequencia": "mensal",
"slug": "combo-vrva",
"title": {
"pt_BR": "Combo VR/VA"
},
"va": {
"provedor": "Provedor do plano",
"frequencia": "",
"valor": 0,
"desconto": "Formato de desconto."
},
"valorTotal": 800,
"vr": {
"provedor": "Provedor do plano",
"frequencia": "",
"valor": 0,
"valorMinimo": 200,
"desconto": "Formato de desconto."
}
}
}
],
"totalOfBenefits": 1
},
{
"uid": "1a69f7df-1f48-449b-93fb-0e43a910284f",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"title": "Teste assistência Odontológica",
"description": "Teste ass odonto",
"canOpt": false,
"context": "brazil",
"category": {
"type": "3f4e1ee3-c225-49df-9b17-3a4444dd59e0",
"slug": "assistencia-odontologica",
"title": {
"pt_BR": "Assistência Odontológica"
},
"data": {}
},
"benefits": [
{
"uid": "19bf72e0-20c8-4099-aa31-16a9f7c49cb9",
"type": "64b879be-f2cf-430b-a47d-7ad674b62459",
"slug": "plano-odontologico",
"title": {
"pt_BR": "Assistência Odontológica"
},
"data": {
"aceitaIncapaz": true,
"anexo": null,
"dependentes": true,
"desconto": "Formato de desconto.",
"planos": [
{
"uid": "469d5762-f5ac-4023-bcfd-778d90ab0357",
"nome": "Nome do plano",
"desconto": "Formato de desconto."
}
],
"preferencias": [
{
"parentesco": "conjuge",
"idadeMinima": 10,
"idadeMaxima": 100
},
{
"parentesco": "filho",
"idadeMinima": 0,
"idadeMaxima": 120
},
{
"parentesco": "enteado",
"idadeMinima": 10,
"idadeMaxima": 60
},
{
"parentesco": "irmao",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "neto",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "bisneto",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "menor-pobre",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "pai-mae",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "avo",
"idadeMinima": 0,
"idadeMaxima": 100
},
{
"parentesco": "bisavo",
"idadeMinima": 0,
"idadeMaxima": 100
}
],
"provedor": "Provedor do plano",
"slug": "plano-odontologico",
"title": {
"pt_BR": "Assistência Odontológica"
}
}
}
],
"totalOfBenefits": 1
},
{
"uid": "438cb683-a5eb-4c36-ba5b-1074a0360ba9",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"title": "Teste assistência médica",
"description": "Teste ass médica",
"canOpt": true,
"context": "brazil",
"category": {
"type": "47dcc73a-1985-40f5-98bd-07e00b9bf08a",
"slug": "assistencia-medica",
"title": {
"pt_BR": "Assistência Médica"
},
"data": {}
},
"benefits": [
{
"uid": "90f1c983-e318-4095-a0a4-a9913adc56ce",
"type": "165544c0-bf16-4880-8db9-b9815733acd3",
"slug": "plano-saude",
"title": {
"pt_BR": "Plano de Saúde"
},
"data": {
"aceitaIncapaz": true,
"anexo": {
"path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/benefit/attachment/7b01a6b7-5a2c-4032-be33-40f48ae08fd7/7b01a6b7-5a2c-4032-be33-40f48ae08fd7.pdf",
"mime": "application/pdf",
"size": 3028,
"name": "sample.pdf"
},
"dependentes": true,
"desconto": "Formato de desconto.",
"planos": [
{
"uid": "0a3d2fee-aa8f-4180-95ca-f7447e0a70c4",
"nome": "Nome do plano",
"desconto": "Formato de desconto."
}
],
"preferencias": [
{
"parentesco": "conjuge",
"idadeMinima": 15,
"idadeMaxima": 120
},
{
"parentesco": "filho",
"idadeMinima": 0,
"idadeMaxima": 25
},
{
"parentesco": "irmao",
"idadeMinima": 0,
"idadeMaxima": 40
},
{
"parentesco": "menor-pobre",
"idadeMinima": 0,
"idadeMaxima": 100
}
],
"provedor": "Provedor do plano",
"slug": "plano-saude",
"title": {
"pt_BR": "Plano de Saúde"
}
}
}
],
"totalOfBenefits": 1
},
{
"uid": "6246de95-3e02-4f7a-8de7-d54453f74cd0",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"title": "Teste seguro Vida",
"description": "Teste seguro de vida",
"canOpt": false,
"context": "brazil",
"category": {
"type": "b62f3492-3dcd-41e7-b644-40f4f72c753f",
"slug": "seguro-vida",
"title": {
"pt_BR": "Seguro de vida"
},
"data": {}
},
"benefits": [
{
"uid": "678ad091-077e-474a-be3e-434a467e24e9",
"type": "77951cff-6986-4fef-be7e-8aa598191ff5",
"slug": "seguro-vida",
"title": {
"pt_BR": "Seguro de Vida"
},
"data": {
"aceitaIncapaz": null,
"anexo": {
"path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/benefit/attachment/d664ae34-6377-4aeb-92f3-5d18fc15d959/d664ae34-6377-4aeb-92f3-5d18fc15d959.pdf",
"mime": "application/pdf",
"size": 3028,
"name": "sample.pdf"
},
"descontoFolha": null,
"flexivel": true,
"incluirBeneficiarios": true,
"planos": [
{
"uid": "550fbdfa-d2af-4d0b-8d95-d689fe4320be",
"nome": "Nome do plano",
"desconto": "Formato de desconto."
}
],
"provedor": "Provedor do plano",
"slug": "seguro-vida",
"title": {
"pt_BR": "Seguro de Vida"
}
}
}
],
"totalOfBenefits": 1
},
{
"uid": "88518ae2-9c68-4fd4-bc31-a07612acca5b",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"title": "Teste transporte",
"description": "Teste do benefício de transporte",
"canOpt": true,
"context": "brazil",
"category": {
"type": "e3a19b9a-333d-4db9-b203-24baf0f3d984",
"slug": "transporte",
"title": {
"pt_BR": "Transporte"
},
"data": {}
},
"benefits": [
{
"uid": "1a2f30df-e5d0-497a-bab6-796dfffc9269",
"type": "3c2e4354-768f-4dc0-a783-ad94e0e48c64",
"slug": "aluguel-veicular",
"title": {
"pt_BR": "Aluguel de Veículo"
},
"data": {
"desconto": "Formato de desconto.",
"frequencia": "diario",
"provedor": "Provedor",
"slug": "aluguel-veicular",
"title": {
"pt_BR": "Aluguel de Veículo"
},
"valor": 100
}
},
{
"uid": "ddd54853-9387-40b8-ae2a-eb3247ea552b",
"type": "0d672cdd-4719-421e-8ae6-31f9ef5e34c1",
"slug": "estacionamento",
"title": {
"pt_BR": "Estacionamento"
},
"data": {
"desconto": "Formato de desconto.",
"frequencia": "diario",
"provedor": "Provedor",
"slug": "estacionamento",
"title": {
"pt_BR": "Estacionamento"
},
"valor": 2
}
},
{
"uid": "d30f925f-2f44-4c31-891e-7c06c64b92eb",
"type": "1fefbd30-2056-4ad6-903e-9235e7bc6afb",
"slug": "fretado",
"title": {
"pt_BR": "Fretado"
},
"data": {
"desconto": "Formato de desconto.",
"frequencia": "mensal",
"provedor": "Provedor",
"slug": "fretado",
"title": {
"pt_BR": "Fretado"
},
"valor": 25
}
},
{
"uid": "c042c502-c270-43ce-994f-5cfecf3c558c",
"type": "59da7250-9740-4792-99ea-b73e22f915f3",
"slug": "gasolina",
"title": {
"pt_BR": "Gasolina"
},
"data": {
"desconto": "Formato de desconto.",
"frequencia": "diario",
"provedor": "Provedor",
"slug": "gasolina",
"title": {
"pt_BR": "Gasolina"
},
"valor": 1000
}
},
{
"uid": "d9fb3e3b-3f64-401a-9640-786cfad6c534",
"type": "f5887287-442e-4237-a738-31130ecf350a",
"slug": "vt",
"title": {
"pt_BR": "Vale Transporte"
},
"data": {
"desconto": "Formato de desconto.",
"slug": "vt",
"title": {
"pt_BR": "Vale Transporte"
},
"trajeto": "melhor"
}
}
],
"totalOfBenefits": 5
}
]{
"code": 400,
"messages": {
"account": "cannot be blank"
},
"result": null,
"status": "error"
}"b26803a7-3a7c-48d1-8a66-70a5e59f68fe" - Alimentação
"3f4e1ee3-c225-49df-9b17-3a4444dd59e0" - Assistência Odontológica
"47dcc73a-1985-40f5-98bd-07e00b9bf08a" - Assistência Médica
"b62f3492-3dcd-41e7-b644-40f4f72c753f" - Seguro de vida
"e3a19b9a-333d-4db9-b203-24baf0f3d984" - TransporteCria uma posição na filial selecionada. 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.
POST
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/account/:unit/json/position
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
unit*
string
UID da filial onde a posição será criada.
name*
string
Nome do candidato
email*
string
E-mail do candidato
mobile*
string, format("11911111111")
Número do celular do candidato
Exemplo de profile no payload
"profile": {
"name": "John Doe",
"email": "[email protected]",
"mobile": "11911111111"
},limit_date*
string, format("YYYY-mm-dd")
Data limite para o preenchimento do cadastro. Valor mínimo válido precisa ser maior ou igual à data atual
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. A string de "vinculo" é obrigatória.
Exemplo de dados obrigatórios no payload
"limit_date": "2028-01-01",
"role": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"department": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"pagamento": {
"vinculo": "clt"
},Campos opcionais para o payload
num_matricula
string
Número da matrícula
pos_number
string
Número da posição
cost_center
string
Centro de custo
admission_date
string, format("YYYY-mm-dd")
Data de admissão
deficiencia
boolean
Indica se a vaga é PCD
jornada
string
Informações sobre a jornada de trabalho
exame
object
Informações sobre o agendamento de exame médico
docs
array[string]
UIDs dos adicionais a serem solicitados para a vaga
benefits
array[string]
UIDs dos (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/Whats app
send_email
boolean
Indica a necessidade do envio da notificação para o candidato através de um e-mail
vinculo*
string (options)
Vínculo empregatício
Opções de vínculo
"clt", "estagio", "aprendiz", "autonomo", "temporario", "verde-amarelo", "intermitente", "estatuario"recorrencia
string (options)
Recorrência do pagamento
valor
string
Valor da remuneração
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
Opções de recorrência
"horista", "mensalista", "aulista", "comissionista", "diarista"Opções de agente integrador
"ciee", "nube", "senai", "senai_pa_barcarena", "senai_pe_sto_agostinho", "senai_mt_cuiaba", "senai_mt_nova_mutum", "senai_rj_rio_de_janeiro", "senai_mg_mariana", "senac", "mudes", "coep", "rede_cidada", "espro", "espro_sp_av_paulista", "espro_mg_belo_horizonte", "espro_sp_santo_amaro", "espro_sp_osasco", "espro_rj_rio_de_janeiro", "guarda_mirim", "iel", "iaq", "apae_jo_clemente", "gerar_guarapuva_ponta", "instituto_ser"Conta bancária
banco
string(options)
Código do banco do qual a carta de abertura de conta se refere (obrigatório apenas caso usar conta bancaria.)
carta
string
UID do arquivo contendo a carta de abertura de conta
template
string
UID do modelo de abertura de conta.
As opções de código de banco respeitam as configurações da plataforma. Essa configuração pode ser sobreposta pelas informações do payload, se e somente se no objeto “contaBancaria”, forem especificados ambos os atributos, “banco” e “carta”/”template” com valores válidos. Se for informado somente “banco”, vai respeitar as opções de banco cadastradas na empresa.
Exame
clinica*
string
UID ou código da clínica. (obrigatório apenas caso usar exame.)
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.
{
"profile": {
"name": "John Doe",
"email": "[email protected]",
"mobile": "11911111111"
},
"num_matricula": "4242424",
"limit_date": "2028-01-01",
"admission_date": "2028-01-01",
"cost_center": "anywhere",
"pos_number": "pos-test",
"role": "b63e065f-d7e0-49e1-91b7-88f74516e3fe",
"department": "bf559996-a8b9-4f5e-af57-86111b0dbde3",
"pagamento": {
"vinculo": "clt",
"valor": "4200",
"recorrencia": "mensalista",
"contaBancaria": {
"banco": "001",
"carta": "c9160763-db6c-4e8c-a1ad-ad8709c99be2"
}
},
"deficiencia": false,
"jornada": "De segunda a sexta das 15 as 19",
"exame": {
"clinica": "6dc84ce4-7d9f-48ec-b9b1-a8a895a21fd4",
"data": "2018-01-01",
"hora": "14:00",
"obs": "Comparecer de manhã",
"guia": "e37dab24-c7a4-4b92-b9d1-32ed538b8300",
},
"docs": ["c9e26093-5e0c-4bd2-bea3-ac5182a6179f"],
"send_sms": true,
"send_email": true
}Resposta:
"ok"Informações referente à pessoa, não estando relacionado à um documento
Campos
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()
estadoCivil*
string()
uniaoEstavel*
boolean
celular*
string
length(1, 255)
nacionalidade*
string
tipoNacionalidade*
string()
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
Opções de sexo
"feminino", "masculino"Opções de identidade de gênero
"cisgênero", "transgênero", "não-binário"Opções de orientação sexual
"heterossexual", "homossexual", "bissexual", "assexual", "panssexual"Opções de etnia
"branca", "negra", "parda", "amarela", "indigena", "nao-informado"Opções de tipo de nacionalidade
"brasileiro", "brasileiro-nascido-exterior", "naturalizado-brasileiro", "estrangeiro"Campos
Nome
Tipo
Observações
dependente*
boolean
filhosBrasileiros*
boolean
Campos
Nome
Tipo
Observações
relacionamento
string(options)
dependente
boolean
dataCasamento
string
format("YYYY-mm-dd")
Opções de relacionamento
"companheiro", "casado"Campos
Nome
Tipo
Observações
parentesco*
string(options)
length(0, 255)
naoPossuiRg
boolean
ensinoSuperior*
boolean
impostoRenda*
boolean
salarioFamilia*
boolean
Opções de parentesco
"irmao", "menor-pobre", "pai-mae", "avo", "bisavo", "filho", "neto", "bisneto", "conjuge", "companheiro", "sogro", "enteado", "ex-conjuge"Campos
Nome
Tipo
Observações
parentesco*
string
length(0, 255)
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)
{
"code": 201,
"messages": null,
"result": {
"position_id": "9ed9063b-ed1f-44f6-9b26-f3b57b64f632"
},
"status": "ok"
}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
Opções de vínculo
"clt", "estagio", "aprendiz", "autonomo", "temporario", "verde-amarelo", "intermitente", "estatuario"Opções de recorrência
"horista", "mensalista", "aulista", "comissionista", "diarista"Opções de agente integrador
"ciee", "nube", "senai", "senac", "mudes", "coep", "rede_cidada", "espro", "guarda_mirim", "outros"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
Opções de banco
"001", "033", "041", "047", "104", "151", "237", "341", "399", "735", "745", "748", "755"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
{
"numMatricula": "4242424",
"limitDate": "2018-01-01",
"admissionDate": "2018-01-01",
"costCenter": "anywhere",
"posNumber": "pos-test",
"role": "b63e065f-d7e0-49e1-91b7-88f74516e3fe",
"department": "bf559996-a8b9-4f5e-af57-86111b0dbde3",
"unitID": "e37dab24-c7a4-4b92-b9d1-d2ed538b8398",
"pagamento": {
"vinculo": "clt",
"valor": "4200",
"recorrencia": "mensalista",
"contaBancaria": {
"banco": "001",
"carta": "c9160763-db6c-4e8c-a1ad-ad8709c99be2"
}
},
"deficiencia": false,
"jornada": "De segunda a sexta das 15 as 19",
"profile": {
"name": "John Doe",
"email": "[email protected]",
"mobile": "11911111111"
},
"exame": {
"clinica": "6dc84ce4-7d9f-48ec-b9b1-a8a895a21fd4",
"data": "2018-01-01",
"hora": "14:00",
"obs":descricao-do-body-json-da-request-1 "Comparecer de manhã",
"guia": "e37dab24-c7a4-4b92-b9d1-32ed538b8300",
},
"docs": ["c9e26093-5e0c-4bd2-bea3-ac5182a6179f"],
"benefits": ["d4260f8d-f19a-463d-acdf-958ed358bb43"],
"sendSMS": true,
"sendEmail": true
}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
"created", "-created", "updated", "-updated"Opções de status
"pending", "review", "validation", "completed", "archived"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
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"limit": 100,
"skip": 0,
"template": "csv-v2.2",
"sort": "-created",
"status": [ "pending" ],
"dates": {
"admissionDate": {
"start": "2020-09-01",
"end": "2020-09-30"
}
}
}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.
Cria uma integração via webhook que é disparado para a api cadastrada quando determinados eventos relacionados a posição ocorrerem.
POST
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint: /v1/integrations/webhook
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
account*
string
UID da desejada.
data*
object
Configuração do callback que será realizado.
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.
url*
string
URL para a execução do callback. Aceito apenas
endereços HTTPS.
events*
array[]
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).
unit
string
UID da desejada.
authorization
object
Método de autenticação a 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.
Em caso de athorization, é obrigatório informar o kind e o data.
kind*
string (options)
Tipo da autenticação que será realizada.
data*
object
Configuração do tipo de autenticação escolhido.
Opções de kind
basic, secret, apiKeyAuthorization: data (basic)
username*
string
Nome do usuário.
password*
string
Senha do usuário.
Authorization: data (secret)
Chave
Tipo
Descrição
secret*
string
Chave que assinará a requisição.
ApiKey: data (apiKey)
key*
string
Chave da apiKey
prefix
string
Prefixo opcional que pode acompanhar o valor da apiKey.
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived",
"position-completed"
]
}
}{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d",
"authorization": {
"kind": "secret",
"data": {
"secret": "tme0dQq1CIDm4PYsfK!d"
}
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived",
"position-completed"
]
}
}{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d",
"authorization": {
"kind": "basic",
"data": {
"username": "teste",
"password": "1234"
}
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived"
]
}
}{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d",
"authorization": {
"kind": "apiKey",
"data": {
"key": "password123",
"prefix": "X-Api-Key" // opcional
}
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived"
]
}
}{
"id": "b712a527-efec-4e02-83d5-95cbd7c269f9",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d",
"authorization": {
"kind": "apiKey",
"data": {
"key": "password123",
"prefix": "X-Api-Key"
}
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived"
]
}
}{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"authorization": {
"kind": "secret"
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived",
"position-completed"
]
},
"uid": "a7c001fe-50bb-41cd-a910-da27e538726f",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d"
}Headers
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
{
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"position": "302fc619-2054-448c-a9f8-d1093fcaddf2",
"position-number": "ABC123",
"unit": "8a240932-7c99-40da-aeb8-37a89308c642",
"event": "position-archived"
}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
using System.Security.Cryptography;
private static byte[] HashHMAC(byte[] msg, String secret)
{
var key = Encoding.ASCII.GetBytes(secret);
var hash = new HMACSHA256(key);
return Convert.ToBase64String(hash.ComputeHash(msg));
}import (
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
)
func HashHMAC(msg []byte, secret string) string {
key := []byte(secret)
h := hmac.New(sha256.New, key)
h.Write(msg)
return base64.StdEncoding.EncodeToString(h.Sum(nil))
}import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Base64;
public static byte[] HashHMAC(byte[] msg, String secret) {
Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
sha256_HMAC.init(secret_key);
String hash = Base64.encodeBase64String(sha256_HMAC.doFinal(msg));
}import hashlib
import hmac
import base64
def hashHMAC(msg, secret):
key = bytes(secret, 'utf-8')
signature = base64.b64encode(hmac.new(key, message, digestmod=hashlib.sha256).digest())
return signaturePUT https://api.acessorh.com.br/v1/integrations/webhook
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer).
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d",
"authorization": {
"kind": "basic"
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived"
]
},
"uid": "0a22e148-6610-4d38-bcb7-20bbc465d43c"
}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.
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).
{
"total": 2,
"results": [
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"authorization": {
"kind": "secret"
},
"data": {
"url": "https://api.teste.com.br/callback",
"events": [
"position-created",
"position-archived",
"position-completed"
]
},
"uid": "a7c001fe-50bb-41cd-a910-da27e538726f",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d"
},
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"authorization": {
"kind": "basic"
},
"data": {
"url": "https://api.teste.com.br/callback/applied",
"events": [
"position-applied"
]
},
"uid": "32b3f3d0-59dc-4cf1-9b4d-4ffcd04a14e4",
"unit": "82930d53-e99a-4927-b31e-4fdc7090395d"
}
]
}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.
{
"id": "b712a527-efec-4e02-83d5-95cbd7c269f9",
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e"
}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).
{
"total": 2,
"results": [
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"data": {
"request": {
"headers": {
"Accept": [
"application/json"
],
"Acesso-Delivery-Id": [
"c8815dab-d6be-4a8d-9c68-62ee849fed39"
],
"Acesso-Signature": [
"jZXci/I69WDH5y7Vt2I3daJRWL9jX7pf2eL9+676KWo="
],
"Content-Type": [
"application/json"
],
"User-Agent": [
"go-resty/1.11.0 (https://github.com/go-resty/resty)"
]
},
"payload": {
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"position": "302fc619-2054-448c-a9f8-d1093fcaddf2",
"position-number": null,
"unit": "8a240932-7c99-40da-aeb8-37a89308c642",
"event": "position-archived"
}
},
"response": {
"headers": {
"Content-Length": [
"202"
],
"Content-Type": [
"application/json"
],
"Date": [
"Thu, 26 Dec 2019 16:01:26 GMT"
]
},
"status": 200,
"body": "eyJldmVudCI6InBvc2l0aW9uLWFyY2hpdmVkIiwiaW50ZWdyYXRpb24iOiIwYTIyZTE0OC02NjEwLTRkMzgtYmNiNy0yMGJiYzQ2NWQ0M2MiLCJwb3NpdGlvbiI6IjMwMmZjNjE5LTIwNTQtNDQ4Yy1hOWY4LWQxMDkzZmNhZGRmMiIsInBvc2l0aW9uLW51bWJlciI6bnVsbCwidW5pdCI6IjhhMjQwOTMyLTdjOTktNDBkYS1hZWI4LTM3YTg5MzA4YzY0MiJ9Cg=="
}
},
"id": "c8815dab-d6be-4a8d-9c68-62ee849fed39",
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"organization": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
"timestamp": "2019-12-26T16:01:26.225Z",
"type": "webhook"
},
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"data": {
"request": {
"headers": {
"Accept": [
"application/json"
],
"Acesso-Delivery-Id": [
"cb549c0f-ae08-44bc-b729-7d46b9b6c4cc"
],
"Acesso-Signature": [
"tClrDZ0umoMpVKKz6JpMmKXxeu3BVdU9bcUScKl5b6Q="
],
"Content-Type": [
"application/json"
],
"User-Agent": [
"go-resty/1.11.0 (https://github.com/go-resty/resty)"
]
},
"payload": {
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"position": "302fc619-2054-448c-a9f8-d1093fcaddf2",
"position-number": null,
"unit": "8a240932-7c99-40da-aeb8-37a89308c642",
"event": "position-completed"
}
},
"response": {
"headers": {
"Content-Length": [
"203"
],
"Content-Type": [
"application/json"
],
"Date": [
"Thu, 26 Dec 2019 16:00:59 GMT"
]
},
"status": 200,
"body": "eyJldmVudCI6InBvc2l0aW9uLWNvbXBsZXRlZCIsImludGVncmF0aW9uIjoiMGEyMmUxNDgtNjYxMC00ZDM4LWJjYjctMjBiYmM0NjVkNDNjIiwicG9zaXRpb24iOiIzMDJmYzYxOS0yMDU0LTQ0OGMtYTlmOC1kMTA5M2ZjYWRkZjIiLCJwb3NpdGlvbi1udW1iZXIiOm51bGwsInVuaXQiOiI4YTI0MDkzMi03Yzk5LTQwZGEtYWViOC0zN2E4OTMwOGM2NDIifQo="
}
},
"id": "cb549c0f-ae08-44bc-b729-7d46b9b6c4cc",
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"organization": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
"timestamp": "2019-12-26T16:00:59.776Z",
"type": "webhook"
}
]
}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).
{
"account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
"data": {
"request": {
"headers": {
"Accept": [
"application/json"
],
"Acesso-Delivery-Id": [
"c8815dab-d6be-4a8d-9c68-62ee849fed39"
],
"Acesso-Signature": [
"jZXci/I69WDH5y7Vt2I3daJRWL9jX7pf2eL9+676KWo="
],
"Content-Type": [
"application/json"
],
"User-Agent": [
"go-resty/1.11.0 (https://github.com/go-resty/resty)"
]
},
"payload": {
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"position": "302fc619-2054-448c-a9f8-d1093fcaddf2",
"position-number": null,
"unit": "8a240932-7c99-40da-aeb8-37a89308c642",
"event": "position-archived"
}
},
"response": {
"headers": {
"Content-Length": [
"202"
],
"Content-Type": [
"application/json"
],
"Date": [
"Thu, 26 Dec 2019 16:01:26 GMT"
]
},
"status": 200,
"body": "eyJldmVudCI6InBvc2l0aW9uLWFyY2hpdmVkIiwiaW50ZWdyYXRpb24iOiIwYTIyZTE0OC02NjEwLTRkMzgtYmNiNy0yMGJiYzQ2NWQ0M2MiLCJwb3NpdGlvbiI6IjMwMmZjNjE5LTIwNTQtNDQ4Yy1hOWY4LWQxMDkzZmNhZGRmMiIsInBvc2l0aW9uLW51bWJlciI6bnVsbCwidW5pdCI6IjhhMjQwOTMyLTdjOTktNDBkYS1hZWI4LTM3YTg5MzA4YzY0MiJ9Cg=="
}
},
"id": "c8815dab-d6be-4a8d-9c68-62ee849fed39",
"integration": "0a22e148-6610-4d38-bcb7-20bbc465d43c",
"organization": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
"timestamp": "2019-12-26T16:01:26.225Z",
"type": "webhook"
}Exibe a posição selecionada.
GET
Url Produção: https://api.acessorh.com.br
Url Homologação: https://api.rh.homolog.acesso.io
Endpoint:/v1/positions/:position
Headers
Authorization*
string
Token de acesso adquirido pela plataforma Identity (bearer)
Path Parameters
position*
string
UID ou código da posição desejada (obrigatório). .
Query Parameters
unit
string
UID da filial do qual a posição pertence. .
includes
string
Lista com os campos opcionais que podem ser visualizados separados por vírgula
Campos opcionais | includes
"role","benefits","department","persons","unit","attachments","decline"curl --location 'https://api.acessorh.com.br/v1/positions/UID DO CANDIDATO?includes=role%2Cbenefits%2Cdepartment%2Cpersons%2Cunit%2Cattachments%2Cdecline' \
--header 'Authorization: Bearer token de autorização' \
--data ''