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

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.

¿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/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

País
employeeName *

String

Nome completo do novo colaborador.

Obrigatório

Brasil/Colômbia

employeeEmail

String

E-mail do novo colaborador.

Opcional

Brasil/Colômbia

employeeMobilePhone

String

Número de telefone celular do novo colaborador.

Opcional

Brasil/Colômbia

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.

—

Brasil/Colômbia
admissionDate *

Date

Data de admissão do novo colaborador.

Obrigatório

Brasil/Colômbia
modelId *

String

Identificador único do modelo de convite associado a pré-admissão.

Obrigatório

Brasil/Colômbia

additionalInfo

String

Informação adicional que pode ser enviada no modelo de convite.

Opcional

Brasil/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.

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

Brasil/Colômbia

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.

—

Brasil/Colômbia

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.

—

Brasil/Colômbia

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.

—

Brasil/Colômbia

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.

—

Brasil/Colômbia

company

String

Identificador único da empresa.

Opcional

Brasil/Colômbia

employeeMobilePhoneOption

String

Forma de recebimento de convite pelo novo colaborador.

Valores permitidos:
  • SMS = Envio do convite via SMS
  • WHATSAPP = Envio do convite via WhatsApp
  • ALL = Envio do convite via SMS e WhatsApp

Opcional

Brasil/Colômbia

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

Brasil/Colômbia

companyName

String

Nome da empresa.

Opcional

Brasil/Colômbia

branchOfficeName

String

Nome da filial.

Opcional

Brasil/Colômbia

costCenterName

String

Nome do centro de custo.

Opcional

Brasil/Colômbia

workstationGroupName

String

Nome do posto de trabalho.

Opcional

Brasil/Colômbia

tradingName

String

Nome fantasia da filial.

Opcional

Brasil/Colômbia

jobPositionName

String

Nome do cargo.

Opcional

Brasil/Colômbia

customFieldsContract { }

—

Campos customizados do contrato.

Opcional

Brasil/Colômbia

origin

String

Origem da admissão.

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

Opcional

Brasil/Colômbia

salaryType

String

Tipo do salário.

Valores permitidos:
  • MONTHLY = Mensalista
  • HOURLY = Horista
  • DAILY = Diarista
  • DYNAMIC = Salário variável (Comissionado)
  • TAKERS = Tarefeiro
  • THIRD_PARTY = Terceiro
  • FORTNIGHTLY = Quinzenal

Opcional

Brasil/Colômbia

salary

Double

Salário.

Opcional

Brasil/Colômbia

workshift

String

Identificador único da escala.

Opcional

Brasil/Colômbia

workshiftDescription

String

Descrição da escala.

Opcional

Brasil/Colômbia

personalData:

Parâmetro

Tipo

Descrição

Preenchimento

País

personalData { }

Dados de informações pessoais.

Opcional

Brasil

personalDataCOL{ }

Dados de informações pessoais Col

Opcional

Colômbia

documentData { }

Dados de documentos.

Opcional

Brasil

documentDataCOL { }

Dados de documentos Col

Opcional

Colômbia

hasDependent

Boolean

Identifica se o novo colaborador tem dependentes.

Opcional

Brasil/Colômbia

saveAsDraft

Boolean

Identifica se a pré-admissão será salva como rascunho.

Opcional

Brasil/Colômbia

hasDisability

Boolean

Identifica se o novo colaborador é uma pessoa com deficiência.

Opcional

Brasil/Colômbia

preAdmissionPersonalBRADataComplete:

Parâmetro

Descrição

Preenchimento

País

basic { }

Informações pessoais básicas.

Opcional

Brasil

complementary { }

Informações complementares.

Opcional

Brasil

birthPlace { }

Informações do local de nascimento.

Opcional

address { }

Informações de endereço.

Opcional

Brasil

email { }

Informações de e-mail.

Opcional

telephone { }

Informações de telefone de contato.

Opcional

basic:

Parâmetro

Tipo

Descrição

Preenchimento

País

employeeFullName

String

Nome completo do novo colaborador.

Opcional

Brasil

preferredName

String

Nome pelo qual o novo colaborador prefere ser chamado.

Opcional

Brasil

badgeFileId

String

Endereço onde a imagem do crachá está salva.

Opcional

Brasil

badgeFileVersion

String

Versão para realizar o commit do arquivo.

Opcional

Brasil

badgeFileIdPermanentUrl

String

