Ver site completo

PORTAL DE DOCUMENTAÇÃO
Gestão de Pessoas | HCM - senior X
Gestão de Pessoas - senior X - Manual do Usuário > Admissão Digital > Integrações > Integração via APIs > Enviar convites de pré-admissão (preAdmissionSend)

Enviar convites de pré-admissão — APIs da Admissão Digital

Envia um convite para iniciar o processo de pré-admissão de um novo colaborador. Durante o processo de envio, a API valida as informações da requisição e retorna se o convite foi enviado com sucesso ou não.

Definições da API:

URL

POST <url_plataforma>/t/senior.com.br/bridge/1.0/rest/hcm/onboardingintegration/actions/preAdmissionSend

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 Preenchimento
employeeName * String Nome completo do novo colaborador. Obrigatório
employeeEmail String E-mail do novo colaborador. Opcional
employeeMobilePhone String Número de telefone celular do novo colaborador. Opcional
key String

Chave da pré-admissão. Para convites brasileiros, a chave de identificação é o CPF do novo colaborador.

Este parâmetro é obrigatório somente se a empresa o definiu como obrigatório no envio do modelo de convite. Caso contrário, permanece opcional.

 -
admissionDate * Date Data de admissão do novo colaborador. Obrigatório
modelId * String Identificador único do modelo de convite associado a pré-admissão. Obrigatório
additionalInfo String Informação adicional que pode ser enviada no modelo de convite. Opcional
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.

O parâmetro vacancyCode é opcional e é usado exclusivamente pelo GRS. Caso não tenha a integração da Admissão Digital com este sistema, este parâmetro não deve ser usado.

Quando este código existir, você pode obtê-lo fazendo uma requisição para o endpoint preAdmissionQuery.

 Opcional
jobPosition String

Identificador único do cargo.

Este parâmetro é obrigatório somente se a empresa o definiu como obrigatório no envio do modelo de convite. Caso contrário, permanece opcional.

 -
branchOffice String

Identificador único da filial.

Este parâmetro é obrigatório somente se a empresa o definiu como obrigatório no envio do modelo de convite. Caso contrário, permanece opcional.

 -
costCenterld String

Identificador único do centro de custo.

Este parâmetro é obrigatório somente se a empresa o definiu como obrigatório no envio do modelo de convite. Caso contrário, permanece opcional.

 -
workstationld String

Identificador único do posto de trabalho.

Este parâmetro é obrigatório somente se a empresa o definiu como obrigatório no envio do modelo de convite. Caso contrário, permanece opcional.

 -
company String Identificador único da empresa. Opcional
employeeMobilePhoneOption String

Forma de recebimento de convite pelo novo colaborador.

ClosedValores permitidos:
  • SMS = Envio do convite via SMS
  • WHATSAPP = Envio do convite via WhatsApp
  • ALL = Envio do convite via SMS e WhatsApp
 Opcional
personalData { } - Dados pessoais da pré-admissão. Estes dados podem ser enviados para a API diretamente a partir do processo de recrutamento do novo colaborador. Opcional
companyName String Nome da empresa. Opcional
branchOfficeName String Nome da filial. Opcional
costCenterName String Nome do centro de custo. Opcional
workstationGroupName String Nome do posto de trabalho. Opcional
tradingName String Nome fantasia da filial. Opcional
jobPositionName String Nome do cargo. Opcional
customFieldsContract { } - Campos customizados do contrato. Opcional
origin String

Origem da admissão.

ClosedValores permitidos:
  • GRS = ATS Gestão de Recrutamento e Seleção
  • EXTERNAL = Externa
  • INTERNAL = Interna
 Opcional

personalData:

Parâmetro Tipo Descrição Preenchimento
personalData { } - Dados de informações pessoais. Opcional
documentData { } - Dados de documentos. Opcional
hasDependent Boolean Identifica se o novo colaborador tem dependentes. Opcional
saveAsDraft Boolean Identifica se a pré-admissão será salva como rascunho. Opcional
hasDisability Boolean Identifica se o novo colaborador é uma pessoa com deficiência. Opcional

preAdmissionPersonalBRADataComplete:

Parâmetro Descrição Preenchimento
basic { } Informações pessoais básicas. Opcional
complementary { } Informações complementares. Opcional
birthPlace { } Informações do local de nascimento. Opcional
address { } Informações de endereço. Opcional
email { } Informações de e-mail. Opcional
telephone { } Informações de telefone de contato. Opcional

documentData:

Parâmetro Descrição Preenchimento
cpf { } Dados do Cadastro de Pessoa Física (CPF). Opcional
pis { } Dados do Programa de Integração Social (PIS). Opcional
ctps { } Dados da Carteira de Trabalho e Previdência Social (CTPS). Opcional
rg { } Dados do Registro Geral (RG). Opcional
passport { } Dados do Passaporte. Opcional
ric { } Dados do Registro de Identidade Civil (RIC). Opcional
voter { } Dados do Título de Eleitor. Opcional
cnh { } Dados da Carteira Nacional de Habilitação (CNH). Opcional
reservist { } Dados do Certificado de Reservista. Opcional
civilCertificate { } Dados da Certidão Civil. Opcional
cns { } Dados do Cartão Nacional de Saúde (CNS). Opcional
dnv { } Dados da Declaração de Nascido Vivo (DNV). Opcional
bankAccount { } Dados bancários. Opcional
receiveSalaryAdvance { } (ver enumInformationItemData) Identifica se o novo colaborador gostaria de receber adiantamento salarial. Opcional
rne { } Dados do Registro Nacional de Estrangeiro (RNE). Opcional

basic:

Parâmetro Tipo Descrição Preenchimento
employeeFullName String Nome completo do novo colaborador. Opcional
preferredName String Nome pelo qual o novo colaborador prefere ser chamado. Opcional
badgeFileId String Endereço onde a imagem do crachá está salva. Opcional
badgeFileVersion String Versão para realizar o commit do arquivo. Opcional
badgeFileIdPermanentUrl String Caminho permanente (URL) do local onde está o arquivo de imagem do crachá. Opcional
gender { } (ver enumInformationItemData) - Gênero do novo colaborador. Opcional
birthDate Date Data de nascimento do novo colaborador. Opcional
mothersName String Nome da mãe do novo colaborador. Opcional
fathersName String Nome do pai do novo colaborador. Opcional
customFields { } - Campos customizados criados no modelo de convite de pré-admissão. Opcional

Importante

Sobre o envio dos campos birthDate (data de nascimento), mothersName (nome da mãe) e fathersName (nome do pai) na requisição da API:

complementary:

Parâmetro Tipo   Descrição Preenchimento
maritalStatus { } (ver enumInformationItemData) - Informações sobre o estado civil. Opcional
degreeOfEducation { } - Informações sobre o grau de instrução. Opcional
degreeOfEducationFileId String Comprovante do grau de instrução. Opcional
degreeOfEducationFileVersion String Versão para realizar o commit do anexo de grau de instrução. Opcional
degreeOfEducationFileIdPermanentUrl String Caminho permanente (URL) do local onde está o arquivo que comprova o grau de instrução. Opcional
nationality { } - Informações sobre a nacionalidade. Opcional
religion { } - Informações sobre a religião. Opcional
race { } (ver enumInformationItemData) - Informações sobre a raça/cor. Opcional
socialName String Nome social do novo colaborador, se houver. Opcional
customFields { } - Campos customizados criados no modelo de convite de pré-admissão. Opcional
ethnicity { } - Informações sobre a etnia Opcional

birthPlace:

Parâmetro Tipo Descrição Preenchimento
country { } - Dados do país de nascimento. Opcional
state { } - Dados do estado de nascimento. Opcional
city { } - Dados da cidade de nascimento. Opcional

address:

Parâmetro Tipo Descrição Preenchimento
country { } - Dados do país do endereço. Opcional
state { } - Dados do estado do endereço. Opcional
city { } - Dados da cidade do endereço. Opcional
cep String CEP do endereço. Opcional
neighborhood String Bairro do endereço. Opcional
addressType { } (ver enumInformationItemData) - Dados do logradouro do endereço. Opcional
address String Endereço. Opcional
number String Número do endereço. Opcional
firstFileId String Primeira imagem. Opcional
firstFileVersion String Versão para realizar o commit do primeiro arquivo. Opcional
firstFilePermanentUrl String URL de acesso a primeira imagem. Opcional
additional String Informações adicionais referente ao endereço. Opcional

email:

Parâmetro Tipo Descrição Preenchimento
firstEmail String E-mail principal do novo colaborador. Opcional
firstType { } (ver enumInformationItemData) - Tipo do e-mail principal. Opcional
secondEmail String E-mail secundário do novo colaborador. Opcional
secondType { } (ver enumInformationItemData) - Tipo do e-mail secundário. Opcional

telephone:

Parâmetro Tipo Descrição Preenchimento
firstPhone String Telefone de contato principal do novo colaborador. Opcional
firstType { } (ver enumInformationItemData) - Tipo do telefone de contato principal. Opcional
secondPhone String Telefone de contato secundário do novo colaborador. Opcional
secondType { } (ver enumInformationItemData) - Tipo do telefone de contato secundário. Opcional

cpf:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (CPF). Opcional

pis:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (PIS). Opcional
issueDate Date Data da emissão do documento. Opcional

ctps:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (CTPS). Opcional
issueDate Date Data da emissão do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
serie String Série do documento. Opcional
digit String Dígito do documento. Opcional

