PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas | HCM - senior X

Buscar todas as informações de uma pré-admissão — APIs da Admissão Digital

Busca todas as informações de uma pré-admissão específica, com base no identificador único dessa pré-admissão.

¿Hablas español?

Acceda a la documentación en su idioma.

Definições da API:

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/queries/preAdmissionQuery

Substitua<url_plataforma>*pela URL correspondente ao seu ambiente. Se for o ambiente de produção, substitua por:*https://platform.senior.com.br

Cabeçalho (Header)

Authorization

Bearer​ <access_token>

Content-Type

application/json

Substitua<access_token>pela chave de acesso obtida a partir da API de autenticação na plataforma.

Parâmetros

* Obrigatórios

Parâmetro

Tipo

Descrição
preAdmissionId *

String

Identificador único da pré-admissão.

Exemplo

{
  "preAdmissionId": "string",
}

Respostas

Código

Descrição

Campos da resposta
200

Ok

Campo

Tipo

Descrição

País

result { }

Resultados da requisição.

Brasil

preAdmissionId

String

Identificador único da pré-admissão.

Brasil

admissionDate

String

Data em que o novo colaborador será admitido.

Brasil

contract { }

Informações de contrato com a empresa.

Brasil

personalData { }

Informações pessoais do novo colaborador.

Brasil

personalDataCOL { }

Informações pessoais do novo colaborador Col.

Colômbia

document { }

Documentos do novo colaborador.

Brasil

documentCOL { }

Documentos do novo colaborador Col.

Colômbia

vacancyCode

Long

Número da vaga gerada pelo módulo ATS Gestão de Recrutamento e Seleção do HCM senior X. Este parâmetro é usado pelo GRS para enviar as informações da vaga e do candidato para as pré-admissões no sistema da Admissão Digital.

Brasil

withdrawal

Sinaliza se o candidato desistiu da pré-admissão.

Brasil

withdrawalData

preAdmissionReasonWithdrawalData{}

Retorna todas os registros de desistência da pré-admissão.

Brasil

dependents { }

Relação de dependentes do novo colaborador.

Brasil

dependentsCOL { }

Relação de dependentes do novo colaborador Col.

Colômbia
Conteúdo de contract:

Campo

Tipo

Descrição

País

employeeType

String

Tipo do colaborador.

Brasil

employeeContract

String

Tipo de contrato.

Brasil

eSocialCategory

String

Categoria do eSocial.

Brasil

sefipCategory

String

Categoria da SEFIP.

Brasil

unemploymentInsurance

String

Tipo do seguro desemprego.

Brasil

raisType

String

Vínculo da RAIS.

Brasil

customFields { }

Campos customizados.
Conteúdo de personalData:

Campo

Tipo

Descrição

País

basic { }

Informações básicas do novo colaborador.

Brasil

employeeFullName

String

Nome completo.

Brasil

gender

String

Gênero.

Brasil

birthDate

String

Data de nascimento.

Brasil

preferredName

String

Nome pelo qual prefere ser chamado.

Brasil

mothersName

String

Nome da mãe.

Brasil

fathersName

String

Nome do pai.

Brasil

customFields { }

Campos customizados.

complementary { }

Informações complementares do novo colaborador.

Brasil

maritalStatus

String

Estado civil.

Brasil

degreeOfEducation

String

Grau de instrução.

Brasil

nationality

String

Nacionalidade.

Brasil

religion

String

Religião.

Brasil

race

String

Raça/Cor.

Brasil

socialName

String

Nome social.

Brasil

customFields { }

Campos customizados.

birthPlace { }

Informações do local de nascimento do novo colaborador.

Brasil

country

String

País do local de nascimento.

Brasil

state

String

Estado do local de nascimento.

Brasil

city

String

Cidade do local de nascimento.

Brasil

customFields { }

Campos customizados.

address { }

Informações do endereço do novo colaborador.

Brasil

country

String

País.

Brasil

state

String

Estado/unidade federativa.