Caminho permanente (URL) do local onde está o arquivo de imagem do crachá.

Opcional

Brasil

gender { } (ver enumInformationItemData)

Gênero do novo colaborador.

Opcional

Brasil

birthDate

Date

Data de nascimento do novo colaborador.

Opcional

Brasil

mothersName

String

Nome da mãe do novo colaborador.

Opcional

Brasil

fathersName

String

Nome do pai do novo colaborador.

Opcional

Brasil

customFields { }

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

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:

  • Para novos colaboradores brasileiros, você pode enviar esses campos no grupo **basic** ou **rg** — as informações são sincronizadas automaticamente entre os dois.
  • Para novos colaboradores estrangeiros, você deve enviar esses campos no grupo **rne**. As informações não são sincronizadas com o **basic** e nem com o **rg**.

complementary:

Parâmetro

Tipo

  Descrição

Preenchimento

País

maritalStatus { } (ver enumInformationItemData)

Informações sobre o estado civil.

Opcional

Brasil

degreeOfEducation { }

Informações sobre o grau de instrução.

Opcional

degreeOfEducationFileId

String

Comprovante do grau de instrução.

Opcional

Brasil

degreeOfEducationFileVersion

String

Versão para realizar o commit do anexo de grau de instrução.

Opcional

Brasil

degreeOfEducationFileIdPermanentUrl

String

Caminho permanente (URL) do local onde está o arquivo que comprova o grau de instrução.

Opcional

Brasil

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

Brasil

socialName

String

Nome social do novo colaborador, se houver.

Opcional

Brasil

customFields { }

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

ethnicity { }

Informações sobre a etnia

Opcional

address:

Parâmetro

Tipo

Descrição

Preenchimento

País

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

Brasil

neighborhood

String

Bairro do endereço.

Importante

Se o valor do campo Bairro (neighborhood) ultrapassar 40 caracteres, o envio da admissão não será realizado.

Opcional

Brasil

addressType { } (ver enumInformationItemData)

Dados do logradouro do endereço.

Opcional

Brasil

address

String

Endereço.

Opcional

Brasil

number

String

Número do endereço.

Opcional

Brasil

firstFileId

String

Primeira imagem.

Opcional

Brasil

firstFileVersion

String

Versão para realizar o commit do primeiro arquivo.

Opcional

Brasil

firstFilePermanentUrl

String

URL de acesso a primeira imagem.

Opcional

Brasil

additional

String

Informações adicionais referente ao endereço.

Opcional

Brasil

documentData:

Parâmetro

Descrição

Preenchimento

País

cpf { }

Dados do Cadastro de Pessoa Física (CPF).

Opcional

Brasil

pis { }

Dados do Programa de Integração Social (PIS).

Opcional

Brasil

ctps { }

Dados da Carteira de Trabalho e Previdência Social (CTPS).

Opcional

Brasil

rg { }

Dados do Registro Geral (RG).

Opcional

Brasil

passport { }

Dados do Passaporte.

Opcional

ric { }

Dados do Registro de Identidade Civil (RIC).

Opcional

Brasil

voter { }

Dados do Título de Eleitor.

Opcional

Brasil

cnh { }

Dados da Carteira Nacional de Habilitação (CNH).

Opcional

Brasil

reservist { }

Dados do Certificado de Reservista.

Opcional

Brasil

civilCertificate { }

Dados da Certidão Civil.

Opcional

Brasil

cns { }

Dados do Cartão Nacional de Saúde (CNS).

Opcional

Brasil

dnv { }

Dados da Declaração de Nascido Vivo (DNV).

Opcional

Brasil

bankAccount { }

Dados bancários.

Opcional

receiveSalaryAdvance { } (ver enumInformationItemData)

Identifica se o novo colaborador gostaria de receber adiantamento salarial.

Opcional

Brasil

rne { }

Dados do Registro Nacional de Estrangeiro (RNE).

Opcional

Brasil

hiringMedicalExamDataComplete{}

Dados do exame admissional

Opcional

Brasil

professionalRecordDataComplete{}

Dados do registro profissional

Opcional

Brasil

cpf:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (CPF).

Opcional

Brasil

pis:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (PIS).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

ctps:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (CTPS).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

serie

String

Série do documento.

Opcional

Brasil

digit

String

Dígito do documento.

Opcional

Brasil

rg:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (RG).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

issuer

String

Orgão emissor do documento.

Opcional

Brasil

fathersName

String