rg:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (RG). Opcional
issueDate Date Data da emissão do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issuer String Orgão emissor do documento. Opcional
fathersName String Nome do pai do novo colaborador. Opcional
mothersName String Nome da mãe do novo colaborador. Opcional
birthDate Date Data de nascimento do novo colaborador. Opcional
doesntHave Boolean Indica se a pessoa possui a carteira de identidade (RG). Opcional

Importante

Sobre o envio dos campos birthDate (data de nascimento), mothersName (nome da mãe) e fathersName (nome do pai) na requisição da API:

passport

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (Passaporte). Opcional
issueDate Date Data da emissão do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issuer String Órgão emissor do documento. Opcional
issuerCountry { } - País de emissão do documento. Opcional
expiryDate Date Data de expiração do documento. Opcional

ric:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (RIC). Opcional
issueDate Date Data da emissão do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issuer String Órgão emissor do documento. Opcional
issuerCity { } - Cidade de emissão do documento. Opcional
expiryDate Date Data de expiração do documento. Opcional

voter:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (Título de Eleitor). Opcional
issueDate Date Data da emissão do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issuerCity { } - Cidade de emissão do documento. Opcional
votingDistrict String Zona de votação. Opcional
votingSection String Sessão de votação. Opcional

cnh:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (CNH). Opcional
category { } (ver enumInformationItemData) - Categoria do documento. Opcional
issuer String Órgão emissor do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issueDate Date Data da emissão do documento. Opcional
expiryDate Date Data de expiração do documento. Opcional
firstDriveLicenceDate Date Data da primeira CNH. Opcional

reservist:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (Certificado de Reservista). Opcional
serie String Série do documento. Opcional
ra String Número do Registro de Alistamento (RA). Opcional
exemptionDate Date Data de dispensa. Opcional
doesntHave Boolean Identifica se a pessoa possui o Certificado de Reservista. Opcional

civilCertificate:

Parâmetro Tipo Descrição Preenchimento
type { } (ver enumInformationItemData) - Tipo do documento (Certidão Civil). Opcional
issueDate Date Data da emissão do documento. Opcional
registry Date Matrícula do documento. Opcional
term String Termo do documento. Opcional
book String Livro do documento. Opcional
sheet String Folha do documento. Opcional
notaryOffice String Cartório do documento. Opcional
issuerState { } - Estado de emissão do documento. Opcional
issuerCity { } - Cidade de emissão do documento. Opcional

cns:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (Cartão Nacional de Saúde). Opcional

dnv:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (Declaração de Nascido Vivo). Opcional

bankAccount:

Parâmetro Tipo Descrição Preenchimento
bank { } - Banco. Opcional
branch Integer Número da agência bancária. Opcional
accountType { } (ver enumInformationItemData) - Tipo da conta. Opcional
bankAccount String Número da conta bancária. Opcional
digit String Digito da conta bancária. Opcional

rne:

Parâmetro Tipo Descrição Preenchimento
number String Número do documento (RNE). Opcional
arrivalDate DateTime Data e hora de chegada no país. Opcional
residenceTime { } (ver enumInformationItemData) - Tempo de permanência no país. Opcional
residencyEndDate Date Data de Término da Residência Opcional
conditionVisaType { } (ver enumInformationItemData) - Tipo de visto. Opcional
issuer String Orgão emissor do documento. Opcional
issueDate Date Data da emissão do documento. Opcional
expiryDate Date Data de validade do documento. Opcional
ordinanceNumber String Número da Portaria. Opcional
marriedWithBrazilian { } (ver enumInformationItemData) - Identifica se o novo colaborador é casado com uma pessoa brasileira. Opcional
brazilianChildren { } (ver enumInformationItemData) - Identifica se o novo colaborador tem filhos brasileiros. Opcional
fathersName String Nome do pai do novo colaborador. Opcional
mothersName String Nome da mãe do novo colaborador. Opcional
birthDate Date Data de nascimento do novo colaborador. Opcional
doesntHave Boolean Indica se a pessoa possui o Registro Nacional de Estrangeiro (RNE), indicando que ela é uma estrangeira no Brasil. Opcional
customFields { } - Campos customizados criados no modelo de convite de pré-admissão. Opcional

Importante

Sobre o envio dos campos birthDate (data de nascimento), mothersName (nome da mãe) e fathersName (nome do pai) na requisição da API:

degreeOfEducation:

Parâmetro Tipo Descrição Preenchimento
code Integer Código do grau de instrução. Opcional
name String Nome do grau de instrução. Opcional
type String

Tipo do grau de instrução.