Brasil

city

String

Cidade.

Brasil

cep

String

CEP.

Brasil

neighborhood

String

Bairro.

Brasil

addressType

String

Logradouro.

Brasil

address

String

Endereço.

Brasil

number

String

Número do endereço.

Brasil

additional

String

Informações adicionais sobre o endereço.

Brasil

customFields { }

Campos customizados.

email { }

E-mails de contato do novo colaborador.

Brasil

firstType

String

Tipo do e-mail principal.

Brasil

firstEmail

String

E-mail principal do novo colaborador.

Brasil

secondType

String

Tipo do e-mail secundário.

Brasil

secondEmail

String

E-mail secundário do novo colaborador.

Brasil

customFields { }

Campos customizados.

phone { }

Telefones de contato do novo colaborador.

Brasil

firstType

String

Tipo do telefone principal.

Brasil

firstPhone

String

Telefone principal do novo colaborador.

Brasil

secondType

String

Tipo do telefone secundário.

Brasil

secondPhone

String

Telefone secundário do novo colaborador.

Brasil

customFields { }

Campos customizados.
Conteúdo de personalDataCOL:

Campo

Tipo

Descrição

País

basic { }

Informações básicas do novo colaborador Col.

Colômbia

firstName

String

Primeiro nome do novo colaborador.

Colômbia

middleName

String

Nome do meio do novo colaborador.

Colômbia

firstSurname

String

Primeiro sobrenome do novo colaborador.

Colômbia

secondSurname

String

Segundo sobrenome do novo colaborador.

Colômbia

preferredName

String

Nome pelo qual o novo colaborador prefere ser chamado.

Colômbia

gender

String

Gênero do novo colaborador.

Colômbia

birthDate

String

Data de nascimento do novo colaborador.

Colômbia

customFields { }

Campos customizados.

complementary { }

Informações complementares do novo colaborador Col.

Colômbia

maritalStatus

String

Estado civil.

Colômbia

degreeOfEducation

String

Grau de instrução.

Colômbia

nationality

String

Nacionalidade.

Colômbia

religion

String

Religião.

Colômbia

ethnicity

String

Etnia.

Colômbia

socialName

String

Nome social.

Colômbia

bloodType

String

Tipo sanguíneo

Colômbia

bloodFactor

String

Fator de sangue.

Colômbia

height

String

Altura.

Colômbia

weigth

String

Peso.

Colômbia

customFields { }

Campos customizados.

emergencyContact{}

Contato de emergência do novo colaborador Col

Colômbia

firstContactName

String

Nome do primeiro contato.

Colômbia

firstContactKinship

String

Parentesco do primeiro contato.

Colômbia

firstContactPhone

String

Telefone do primeiro contato.

Colômbia

secondContactName

String

Nome do segundo contato.

Colômbia

secondContactKinship

String

Parentesco do segundo contato.

Colômbia

secondContactPhone

String

Telefone do segundo contato.

Colômbia

customFields { }

Campos customizados.

birthPlace { }

Informações do local de nascimento do novo colaborador Col.

Colômbia

country

String

País do local de nascimento.

Colômbia

state

String

Estado do local de nascimento.

Colômbia

city

String

Cidade do local de nascimento.

Colômbia

customFields { }

Campos customizados.

address { }

Informações do endereço do novo colaborador.

Colômbia

country

String

País.

Colômbia

state

String

Estado/unidade federativa.

Colômbia

city

String

Cidade.

Colômbia

cep

String

CEP.

Colômbia

neighborhood

String

Bairro.

Colômbia

addressType

String

Logradouro.

Colômbia

address

String

Endereço.

Colômbia

number

String

Número do endereço.

Colômbia

additional

String

Informações adicionais sobre o endereço.

Colômbia

customFields { }

Campos customizados.

phone { }

Telefones de contato do novo colaborador.

Colômbia

firstType

String

Tipo do telefone principal.

Colômbia

firstPhone

String

Telefone principal do novo colaborador.