Nome do pai do novo colaborador.

Opcional

Brasil

mothersName

String

Nome da mãe do novo colaborador.

Opcional

Brasil

birthDate

Date

Data de nascimento do novo colaborador.

Opcional

Brasil

doesntHave

Boolean

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

Opcional

Brasil

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:

  • Para novos colaboradores brasileiros, você pode enviar esses campos no grupo **basic** ou **rg** — as informações são sincronizadas automaticamente entre os dois.
  • Para novos colaboradores estrangeiros, você deve enviar esses campos no grupo **rne**. As informações não são sincronizadas com o **basic** e nem com o **rg**.

ric:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (RIC).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

issuer

String

Órgão emissor do documento.

Opcional

Brasil

issuerCity { }

Cidade de emissão do documento.

Opcional

Brasil

expiryDate

Date

Data de expiração do documento.

Opcional

Brasil

voter:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (Título de Eleitor).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

issuerCity { }

Cidade de emissão do documento.

Opcional

Brasil

votingDistrict

String

Zona de votação.

Opcional

Brasil

votingSection

String

Sessão de votação.

Opcional

Brasil

cnh:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (CNH).

Opcional

Brasil

category { } (ver enumInformationItemData)

Categoria do documento.

Opcional

Brasil

issuer

String

Órgão emissor do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

expiryDate

Date

Data de expiração do documento.

Opcional

Brasil

firstDriveLicenceDate

Date

Data da primeira CNH.

Opcional

Brasil

reservist:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (Certificado de Reservista).

Opcional

Brasil

serie

String

Série do documento.

Opcional

Brasil

ra

String

Número do Registro de Alistamento (RA).

Opcional

Brasil

exemptionDate

Date

Data de dispensa.

Opcional

Brasil

doesntHave

Boolean

Identifica se a pessoa possui o Certificado de Reservista.

Opcional

Brasil

civilCertificate:

Parâmetro

Tipo

Descrição

Preenchimento

País

type { } (ver enumInformationItemData)

Tipo do documento (Certidão Civil).

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

registry

Date

Matrícula do documento.

Opcional

Brasil

term

String

Termo do documento.

Opcional

Brasil

book

String

Livro do documento.

Opcional

Brasil

sheet

String

Folha do documento.

Opcional

Brasil

notaryOffice

String

Cartório do documento.

Opcional

Brasil

issuerState { }

Estado de emissão do documento.

Opcional

Brasil

issuerCity { }

Cidade de emissão do documento.

Opcional

Brasil

cns:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (Cartão Nacional de Saúde).

Opcional

Brasil

dnv:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (Declaração de Nascido Vivo).

Opcional

Brasil

rne:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (RNE).

Opcional

Brasil

arrivalDate

DateTime

Data e hora de chegada no país.

Opcional

Brasil

residenceTime { } (ver enumInformationItemData)

Tempo de permanência no país.

Opcional

Brasil

residencyEndDate

Date

Data de Término da Residência

Opcional

Brasil

conditionVisaType { } (ver enumInformationItemData)

Tipo de visto.

Opcional

Brasil

issuer

String

Orgão emissor do documento.

Opcional

Brasil

issueDate

Date

Data da emissão do documento.

Opcional

Brasil

expiryDate

Date

Data de validade do documento.

Opcional

Brasil

ordinanceNumber

String

Número da Portaria.

Opcional

Brasil

marriedWithBrazilian { } (ver enumInformationItemData)

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

Opcional

Brasil

brazilianChildren { } (ver enumInformationItemData)

Identifica se o novo colaborador tem filhos brasileiros.

Opcional

Brasil

fathersName

String

Nome do pai do novo colaborador.

Opcional

Brasil

mothersName

String

Nome da mãe do novo colaborador.

Opcional

Brasil

birthDate

Date

Data de nascimento do novo colaborador.

Opcional

Brasil

doesntHave

Boolean

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

Opcional

Brasil

customFields { }

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

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:

  • Para novos colaboradores brasileiros, você pode enviar esses campos no grupo **basic** ou **rg** — as informações são sincronizadas automaticamente entre os dois.
  • Para novos colaboradores estrangeiros, você deve enviar esses campos no grupo **rne**. As informações não são sincronizadas com o **basic** e nem com o **rg**.

hiringMedicalExamDataComplete:

Parâmetro

Tipo

Descrição

Preenchimento

País

examDate

Date

Data de realização do exame

Opcional

Brasil

doesntHave