ClosedValores permitidos:
  • ILLITERATE = 01 - Analfabeto, inclusive o que, embora tenha recebido instrução, não se alfabetizou
  • ELEMENTARY_SCHOOL_INCOMPLETE = 02 - Ensino Fundamental Incompleto
  • ELEMENTARY_SCHOOL_COMPLETE = 03 - 5º ano completo do Ensino Fundamental
  • MIDDLE_SCHOOL_INCOMPLETE = 04 - Do 6º ao 9º ano do Ensino Fundamental incompleto (antiga 5ª a 8ª série)
  • MIDDLE_SCHOOL_COMPLETED = 05 - Ensino Fundamental Completo
  • HIGH_SCHOOL_INCOMPLETE = 06 - Ensino Médio incompleto
  • HIGH_SCHOOL_COMPLETED = 07 - Ensino Médio completo
  • HIGHER_INCOMPLETE = 08 - Educação Superior incompleta
  • HIGHER_COMPLETED = 09 - Educação Superior completa
  • POST_GRADUATED = 10 - Pós-Graduação completa
  • MASTER = 11 - Mestrado completo
  • DOCTORAL = 12 - Doutorado completo
 Opcional

nationality:

Parâmetro Tipo Descrição Preenchimento
code Integer Código da nacionalidade. Opcional
name * String Nome da nacionalidade. Obrigatório
type String

Tipo da nacionalidade.

ClosedValores permitidos:
  • BRAZILIAN = Brasileiro
  • OTHER = Outro
 Opcional

religion:

Parâmetro Tipo Descrição Preenchimento
code Integer Código da religião. Opcional
name String Nome da religião. Opcional

country e issuerCountry:

Parâmetro Tipo Descrição Preenchimento
name String Nome do país. Opcional
abbreviation String Abreviação do nome do país. Opcional

state e issuerState:

Parâmetro Tipo Descrição Preenchimento
name String Nome do estado. Opcional
abbreviation String Abreviação do nome do estado. Opcional
country String País onde o estado está localizado. Opcional

city e issuerCity:

Parâmetro Tipo Descrição Preenchimento
name String Nome da cidade. Opcional
state String Estado onde a cidade está localizada. Opcional

bank:

Parâmetro Tipo Descrição Preenchimento
name String Nome do banco. Opcional
code Integer Código do banco. Opcional

customFields:

Parâmetro Tipo Descrição Preenchimento
field String Identificador do campo customizado criado na XPlatform. Opcional
value - Recebe o valor preenchido no campo. O tipo do campo value será o mesmo tipo que foi definido durante a criação do campo customizado na XPlatform. Opcional

ethnicity:

Parâmetro Tipo Descrição Preenchimento
code Integer Código da etnia Opcional
name * String Nome da etnia Obrigatório

enumInformationItemData:

Parâmetro Tipo Descrição Preenchimento
key String Chave do item da enumeração. Opcional
value String

Valor do item da enumeração.

Estes são os valores permitidos para cada campo que utiliza a enumeração:

ClosedreceiveSalaryAdvance
  • YES = Sim
  • NO = Não
Closedgender
  • MALE = Masculino
  • FEMALE = Feminino
ClosedmaritalStatus
  • SINGLE = Solteiro
  • MARRIED = Casado
  • DIVORCED = Divorciado
  • WIDOWER = Viúvo
  • CONCUBINAGE = Concubinato
  • SEPARATED = Separado
  • STABLEUNION = União estável
  • OTHERS = Outros
Closedrace
  • WHITE = Branca
  • BLACK = Preta
  • BROWN = Parda
  • YELLOW = Amarela
  • INDIGENOUS = Indígena
  • NOT_INFORMED = Não informado