Colômbia

secondType

String

Tipo do telefone secundário.

Colômbia

secondPhone

String

Telefone secundário do novo colaborador.

Colômbia

customFields { }

Campos customizados.

email { }

E-mails de contato do novo colaborador.

Colômbia

firstType

String

Tipo do e-mail principal.

Colômbia

firstEmail

String

E-mail principal do novo colaborador.

Colômbia

secondType

String

Tipo do e-mail secundário.

Colômbia

secondEmail

String

E-mail secundário do novo colaborador.

Colômbia

customFields { }

Campos customizados.
Conteúdo de document:

  Campo

Tipo

Descrição

País

cpf { }

Informações do Cadastro de Pessoa Física (CPF) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

customFields { }

Campos customizados.

pis { }

Informações do Programa de Integração Social (PIS) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

customFields { }

Campos customizados.

ctps { }

Informações da Carteira de Trabalho e Previdência Social (CTPS) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

serie

String

Número de série do documento.

Brasil

digit

String

Dígito do número do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

customFields { }

Campos customizados.

rg { }

Informações do Registro Geral (RG) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

fathersName

String

Nome do pai do novo colaborador.

Brasil

mothersName

String

Nome da mãe do novo colaborador.

Brasil

birthDate

Date

Data de nascimento do novo colaborador.

Brasil

doesntHave

Boolean

Indica se a pessoa possui a carteira de identidade (RG).

Brasil

customFields { }

Campos customizados.

passport { }

Informações do Passaporte do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

expiryDate

String

Data de validade do documento.

Brasil

issuerCountry

String

País de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

customFields { }

Campos customizados.

ric { }

Informações do Registro de Identidade Civil (RIC) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

expiryDate

String

Data de validade do documento.

Brasil

customFields { }

Campos customizados.

voter { }

Informações do Título de Eleitor do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

votingDistrict

String

Zona eleitoral do documento.

Brasil

votingSection

String

Seção de votação do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

customFields { }

Campos customizados.

cnh { }

Informações da Carteira Nacional de Habilitação (CNH) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

category

String

Categoria da habilitação.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

expiryDate

String

Data de validade do documento.

Brasil

firstDriverLicenseDate

String

Data da primeira habilitação.

Brasil

customFields { }

Campos customizados.

reservist { }

Informações do Certificado de Reservista do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

serie

String

Número de série do documento.

Brasil

ra

String

Número do Registro de Alistamento (RA).

Brasil

exemptionDate

String

Data de dispensa.

Brasil

hasCertificate

Boolean

Indica se a pessoa tem certificado de reservista.

Brasil

customFields { }

Campos customizados.

civilCertificate { }

Informações da Certidão Civil do novo colaborador.

Brasil

type

String

Tipo da certidão.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

registry

String

Matrícula da certidão.

Brasil

term

String

Termo da certidão.

Brasil

book

String

Livro da certidão.

Brasil

sheet

String

Folha da certidão.

Brasil

notaryOffice

String

Cartório da certidão.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

customFields { }

Campos customizados.

cns { }

Informações do Cartão Nacional de Saúde (CNS) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

customFields { }

Campos customizados.

dnv { }

Informações da Declaração de Nascido Vivo (DNV) do novo colaborador.

Brasil

number

String

Número do documento.

Brasil

customFields { }

Campos customizados.

bankAccount { }

Brasil

bank

String

Identificador do banco.

Brasil

branch

String

Número da agência bancária.

Brasil

accountType

String

Tipo da conta.

Brasil

bankAccount

String

Conta bancária.

Brasil

digit

String

Dígito da conta.

Brasil

customFields { }

Campos customizados.

receiveSalaryAdvance

String

Indicativo se o novo colaborador gostaria de receber adiantamento salarial.

Brasil

rne { }

Brasil

number

String

Número do documento (RNE).

Brasil

arrivalDate

DateTime

Data e hora de chegada no país.

Brasil

residenceTime

_