Boolean

Indicativo se a pessoa não possui exame admissional

Opcional

Brasil

professionalRecordDataComplete:

Parâmetro

Tipo

Descrição

Preenchimento

País

professionalAdvice{}

Conselho profissional

Opcional

Brasil

number

Long

Número do registro no conselhor profissional

Opcional

Brasil

isTemporary

Boolean

Indica se o registro é temporário

Opcional

Brasil

mteNumber

Long

Número do registro no ministério do trabalho (MTE)

Opcional

Brasil

shippingDate

Date

Data de expedição

Opcional

Brasil

dueDate

Date

Data de vencimento

Opcional

Brasil

doesntHave

Boolean

Indicativo se o candidato não possui conselho profissional

Opcional

Brasil

professionalAdvice:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do conselho profissional

Obrigatório

Brasil

abbreviation

String

Sigla do conselho profissional

Opcional

Brasil

code

String

Código externo

Opcional

Brasil

personalDataCOL:

Parâmetro

Descrição

Preenchimento

País

basic { }

Dados básicos

Opcional

Colômbia

complementary { }

Dados complementares

Opcional

Colômbia

emergencyContact { }

Contato de emergência

Opcional

Colômbia

birthPlace { }

Local de nascimento

Opcional

address { }

Endereço

Opcional

Colômbia

telephone { }

Telefone

Opcional

email { }

E-mail

Opcional

basic:

Parâmetro

Tipo

Descrição

Preenchimento

País

firstName

String

Primeiro nome do novo colaborador

Opcional

Colômbia

middleName

String

Nome do meio do novo colaborador

Opcional

Colômbia

firstSurname

String

Primeiro sobrenome do novo colaborador

Opcional

Colômbia

secondSurname

String

Segundo sobrenome do novo colaborador

Opcional

Colômbia

preferredName

String

Nome pelo qual o novo colaborador prefere ser chamado

Opcional

Colômbia

badgeFileId

String

Endereço onde a imagem do crachá está salva

Opcional

Colômbia

badgeUploadDate

DateTime

Data do upload da imagem do crachá

Opcional

Colômbia

badgeFileVersion

String

Versão para realizar o commit do arquivo

Opcional

Colômbia

badgeFilePermanentUrl

String

Caminho permanente do arquivo da imagem do crachá

Opcional

Colômbia

gender { } (ver enumInformationItemData)

Gênero do novo colaborador

Opcional

Colômbia

birthDate

Data de nascimento do novo colaborador

Opcional

Colômbia

customFields { }

Campos customizados

complementary:

Parâmetro

Tipo

Descrição

Preenchimento

País

maritalStatus { } (ver enumInformationItemData)

Estado civil

Opcional

Colômbia

degreeOfEducation { }

Grau de instrução

Opcional

nationality { }

Nacionalidade

Opcional

religion { }

Religião

Opcional

ethnicity { }

Etnia

Opcional

socialName

String

Nome socia

Opcional

Colômbia

bloodType { } (ver enumInformationItemData)

Tipo sanguineo

Opcional

Colômbia

bloodFactor { } (ver enumInformationItemData)

Fator do sangue

Opcional

Colômbia

height

String

Altura

Opcional

Colômbia

weight

String

Peso

Opcional

Colômbia

customFields { }

Campos customizados

emergencyContact:

Parâmetro

Tipo

Descrição

Preenchimento

País

firstContactName

String

Nome do primeiro contato

Opcional

Colômbia

firstContactKinship { } (ver enumInformationItemData)

Parentesco do primeiro contato

Opcional

Colômbia

firstContactPhone

String

Telefone do primeiro contato

Opcional

Colômbia

secondContactName

String

Nome do segundo contato

Opcional

Colômbia

secondContactKinship { } (ver enumInformationItemData)

Parentesco do segundo contato

Opcional

Colômbia

secondContactPhone

String

Telefone do segundo contato

Opcional

Colômbia

customFields { }

Campos customizados

address:

Parâmetro

Tipo

Descrição

Preenchimento

País

country { }

País de nascimento

Opcional

state { }

Estado de nascimento

Opcional

city { }

Cidade de nascimento

Opcional

cep

String

CEP do endereço

Opcional

Colômbia

neighborhood

String

Bairro

Opcional

Colômbia

addressType { } (ver enumInformationItemData)

Logradouro

Opcional

Colômbia

address

String

Endereço

Opcional

Colômbia

number

String