ClosedaddressType
  • OTHERS = 0 - Outros
  • AIRPORT = 1 - Aeroporto
  • LANE = 2 - Alameda
  • AREA = 3 - Area
  • AVENUE = 4 - Avenida
  • BALNEARY = 5 - Balneário
  • BLOCK = 6 - Bloco
  • FIELD = 7 - Campo
  • FARMSTEAD = 8 - Chácara
  • COLOGNE = 9 - Colônia
  • CONDOMINIUM = 10 - Condomínio
  • SET = 11 - Conjunto
  • DISTRICT = 12 - Distrito
  • TERRACE = 13 - Esplanada
  • SEASON = 14 - Estação
  • ROAD = 15 - Estrada
  • SHANTYTOWN = 16 - Favela
  • FARM = 17 - Fazenda
  • MARKET = 18 - Feira
  • GALLERY = 19 - Galeria
  • GRANJA = 20 - Granja
  • GARDEN = 21 - Jardim
  • SLOPE = 22 - Ladeira
  • LAKE = 23 - Lago
  • LAGOON = 24 - Lagoa
  • LONG = 25 - Largo
  • ALLOTMENT = 26 - Loteamento
  • HILL = 27 - Morro
  • CORE = 28 - Núcleo
  • PARK = 29 - Parque
  • FOOTBRIDGE = 30 - Passarela
  • COURTYARD = 31 - Pátio
  • SQUARE = 32 - Praça
  • BEACH = 33 - Praia
  • COURT = 34 - Quadra
  • NOOK = 35 - Recanto
  • RESIDENTIAL = 36 - Residencial
  • HIGHWAY = 37 - Rodovia
  • STREET = 38 - Rua
  • SECTOR = 39 - Setor
  • SITE = 40 - Sítio
  • BYSTREET = 41 - Travessa
  • EXCERPT = 42 - Trecho
  • CLOVER = 43 - Trevo
  • VALLEY = 44 - Vale
  • PATH = 45 - Vereda
  • VIA = 46 - Via
  • VIADUCT = 47 - Viaduto
  • ALLEY = 48 - Viela
  • VILLAGE = 49 - Vila
  • ACCESS = 50 - Acesso
  • CAMP = 51 - Acampamento
  • LOCAL_ACCESS = 52 - Acesso Local
  • CHURCHYARD = 53 - Adro
  • SPECIAL_AREA = 54 - Área Especial
  • RIGHT_MARGINAL_AVENUE = 55 - Avenida Marginal Direita
  • LEFT_MARGINAL_AVENUE = 56 - Avenida Marginal Esquerda
  • RING_ROAD = 57 - Anel Viário
  • LATER_ROAD_BETWEEN = 58 - Antiga Estrada
  • ARTERY = 59 - Artéria
  • HIGH = 60 - Alto
  • SHORTCUT = 61 - Atalho
  • GREEN_AREA = 62 - Área Verde
  • CONTOUR_AVENUE = 63 - Avenida Contorno
  • MARGINAL_AVENUE = 64 - Avenida Marginal
  • OLD_AVENUE = 65 - Avenida Velha
  • ALLEYWAY = 66 - Beco
  • HOLE = 67 - Buraco
  • BELVEDERE = 68 - Belvedere
  • BALLOON = 69 - Balão
  • BLOCKS = 70 - Blocos
  • BULEVAR = 71 - Bulevar
  • FOREST = 72 - Bosque
  • BOULEVARD = 73 - Boulevard
  • LOW = 74 - Baixa
  • PIER = 75 - Cais
  • SIDEWALK = 76 - Calçada
  • WAY = 77 - Caminho
  • CHANNEL = 78 - Canal
  • CHAPADAO = 79 - Chapadão
  • BICYCLE_PATH = 80 - Ciclovia
  • CIRCULAR_ROAD = 81 - Circular
  • HOUSING_COMPLEX = 82 - Conjunto Mutirão
  • ROAD_COMPLEX = 83 - Complexo Viário
  • COMMUNITY = 84 - Comunidade
  • HALL = 85 - Corredor
  • STREAM = 86 - Córrego
  • CONTOUR = 87 - Contorno
  • DESCENT = 88 - Descida
  • DETOUR = 89 - Desvio
  • BETWEEN_BLOCK = 90 - Entre Bloco
  • INTERMUNICIPAL_ROAD = 91 - Estrada Intermunicipal
  • COVE = 92 - Enseada
  • PRIVATE_ENTRANCE = 93 - Entrada Particular
  • BETWEEN_QUARTER = 94 - Entre Quadra
  • LADDER = 95 - Escada
  • STAIRCASE = 96 - Escadaria
  • STATE_HIGHWAY = 97 - Estrada Estadual
  • VICINAL_ROAD = 98 - Estrada Vicinal
  • ROAD_CONNECTION = 99 - Estrada de Ligação
  • MUNICIPAL_ROAD = 100 - Estrada Municipal
  • ROAD_TO_SERFDOM = 101 - Estrada de Servidão
  • OLD_ROAD = 102 - Estrada Velha
  • LATER_ROAD = 103 - Estrada Antiga
  • STADIUM = 104 - Estádio
  • OFFICE = 105 - Estância
  • PRIVATE_ROAD = 106 - Estrada Particular
  • PARKING = 107 - Estacionamento
  • EVANGELICAL = 108 - Evangélica
  • LOFTY = 109 - Elevada
  • INDUSTRIAL_AXIS = 110 - Eixo Industrial
  • RAILROAD = 111 - Ferrovia
  • SOURCE = 112 - Fonte
  • STRONG = 113 - Forte
  • HOUSING_NUCLEUS = 114 - Núcleo Habitacional
  • ISLAND = 115 - Ilha
  • UNDETERMINED = 116 - Indeterminado
  • ISLET = 117 - Ilhota
  • WINDOW = 118 - Jardinete
  • LOT = 119 - Lote
  • MARKETPLACE = 120 - Mercado
  • MARINA = 121 - Marina
  • MODULE = 122 - Módulo
  • PROJECTION = 123 - Projeção
  • MOUNT = 124 - Monte
  • RURAL_NUCLEUS = 125 - Núcleo Rural
  • KNOLL = 126 - Outeiro
  • PARALLEL = 127 - Paralela
  • TOUR = 128 - Passeio
  • SPORTS_SQUARE = 129 - Praça de Esportes
  • STOP = 130 - Parada
  • REST_AREA = 131 - Paradouro
  • TIP = 132 - Ponta
  • PROLONGING = 133 - Prolongamento
  • CITY_PARK = 134 - Parque Municipal
  • RESIDENTIAL_PARK = 135 - Parque Residencial
  • PASSAGE = 136 - Passagem
  • PEDESTRIAN_WALKWAY = 137 - Passagem de Pedestre
  • UNDERGROUND_PASSAGE = 138 - Passagem Subterrânea
  • BRIDGE = 139 - Ponte
  • PORT = 140 - Porto
  • FIFTH = 141 - Quinta
  • FARMS = 142 - Quintas
  • INTEGRATION_STREET = 143 - Rua Integração
  • LINK_STREET = 144 - Rua de Ligação
  • PRIVATE_STREET = 145 - Rua Particular
  • OLD_STREET = 146 - Rua Velha
  • BRANCH = 147 - Ramal
  • PLAYGROUND = 148 - Recreio
  • RETREAT = 149 - Retiro
  • STRAIGHT = 150 - Reta
  • SIDE_STREET = 151 - Ruela
  • RAMP = 152 - Rampa
  • RODO_RING = 153 - Rodo Anel
  • KNEECAP = 154 - Rótula
  • PEDESTRIAN_STREET = 155 - Rua de Pedestre
  • MARGIN = 156 - Margem
  • RETURN = 157 - Retorno
  • ROUNDABOUT = 158 - Rotatória
  • SECOND_AVENUE = 159 - Segunda Avenida
  • BONDAGE = 160 - Servidão
  • UPLOADING = 161 - Subida
  • TRENCH = 162 - Trincheira
  • TERMINAL = 163 - Terminal
  • TUNNEL = 164 - Túnel
  • PRIVATE_BYSTREET = 165 - Travessa Particular
  • OLD_BYSTREET = 166 - Travessa Velha
  • UNITY = 167 - Unidade
  • COLLECTOR_ROAD = 168 - Via Coletora
  • LOCAL_WAY = 169 - Via Local
  • ACCESS_WAY = 170 - Via de Acesso
  • DITCH = 171 - Vala
  • COASTAL_WAY = 172 - Via Costeira
  • EXPRESSWAY = 173 - Via Expressa
  • HIGHROAD = 174 - Via Elevado
  • COASTAL_ROAD = 175 - Via Litorânea
  • WALKWAY = 176 - Via de Pedestre
  • VARIANT = 177 - Variante
  • ZIGZAG = 178 - Zigue-Zague