Tempo de permanência no país.

Brasil

conditionVisaType

_

Tipo de visto.

Brasil

issuer

String

Orgão emissor do documento.

Brasil

issueDate

Date

Data da emissão do documento.

Brasil

expiryDate

Date

Data de validade do documento.

Brasil

ordinanceNumber

String

Número da Portaria.

Brasil

marriedWithBrazilian

_

Identifica se o novo colaborador é casado com uma pessoa brasileira.

Brasil

brazilianChildren

_

Identifica se o novo colaborador tem filhos brasileiros.

Brasil

fathersName

String

Nome do pai do novo colaborador.

Brasil

mothersName

String

Nome da mãe do novo colaborador.

Brasil

birthDate

Date

Data de nascimento do novo colaborador.

Brasil

doesntHave

Boolean

Indica se a pessoa possui o Registro Nacional de Estrangeiro (RNE), indicando que ela é uma estrangeira no Brasil.

Brasil

customFields { }

_

Campos customizados criados no modelo de convite de pré-admissão.

Brasil

professionalRecord { }

Informações do Conselho Profissional do novo colaborador.

Brasil

professionalAdvice

String

Conselho Profissional.

Brasil

number

String

Número.

Brasil

isTemporary

String

É temporário.

Brasil

mteNumber

String

Número no Ministério do Trabalho.

Brasil

shippingDate

String

Data de expedição.

Brasil

dueDate

String

Data de vencimento.

Brasil

customFields { }

Campos customizados.

hiringMedicalExam { }

Informação sobre a data do exame admissional do colaborador.

Brasil

examDate

String

Data do exame.

Brasil

customFields { }

Campos customizados.
Conteúdo de documentDataCOL:

  Campo

Tipo

Descrição

País

identityDocument { }

Documento de identificação do novo colaborador Col

Colômbia

number

String

Número do documento.

Colômbia

documentType

String

Tipo do documento

Colômbia

issueDate

String

Data de emissão

Colômbia

issuerCountry

String

País de emissão

Colômbia

issuerState

String

Estado de emissão

Colômbia

issuerCity

String

Cidade de emissão

Colombia

doesntHave

Boolean

Se a pessoa não possui documento de identificação?

Colômbia

customFields { }

Campos customizados.

professionalRecord { }

Registro profissional do novo colaborador Col

Colômbia

number

String

Número do documento.

Colômbia

issueDate

String

Data de emissão do documento.

Colômbia

doesntHave

Boolean

Se a pessoa não possui registro profissional.

Colômbia

customFields { }

Campos customizados.

militaryServiceBook { }

Carteira de reservista do novo colaborador Col

Colômbia

number

String

Número do documento.

Colômbia

issueDate

String

Data de emissão do documento.

Colômbia

militaryServiceBookClass

String

Relacionamento da militaryServiceBookClassCOL.

Colômbia

district

String

Distrito do documento.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui dados do livro de serviço militar.

Colômbia

driverLicense { }

Licença de condução do novo colaborador Col

Colômbia

number

String

Número do documento.

Colômbia

category

String

Categoria da habilitação.

Colômbia

issueDate

String

Data de emissão do documento.

Colômbia

expiryDate

String

Data de validade do documento.

Colômbia

issuer

String

Emissor do documento.

Colômbia

restrictions

String

Restrições do documento.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui dados de licença de motorista.

Colômbia

epsAffiliation { }

Afiliação EPS do novo colaborador Col

Colômbia

name

String

Nome da EPS.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui EPS.

Colômbia

afpAffiliation{ }

Afiliação AFP do novo colaborador Col

Colômbia

name

String

Nome da AFP.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui AFP.

Colômbia

severanceAffiliation{ }

Afiliação AFP do novo colaborador Col

Colômbia

name

String

Nome da afiliação de indenização.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui dados de indenização de afiliação.

Colômbia

bankAccount { }

Conta bancária do novo colaborador Co

Colômbia

bank

String

Identificador do banco.