Número do endereço

Opcional

Colômbia

additional

String

Informação adicional referente ao endereço

Opcional

Colômbia

customFields { }

Campos customizados

documentDataCOL:

Parâmetro

Tipo

Descrição

Preenchimento

País

identityDocument { }

Documento de identificação

Opcional

Colômbia

professionalRecord { }

Registro profissional

Opcional

Colômbia

militaryServiceBook { }

Carteira de reservista

Opcional

Colômbia

driverLicense { }

Licença de condução

Opcional

Colômbia

epsAffiliation { }

Afiliação EPS

Opcional

Colômbia

afpAffiliation { }

Afiliação AFP

Opcional

Colômbia

severanceAffiliation { }

Afiliação de indenização

Opcional

Colômbia

bankAccount { }

Conta bancária

Opcional

workCertificate { }

Certificados de trabalho

Opcional

Colômbia

studyCertificate { }

Certificados de estudo

Opcional

Colômbia

documentReference { }

Referências

Opcional

Colômbia

backgroundInformation { }

Informações de fundo

Opcional

Colômbia

passport { }

Passaporte

Opcional

identityDocument

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento

Opcional

Colômbia

documentType { }

Tipo do documento

Opcional

Colômbia

issueDate

Date

Data de emissão

Opcional

Colômbia

issuerCountry { }

País de emissão

Opcional

issuerState { }

Estado de emissão

Opcional

issuerCity { }

Cidade de emissão

Opcional

doesntHave

Boolean

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

Opcional

Colômbia

customFields { }

Campos customizados

documentType:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código do documento

Opcional

Colômbia

name

String

Nome do documento

Opcional

Colômbia

professionalRecord:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento

Opcional

Colômbia

issueDate

Date

Data de emissão

Opcional

Colômbia

doesntHave

Boolean

Se a pessoa não possui registro profissional

Opcional

Colômbia

customFields { }

Campos customizados

militaryServiceBook:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento

Opcional

Colômbia

issueDate

Date

Data de emissão

Opcional

Colômbia

militaryServiceBookClass { } (ver enumInformationItemData)

Relacionamento da militaryServiceBookClassCOL

Opcional

Colômbia

district

String

Distrito do documento

Opcional

Colômbia

customFields { }

Campos customizados

doesntHave

Boolean

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

Opcional

Colômbia

driverLicense:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento

Opcional

Colômbia

category { } (ver enumInformationItemData)

Categoria do documento

Opcional

Colômbia

issueDate

Date

Data de emissão

Opcional

Colômbia

expiryDate

Date

Data de validade

Opcional

Colômbia

issuer

String

Emissor do documento

Opcional

Colômbia

restrictions

String

Restrições do documento

Opcional

Colômbia

customFields { }

Campos customizados

doesntHave

Boolean

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

Opcional

Colômbia

eps:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código do documento

Opcional

Colômbia

name

String

Nome da EPS

Opcional

Colômbia

type { } (ver enumSocialSecurityTypeCOL)

Tipo EPS

Opcional

Colômbia

epsAffiliation:

Parâmetro

Tipo

Descrição

Preenchimento

País

name { }

Nome da EPS

Opcional

Colômbia

customFields { }

Campos customizados

doesntHave

Boolean

Se a pessoa não possui EPS

Opcional

Colômbia

afpAffiliation:

Parâmetro

Tipo

Descrição

Preenchimento

País

name { }

Nome da AFP

Opcional

Colômbia

customFields { }

Campos customizados

doesntHave

Boolean

Se a pessoa não possui AFP

Opcional

Colômbia

severanceAffiliation:

Parâmetro

Tipo

Descrição

Preenchimento

País

name { }

Nome da afiliação de indenização

Opcional

Colômbia

customFields { }

Campos customizados

doesntHave

Boolean

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

Opcional

Colômbia

workCertificate:

Parâmetro

Tipo

Descrição

Preenchimento

País

workCertificateItem { }

Itens de certificados do candidato

Opcional

Colômbia

hasWorkCertificate

Boolean

Informa se o candidato tem certificado de trabalho

Opcional

Colômbia

doesntHave

Boolean

Campo não possui

Opcional

Colômbia

workCertificateItem:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do item do certificado de trabalho

Opcional

Colômbia

studyCertificate:

Parâmetro

Tipo

Descrição

Preenchimento

País

studyCertificateItem { }

Itens de certificados do candidato

Opcional

Colômbia