ClosedfirstType e secondType (email)
  • PERSONAL_EMAIL = E-mail pessoal
  • PROFESSIONAL_EMAIL = E-mail profissional/corporativo
ClosedfirstType e secondType (telephone)
  • PERSONAL_TELEPHONE = Pessoal/Residencial
  • COMMERCIAL_TELEPHONE = Comercial/Profissional
  • CELLPHONE = Celular
  • PERSONAL_FAX = Fax pessoal/residencial
  • COMMERCIAL_FAX = Fax comercial/profissional
  • OTHER_TELEPHONE_TYPE = Outro tipo de telefone para contato
Closedcategory
  • A = Condutor de veículo motorizado de duas ou três rodas, com ou sem carro lateral (motos).
  • B = Condutor de veículo motorizado não abrangido pela categoria A, com peso bruto total inferior a 3.500 quilos e lotação máxima de oito lugares, além do motorista (automóveis).
  • C = Condutor de veículo motorizado usado para transporte de carga, com peso bruto superior a 3.500 quilos (como caminhões).
  • D = Condutor de veículo motorizado usado no transporte de passageiros, com lotação superior a oito lugares além do motorista (ônibus e vans, por exemplo).
  • E = Condutor de combinação de veículos em que a unidade conduzida se enquadre nas categorias B, C ou D e cuja unidade acoplada ou rebocada tenha peso bruto de 6 mil quilos ou mais; ou cuja lotação seja superior a oito lugares; ou, ainda, que seja enquadrado na categoria trailer.
  • E = Condutor de veículo motorizado de duas ou três rodas, com ou sem carro lateral (motos).
  • AB = Condutor de veículo motorizado usado para transporte de carga, com peso bruto superior a 3.500 quilos (como caminhões).
  • E = Condutor de veículo motorizado de duas ou três rodas, com ou sem carro lateral (motos).
  • AC = Condutor de veículo motorizado usado no transporte de passageiros, com lotação superior a oito lugares além do motorista (ônibus e vans, por exemplo).
  • E = Condutor de veículo motorizado de duas ou três rodas, com ou sem carro lateral (motos).
  • AD = Condutor de combinação de veículos em que a unidade conduzida se enquadre nas categorias B, C ou D e cuja unidade acoplada ou rebocada tenha peso bruto de 6 mil quilos ou mais; ou cuja lotação seja superior a oito lugares; ou, ainda, que seja enquadrado na categoria trailer.
  • E = Condutor de veículo motorizado de duas ou três rodas, com ou sem carro lateral (motos).
  • AE = Condutor de combinação de veículos em que a unidade conduzida se enquadre nas categorias B, C ou D e cuja unidade acoplada ou rebocada tenha peso bruto de 6 mil quilos ou mais; ou cuja lotação seja superior a oito lugares; ou, ainda, que seja enquadrado na categoria trailer.