Colômbia

branch

String

Número da agência bancária.

Colômbia

accountType

String

Tipo da conta.

Colômbia

bankAccount

String

Conta bancária.

Colômbia

digit

String

Dígito da conta.

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Se a pessoa não possui conta bancária.

Colômbia

workCertificate { }

Certificados de trabalho do novo colaborador Col

Colômbia

workCertificateItem

String

Itens de certificados do candidato.

Colômbia

hasWorkCertificate

Boolean

Informa se o candidato tem certificado de trabalho.

Colômbia

doesntHave

Boolean

Campo não possui (se o candidato não tem certificado de trabalho).

Colômbia

studyCertificate { }

Certificados de estudo do novo colaborador Col

Colômbia

studyCertificateItem

String

Itens de certificados do candidato.

Colômbia

hasStudyCertificate

Boolean

Informa se o candidato tem certificado de estudo.

Colômbia

doesntHave

Boolean

Campo não possui (se o candidato não tem certificado de estudo).

Colômbia

documentReference { }

Referências do novo colaborador Col

Colômbia

documentReferenceItem

String

Itens de certificados do candidato.

Colômbia

hasDocumentReference

Boolean

Informa se o candidato tem certificado de referência.

Colômbia

doesntHave

Boolean

Campo não possui (se o candidato não tem certificado de referência).

Colômbia

backgroundInformation{ }

Informações de fundo do novo colaborador Col

Colômbia

customFields { }

Campos customizados.

doesntHave

Boolean

Campo não possui (se o candidato não tem certificado de referência).

Colômbia

passport { }

Informações do Passaporte do novo colaborador.

Colômbia

number

String

Número do documento.

Colômbia

issuer

String

Órgão emissor do documento.

Colômbia

issueDate

String

Data de emissão do documento.

Colômbia

expiryDate

String

Data de validade do documento.

Colômbia

issuerCountry

String

País de emissão do documento.

Colômbia

issuerState

String

Estado de emissão do documento.

Colômbia

doesntHave

Boolean

Se a pessoa não possui passaporte.

Colômbia

customFields { }

Campos customizados.
Conteúdo de dependents:

Campo

Tipo

Descrição

País

fullName

String

Nome completo do dependente.

Brasil

degreeOfKinship

String

Grau de parentesco com o dependente.

Brasil

gender

String

Gênero do dependente.

Brasil

birthDate

String

Data de nascimento do dependente.

Brasil

mothersName

String

Nome da mãe do dependente.

Brasil

maritalStatus

String

Estado civil do dependente.

Brasil

declareIncomeTax

String

Indica se o dependente declara Imposto de Renda.

Brasil

cpf { }

Informações do Cadastro de Pessoa Física (CPF) do dependente.

Brasil

number

String

Número do documento.

Brasil

customFields { }

Campos customizados.

rg { }

Informações do Registro Geral (RG) do dependente.

Brasil

number

String

Número do documento.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

customFields { }

Campos customizados.

ric { }

Informações do Registro de Identidade Civil (RIC) do dependente.

Brasil

number

String

Número do documento.

Brasil

issuer

String

Órgão emissor do documento.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

expiryDate

String

Data de validade do documento.

Brasil

customFields { }

Campos customizados.

sus { }

Informações doCartão do sistema único de saúde (SUS).

Brasil

number

String

Número do documento.

Brasil

customFields { }

Campos customizados.

vaccinationBooklet { }

Informações da Caderneta de Vacinação.

Brasil

customFields { }

Campos customizados.

proofOfEnrollment { }

Informações do comprovante de matrícula.

Brasil

customFields { }

Campos customizados.

birthCertificate { }

Informações da Certidão de Nascimento do dependente.

Brasil

type

String

Tipo da certidão.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

registry

String

Matrícula da certidão.

Brasil

term

String

Termo da certidão.

Brasil

book

String

Livro da certidão.

Brasil

sheet

String

Folha da certidão.

Brasil

notaryOffice