hasStudyCertificate

Boolean

Informa se o candidato tem certificado de estudo

Opcional

Colômbia

doesntHave

Boolean

Campo não possui

Opcional

Colômbia

studyCertificateItem:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do item do certificado de estudo

Opcional

Colômbia

documentReference:

Parâmetro

Tipo

Descrição

Preenchimento

País

documentReferenceItem { }

Itens de certificados do candidato

Opcional

Colômbia

hasDocumentReference

Boolean

Informa se o candidato tem certificado de trabalho

Opcional

Colômbia

doesntHave

Boolean

Campo não possui

Opcional

Colômbia

documentReferenceItem:

Parâmetro

Tipo

Descrição

Preenchimento

País

reference { } (ver enumInformationItemData

Nome do item do documento de referência

Opcional

Colômbia

backgroundInformation:

Parâmetro

Tipo

Descrição

Preenchimento

País

customFields { }

Campos customizados

doesntHave

Boolean

Se a pessoa não possui dados de documento de fundo

Opcional

Colômbia

birthPlace:

Parâmetro

Tipo

Descrição

Preenchimento

País

country { }

Dados do país de nascimento.

Opcional

Brasil/Colômbia

state { }

Dados do estado de nascimento.

Opcional

Brasil/Colômbia

city { }

Dados da cidade de nascimento.

Opcional

Brasil/Colômbia

email:

Parâmetro

Tipo

Descrição

Preenchimento

País

firstEmail

String

E-mail principal do novo colaborador.

Opcional

Brasil/Colômbia

firstType { } (ver enumInformationItemData)

Tipo do e-mail principal.

Opcional

Brasil/Colômbia

secondEmail

String

E-mail secundário do novo colaborador.

Opcional

Brasil/Colômbia

secondType { } (ver enumInformationItemData)

Tipo do e-mail secundário.

Opcional

Brasil/Colômbia

telephone:

Parâmetro

Tipo

Descrição

Preenchimento

País

firstPhone

String

Telefone de contato principal do novo colaborador.

Opcional

Brasil/Colômbia

firstType { } (ver enumInformationItemData)

Tipo do telefone de contato principal.

Opcional

Brasil/Colômbia

secondPhone

String

Telefone de contato secundário do novo colaborador.

Opcional

Brasil/Colômbia

secondType { } (ver enumInformationItemData)

Tipo do telefone de contato secundário.

Opcional

Brasil/Colômbia

passport:

Parâmetro

Tipo

Descrição

Preenchimento

País

number

String

Número do documento (Passaporte).

Opcional

Brasil/Colômbia

issueDate

Date

Data da emissão do documento.

Opcional

Brasil/Colômbia

issuerState { }

Estado de emissão do documento.

Opcional

Brasil/Colômbia

issuer

String

Órgão emissor do documento.

Opcional

Brasil/Colômbia

issuerCountry { }

País de emissão do documento.

Opcional

Brasil/Colômbia

expiryDate

Date

Data de expiração do documento.

Opcional

Brasil/Colômbia

bankAccount:

Parâmetro

Tipo

Descrição

Preenchimento

País

bank { }

Banco.

Opcional

Brasil/Colômbia

branch

Integer

Número da agência bancária.

Opcional

Brasil/Colômbia

accountType { } (ver enumInformationItemData)

Tipo da conta.

Opcional

Brasil/Colômbia

bankAccount

String

Número da conta bancária.

Opcional

Brasil/Colômbia

digit

String

Digito da conta bancária.

Opcional

Brasil/Colômbia

degreeOfEducation:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código do grau de instrução.

Opcional

Brasil/Colômbia

name

String

Nome do grau de instrução.

Opcional

Brasil/Colômbia

type

String

Tipo do grau de instrução.

Valores 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

Brasil/Colômbia

nationality:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código da nacionalidade.

Opcional

Brasil/Colômbia
name *

String

Nome da nacionalidade.

Obrigatório

Brasil/Colômbia

type

String

Tipo da nacionalidade.

Valores permitidos:
  • BRAZILIAN = Brasileiro
  • OTHER = Outro

Opcional

Brasil/Colômbia

religion:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código da religião.

Opcional

Brasil/Colômbia

name

String

Nome da religião.

Opcional

Brasil/Colômbia

country e issuerCountry:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do país.

Opcional

Brasil/Colômbia

abbreviation

String

Abreviação do nome do país.

Opcional

Brasil/Colômbia

state e issuerState:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do estado.

Opcional

Brasil/Colômbia

abbreviation

String

Abreviação do nome do estado.

Opcional

Brasil/Colômbia

country

String

País onde o estado está localizado.

Opcional

Brasil/Colômbia

city e issuerCity:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome da cidade.

Opcional

Brasil/Colômbia

state

String

Estado onde a cidade está localizada.

Opcional

Brasil/Colômbia

bank:

Parâmetro

Tipo

Descrição

Preenchimento

País

name

String

Nome do banco.

Opcional

Brasil/Colômbia

code

Integer

Código do banco.

Opcional

Brasil/Colômbia

customFields:

Parâmetro

Tipo

Descrição

Preenchimento

País

field

String

Identificador do campo customizado criado na Senior X.

Opcional

Brasil/Colômbia

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 Senior X.

Opcional

Brasil/Colômbia

customFieldsContract:

Parâmetro

Tipo

Descrição

Preenchimento

País

field

String

Identificador do campo customizado criado na Senior X.

Opcional

Brasil/Colômbia

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 Senior X.

Opcional

Brasil/Colômbia

ethnicity:

Parâmetro

Tipo

Descrição

Preenchimento

País

code

Integer

Código da etnia

Opcional

Brasil/Colômbia
name *

String

Nome da etnia

Obrigatório

Brasil/Colômbia

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:

receiveSalaryAdvance
  • YES = Sim
  • NO = Não
gender
  • MALE = Masculino
  • FEMALE = Feminino
maritalStatus
  • SINGLE = Solteiro
  • MARRIED = Casado
  • DIVORCED = Divorciado
  • WIDOWER = Viúvo
  • CONCUBINAGE = Concubinato
  • SEPARATED = Separado
  • STABLEUNION = União estável
  • OTHERS = Outros
race
  • WHITE = Branca
  • BLACK = Preta
  • BROWN = Parda
  • YELLOW = Amarela
  • INDIGENOUS = Indígena
  • NOT_INFORMED = Não informado
addressType (Brasil)
  • 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
addressType (Colômbia)
  • AC = Avenida calle
  • AD = Administración
  • ADL = Adelante
  • AER = Aeropuerto
  • AG = Agencia
  • AGP = Agrupación
  • AK = Avenida carrera
  • AL = Altillo
  • ALD = Al lado
  • ALM = Almacén
  • AP = Apartamento
  • APTDO = Apartado
  • ATR = Atrás
  • AUT = Autopista
  • AV = Avenida
  • AVIAL = Anillo vial
  • BG = Bodega
  • BL = Bloque
  • BLV = Boulevard
  • BRR = Barrio
  • C = Corregimiento
  • CA = Casa
  • CAS = Caserío
  • CC = Centro comercial
  • CD = Ciudadela
  • CEL = Célula
  • CEN = Centro
  • CIR = Circular
  • CL = Calle
  • CLJ = Callejón
  • CN = Camino
  • CON = Conjunto residencial
  • CONJ = Conjunto
  • CR = Carrera
  • CRT = Carretera
  • CRV = Circunvalar
  • CS = Consultorio
  • DG = Diagonal
  • DP = Depósito
  • DPTO = Departamento
  • DS = Depósito sótano
  • ED = Edificio
  • EN = Entrada
  • ES = Escalera
  • ESQ = Esquina
  • ESTE = Este
  • ET = Etapa
  • EX = Exterior
  • FCA = Finca
  • GJ = Garaje
  • GS = Garaje sótano
  • GT = Glorieta
  • HC = Hacienda
  • HG = Hangar
  • IN = Interior
  • IP = Inspección de Policía
  • IPD = Inspección Departamental
  • IPM = Inspección Municipal
  • KM = Kilómetro
  • LC = Local
  • LM = Local mezzanine
  • LT = Lote
  • MD = Módulo
  • MJ = Mojón
  • MLL = Muelle
  • MN = Mezzanine
  • MZ = Manzana
  • NOMBRE_VIA = Vías de nombre común
  • NORTE = Norte
  • O = Oriente
  • OCC = Occidente
  • OESTE = Oeste
  • OF = Oficina
  • P = Piso
  • PA = Parcela
  • PAR = Parque
  • PD = Predio
  • PH = Penthouse
  • PJ = Pasaje
  • PL = Planta
  • PN = Puente
  • POR = Portería
  • POS = Poste
  • PQ = Parqueadero
  • PRJ = Paraje
  • PS = Paseo
  • PT = Puesto
  • PW = Park Way
  • RP = Round Point
  • SA = Salón
  • SC = Salón comunal
  • SD = Salida
  • SEC = Sector
  • SL = Solar
  • SM = Súper manzana
  • SS = Semisótano
  • ST = Sótano
  • SUITE = Suite
  • SUR = Sur
  • TER = Terminal
  • TERPLN = Terraplén
  • TO = Torre
  • TV = Transversal
  • TZ = Terraza
  • UN = Unidad
  • UR = Unidad residencial
  • URB = Urbanización
  • VRD = Vereda
  • VTE = Variante
  • ZF = Zona franca
  • ZN = Zona
firstType e secondType (email)
  • PERSONAL_EMAIL = E-mail pessoal
  • PROFESSIONAL_EMAIL = E-mail profissional/corporativo
bloodType
  • A = A - Tipo A
  • B = B - Tipo B
  • AB = AB - Tipo AB
  • O = O - Tipo O
bloodFactor
  • POSITIVE = Positivo - Tipo positivo
  • NEGATIVE = Negativo - Tipo negativo
militaryServiceBookClass
  • FIRST_CLASS = Primeira Classe - Tipo primeira classe
  • SECOND_CLASS = Segunda Classe - Tipo segunda classe
reference
  • PERSONAL = Pessoal
  • WORK = Trabalho
  • FAMILY = Família
  • FINANCIAL = Financeiro
  • ACADEMIC = Acadêmico
firstContactKinship e secondContactKinship (emergency contact)
  • ADOPTED = AdotadoCHILD = Filho legítimo
  • CONCUBINE = Concubina
  • EX_SPOUSE = Ex-cônjuge
  • EX_PARTNER = Ex-partner
  • GRANDPARENT = Avô/Avó
  • GRANDCHILD = Neto
  • GREAT_GRANDPARENT = Bisavô/Bisavó
  • GREAT_GRANDCHILD = Bisneto(a)
  • GUARDIANSHIP = Tutela/Guarda
  • NEPHEW_NIECE = Sobrinho
  • OTHER = Outro
  • PARENT = Pai/Mãe
  • FATHER_IN_LAW = Sogro
  • PARTNER = Parceiro(a)
  • PENSIONERS = Pensionista
  • PUPIL = Tutelado
  • SIBLING = Irmão
  • SON_DAUGHTER_IN_LAW = Genro/Nora
  • SPOUSE = Cônjuge
  • STEPFATHER = Padrasto
  • STEPMOTHER = Madrasta
  • STEPCHILD = Enteado
  • TRUSTED = Confiado/Tutor
  • UNCLE_AUNT = Tio/Tia
  • TUTOR = Tutor
firstType 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
category (Brasil)
  • 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.
category (Colômbia)
  • A1 = Motocicletas hasta de 125 c.c. de cilindrada
  • A2 = Motocicletas, motociclos y mototriciclos de más de 125 c.c. de cilindrada
  • B1 = Automóviles, camperos, camionetas y microbuses de servicio particular
  • B2 = Camiones, rígidos, busetas y buses para el servicio particular
  • B3 = Vehículos articulados de servicio particular
  • C1 = Automóviles, camperos, camionetas y microbuses de servicio público
  • C2 = Camiones, rígidos, busetas y buses para el servicio público
  • C3 = Vehículos articulados para el servicio público
type
  • 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
accountType
  • CURRENT_ACCOUNT = Conta Corrente
  • SAVINGS_ACCOUNT = Conta Poupança
  • SALARY_ACCOUNT = Conta Salário
  • OTHER = Outros
residenceTime
  • DETERMINED = Prazo determinado
  • UNDETERMINED = Prazo indeterminado
ConditionVisaType
  • 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
marriedWithBrazilian
  • YES = Sim
  • NO = Não
brazilianChildren
  • YES = Sim
  • NO = Não

Opcional

enumSocialSecurityTypeCOL:

Parâmetro

Tipo

Descrição

Preenchimento

key

String

Chave do item da enumeração.

Opcional

type

String

Valor do item da enumeração.

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

type
  • AFP = Administradora de Fondos de Pensiones
  • EPS = Entidades Promotoras de Salud
  • ARL = Administradora de Riesgos Laborales
  • CCF = Cajas de Compensación Familiar
  • CESANTIAS = Fondo de Cesantías

Opcional

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).