Closedtype
  • BIRTH_CERTIFICATE = Certidão de nascimento
  • MARRIAGE_CERTIFICATE = Certidão de casamento
  • INDIGENOUS_PERSONS_BIRTH_CERTIFICATE = Certidão Ad. de nascimento indígena
  • DEATH_CERTIFICATE = Certidão de óbito
ClosedaccountType
  • CURRENT_ACCOUNT = Conta Corrente
  • SAVINGS_ACCOUNT = Conta Poupança
  • SALARY_ACCOUNT = Conta Salário
  • OTHER = Outros
ClosedresidenceTime
  • DETERMINED = Prazo determinado
  • UNDETERMINED = Prazo indeterminado
ClosedConditionVisaType
  • PERMANENT = Visto permanente
  • TEMPORARY = Visto temporário
  • ASYLUM = Visto de asilado
  • REFUGEE = Visto de refugiado
  • REFUGEE_APPLICANT = Solicitante de refúgio
  • BORDER_COUNTRY_TO_BRAZIL = Residente de país fronteiriço ao Brasil
  • DISABILITY = Pessoa com deficiência (PcD) e com mais de 51 anos
  • PROVISIONAL_RESIDENCE_AND_AMNESTY = Com residência provisória e anistiado, em situação irregular
  • PERMANENCE_IN_BRAZIL_DUE_TO_CHILDREN_OR_SPOUSE = Permanência no Brasil em razão de reunião familiar
  • BENEFITED_BY_MERCOSUR = Beneficiado pelo acordo entre países do Mercosul
  • DEPENDENT_ON_DIPLOMATIC_AGENT = Dependente de agente diplomático e/ou consular de países que mantém convênio de reciprocidade para o execício de atividade remunerada no Brasil
  • BENEFITED_BY_THE_TREATY_OF_FRIENDSHIP = Beneficiado pelo Tratado de Amizade, Cooperação e Consulta entre a República Federativa do Brasil e a República Portuguesa
  • OTHER_CONDITION = Outra condição
ClosedmarriedWithBrazilian
  • YES = Sim
  • NO = Não
ClosedbrazilianChildren
  • YES = Sim
  • NO = Não
 Opcional

customFieldsContract:

Parâmetro Tipo Descrição Preenchimento
field String Identificador do campo customizado criado na XPlatform. Opcional
value - Recebe o valor preenchido no campo. O tipo do campo value será o mesmo tipo que foi definido durante a criação do campo customizado na XPlatform. Opcional

Exemplo