String

Cartório da certidão.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

customFields { }

Campos customizados.

deathCertificate { }

Informações da Certidão de Óbito do dependente.

Brasil

type

String

Tipo da certidão.

Brasil

issueDate

String

Data de emissão do documento.

Brasil

registry

String

Matrícula da certidão.

Brasil

term

String

Termo da certidão.

Brasil

book

String

Livro da certidão.

Brasil

sheet

String

Folha da certidão.

Brasil

notaryOffice

String

Cartório da certidão.

Brasil

issuerCity

String

Cidade de emissão do documento.

Brasil

issuerState

String

Estado de emissão do documento.

Brasil

customFields { }

Campos customizados.

customFields { }

Campos customizados.
Conteúdo de dependentsCOL:

Campo

Tipo

Descrição

País

firstName

String

Primeiro nome do dependente.

Colômbia

firstSurname

String

Primeiro sobrenome

Colômbia

secondSurname

String

Segundo sobrenome

Colômbia

number

String

Número do dependente

Colômbia

epsBeneficiary

String

EPS beneficiario do dependente?

Colômbia

compensationFundBeneficiary

String

Compensação de fundo beneficiario do dependente?

Colômbia

livesWithCollab

String

Vive com o colaborador?

Colômbia

degreeOfKinship

String

Grau de parentesco com o dependente.

Colômbia

gender

String

Gênero do dependente.

Colômbia

birthDate

String

Data de nascimento do dependente.

Colômbia

declareIncomeTax

String

Declara imposto de renda?

Colômbia

documentType

String

Tipo do documento

Colômbia

maritalStatus

String

Estado civil do dependente.

Colômbia

spouse

String

Cônjuge dependente.

Colômbia

customFields { }

Campos customizados.

child{}

Filho dependente.

Colômbia

customFields { }

Campos customizados.

parent{ }

Filho dependente.

Colômbia

customFields { }

Campos customizados.

customFields { }

Campos customizados.
Conteúdo de preAdmissionReasonWithdrawalData:

Campo

Tipo

Descrição

País

id

String

Identificador único do registro.

Brasil

preAdmission

String

Identificador da pré-admissão a que se refere o registro.

Brasil

withdrawal

Identifica a situação que gerou o registro (desistência ou reabilitação).

Brasil

reason

String

Justificativa da desistência/reabilitação.

Brasil
Conteúdo de customFields:

Campo

Tipo

Descrição

País

field

String

Nome do campo customizado.

Brasil/Colômbia

value

String

Valor do campo customizado.

Brasil/Colômbia
401

Invalid credentials

  _

default

Error response

Campo

Tipo

Descrição

message

String

Mensagem descritiva do erro.

reason

String

Um código que representa a categoria da causa do erro.
Exemplo da resposta (200):
{
    "result": {
        "preAdmissionId": "string",
        "admissionDate": "2022-02-10",
        "contract": {
        "employeeType": "string",
        "employeeContract": "string",
        "eSocialCategory": "string",
        "sefipCategory": "string",
        "unemploymentInsurance": "string",
        "raisType": "string",
        "company": {
            "id": "string",
            "companyName": "string",
            "code": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "branchOffice": {
            "id": "string",
            "branchOfficeName": "string",
            "tradingName": "string",
            "code": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "jobPosition": {
            "id": "string",
            "name": "string",
            "code": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "customFields": [
            {
            "field": "string",
            "value": "string",
            "valueList": [
                "string"
            ]
            {
        ]
        {,
        "personalData": {
        "basic": {
            "employeeFullName": "string",
            "gender": "string",
            "birthDate": "2022-02-10",
            "preferredName": "string",
            "mothersName": "string",
            "fathersName": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "complementary": {
            "maritalStatus": "string",
            "degreeOfEducation": 0,
            "nationality": "string",
            "religion": "string",
            "race": "string",
            "socialName": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "birthPlace": {
            "country": "string",
            "state": "string",
            "city": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "address": {
            "country": "string",
            "state": "string",
            "city": "string",
            "cep": "string",
            "neighborhood": "string",
            "addressType": "string",
            "address": "string",
            "number": "string",
            "additional": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "email": {
            "emailPersonal": "string",
            "emailBusiness": "string",
            "firstType": "string",
            "firstEmail": "string",
            "secondType": "string",
            "secondEmail": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "phone": {
            "firstType": "string",
            "firstPhone": "string",
            "secondType": "string",
            "secondPhone": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {
        {,
        "document": {
        "cpf": {
            "number": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "pis": {
            "number": "string",
            "issueDate": "2022-02-10",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "ctps": {
            "number": "string",
            "serie": "string",
            "digit": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "rg": {
            "number": "string",
            "issuer": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10"<MadCap:conditionalText MadCap:conditions="admissao-digital/documento-rne.documento-rne">,        "doesntHave": "false",</MadCap:conditionalText>        "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "passport": {
            "number": "string",
            "issuer": "string",
            "issueDate": "2022-02-10",
            "expiryDate": "2022-02-10",
            "issuerCountry": "string",
            "issuerState": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "ric": {
            "number": "string",
            "issuer": "string",
            "issuerCity": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10",
            "expiryDate": "2022-02-10",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "voter": {
            "number": "string",
            "votingDistrict": "string",
            "votingSection": "string",
            "issueDate": "2022-02-10",
            "issuerCity": "string",
            "issuerState": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "cnh": {
            "number": "string",
            "category": "string",
            "issuer": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10",
            "expiryDate": "2022-02-10",
            "firstDriverLicenseDate": "2022-02-10",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "reservist": {
            "number": "string",
            "serie": "string",
            "ra": "string",
            "exemptionDate": "2022-02-10",
            "hasCertificate": true,
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "civilCertificate": {
            "type": "string",
            "issueDate": "2022-02-10",
            "registry": "string",
            "term": "string",
            "book": "string",
            "sheet": "string",
            "notaryOffice": "string",
            "issuerCity": "string",
            "issuerState": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "cns": {
            "number": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "dnv": {
            "number": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "bankAccount": {
            "bank": "string",
            "branch": 0,
            "accountType": "string",
            "bankAccount": "string",
            "digit": "string",
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {,
        "receiveSalaryAdvance": "string"
        {,
        "dependents": [
        {
            "fullName": "string",
            "degreeOfKinship": "string",
            "gender": "string",
            "birthDate": "2022-02-10",
            "mothersName": "string",
            "maritalStatus": "string",
            "declareIncomeTax": "string",
            "cpf": {
            "number": "string",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "rg": {
            "number": "string",
            "issuer": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "ric": {
            "number": "string",
            "issuer": "string",
            "issuerCity": "string",
            "issuerState": "string",
            "issueDate": "2022-02-10",
            "expiryDate": "2022-02-10",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "sus": {
            "number": "string",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "vaccinationBooklet": {
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "proofOfEnrollment": {
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "deathCertificate": {
            "type": "string",
            "issueDate": "2022-02-10",
            "registry": "string",
            "term": "string",
            "book": "string",
            "sheet": "string",
            "notaryOffice": "string",
            "issuerCity": "string",
            "issuerState": "string",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "birthCertificate": {
            "type": "string",
            "issueDate": "2022-02-10",
            "registry": "string",
            "term": "string",
            "book": "string",
            "sheet": "string",
            "notaryOffice": "string",
            "issuerCity": "string",
            "issuerState": "string",
            "customFields": [
                {
                "field": "string",
                "value": "string",
                "valueList": [
                    "string"
                ]
                {
            ]
            {,
            "customFields": [
            {
                "field": "string",
                "value": "string",
                "valueList": [
                "string"
                ]
            {
            ]
        {
        ]
        "vacancyCode": 3
    {
    {
Exemplo da resposta (default):
    {
        "message": "string",
        "reason": "BAD_REQUEST"
    }

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).