{
  "employeeName": "string",
  "employeeEmail": "string",
  "employeeMobilePhone": "string",
  "key": "string",
  "admissionDate": "2022-01-28",
  "modelId": "string",
  "additionalInfo": "string",
  "jobPosition": "string",
  "branchOffice": "string",
  "company": "string",
  "employeeMobilePhoneOption": "SMS",
  "personalData": {
    "personalData": {
      "basic": {
        "id": "string",
        "employeeFullName": "string",
        "preferredName": "string",
        "badgeFileId": "string",
        "badgeFileVersion": "string",
        "badgeFileIdPermanentUrl": "string",
        "gender": {
          "key": "string",
          "value": "string"
        },
        "birthDate": "2022-01-28",
        "mothersName": "string",
        "fathersName": "string",
        "customFields": [
           {
            "field": "campo customizado 1",
            "value": "valor preenchido no campo"
           }
        ]
      },
      "complementary": {
        "id": "string",
        "maritalStatus": {
          "key": "string",
          "value": "string"
        },
        "degreeOfEducation": {
          "id": "string",
          "code": 0,
          "name": "string",
          "type": "ILLITERATE"
        },
        "degreeOfEducationFileId": "string",
        "degreeOfEducationFileVersion": "string",
        "degreeOfEducationFileIdPermanentUrl": "string",
        "nationality": {
          "id": "string",
          "code": 0,
          "name": "string",
          "type": "BRAZILIAN"
        },
        "religion": {
          "id": "string",
          "code": 0,
          "name": "string"
        },
        "race": {
          "key": "string",
          "value": "string"
        },
	 "ethnicity": {
	    "id": "string",
	    "code": 0,
	    "name": "string"
	 },
        "socialName": "string",
        "customFields": [
           {
            "field": "campo customizado 2",
            "value": "valor preenchido no campo"
           }
        ]
      },
      "birthPlace": {
        "id": "string",
        "country": {
          "id": "string",
          "name": "string",
          "abbreviation": "string"
        },
        "state": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "city": {
          "id": "string",
          "name": "string",
          "state": "string"
        }
      },
      "address": {
        "id": "string",
        "country": {
          "id": "string",
          "name": "string",
          "abbreviation": "string"
        },
        "state": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "city": {
          "id": "string",
          "name": "string",
          "state": "string"
        },
        "cep": "string",
        "neighborhood": "string",
        "addressType": {
          "key": "string",
          "value": "string"
        },
        "address": "string",
        "number": "string",
        "firstFileId": "string",
        "firstFileVersion": "string",
        "firstFilePermanentUrl": "string",
        "additional": "string"
      },
      "email": {
        "id": "string",
        "firstEmail": "string",
        "firstType": {
          "key": "string",
          "value": "string"
        },
        "secondEmail": "string",
        "secondType": {
          "key": "string",
          "value": "string"
        }
      },
      "telephone": {
        "id": "string",
        "firstPhone": "string",
        "firstType": {
          "key": "string",
          "value": "string"
        },
        "secondPhone": "string",
        "secondType": {
          "key": "string",
          "value": "string"
        }
      }
    },
    "documentData": {
      "cpf": {
        "id": "string",
        "number": "string"
      },
      "pis": {
        "id": "string",
        "number": "string",
        "issueDate": "2022-01-28"
      },
      "ctps": {
        "id": "string",
        "number": "string",
        "serie": "string",
        "digit": "string",
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "issueDate": "2022-01-28"
      },
      "rg": {
        "id": "string",
        "number": "string",
        "issuer": "string",
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "issueDate": "2022-01-28",
        "doesntHave": "false"
      },
      "passport": {
        "id": "string",
        "number": "string",
        "issuer": "string",
        "issueDate": "2022-01-28",
        "expiryDate": "2022-01-28",
        "issuerCountry": {
          "id": "string",
          "name": "string",
          "abbreviation": "string"
        },
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        }
      },
      "ric": {
        "id": "string",
        "number": "string",
        "issuer": "string",
        "issuerCity": {
          "id": "string",
          "name": "string",
          "state": "string"
        },
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "issueDate": "2022-01-28",
        "expiryDate": "2022-01-28"
      },
      "voter": {
        "id": "string",
        "number": "string",
        "votingDistrict": "string",
        "votingSection": "string",
        "issuerCity": {
          "id": "string",
          "name": "string",
          "state": "string"
        },
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "issueDate": "2022-01-28"
      },
      "cnh": {
        "id": "string",
        "number": "string",
        "category": {
          "key": "string",
          "value": "string"
        },
        "issuer": "string",
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        },
        "issueDate": "2022-01-28",
        "expiryDate": "2022-01-28",
        "firstDriverLicenceDate": "2022-01-28"
      },
      "reservist": {
        "id": "string",
        "number": "string",
        "serie": "string",
        "ra": "string",
        "exemptionDate": "2022-01-28",
        "doesntHave": false
      },
      "civilCertificate": {
        "id": "string",
        "type": {
          "key": "string",
          "value": "string"
        },
        "issueDate": "2022-01-28",
        "registry": "string",
        "term": "string",
        "book": "string",
        "sheet": "string",
        "notaryOffice": "string",
        "issuerCity": {
          "id": "string",
          "name": "string",
          "state": "string"
        },
        "issuerState": {
          "id": "string",
          "name": "string",
          "abbreviation": "string",
          "country": "string"
        }
      },
      "cns": {
        "id": "string",
        "number": "string"
      },
      "dnv": {
        "id": "string",
        "number": "string"
      },
      "bankAccount": {
        "id": "string",
        "bank": {
          "id": "string",
          "code": 0,
          "name": "string"
        },
        "branch": 0,
        "accountType": {
          "key": "string",
          "value": "string"
        },
        "bankAccount": "string",
        "digit": "string"
      },
      "receiveSalaryAdvance": {
        "key": "string",
        "value": "string"
      },
    "hasDependent": true,
    "saveAsDraft": true,
    "hasDisability": true
  },
  "companyName": "string",
  "branchOfficeName": "string",
  "tradingName": "string",
  "jobPositionName": "string",
  "customFieldsContract": [
    {
      "field": "usu_custom",
      "value": "Valor 1"
    },
    {
      "field": "usu_custom1",
      "value": "Valor 2"
    },
    {
      "field": "usu_custom2",
      "value": "Valor 3"
    }
  ]
}

Respostas

Código Descrição Campos da resposta
200 Ok - resultado do envio do convite
Campo Tipo Descrição
ok Boolean Indicativo se o envio foi bem sucedido ou não.
message String Mensagem de retorno da primitiva.
idPreAdmission String Identificador da pré-admissão.
linkWhatsApp String  
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.
ClosedExemplo da resposta (200): 
{
  "result": {
    "ok": true,
    "message": "string",
    "idPreAdmission": "string",
    "linkWhatsApp": "string"
  }
}
ClosedExemplo 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).