Enviar invitaciones de preadmisión — APIs de Admissão Digital

Envía una invitación para iniciar el proceso de preadmisión de un nuevo colaborador. Durante el proceso de envío, la API valida la información de la solicitud y devuelve si la invitación fue enviada con éxito o no.

Definiciones de la API:


URL

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

Sustituye<url_plataforma>*por la URL correspondiente a tu entorno. Si es el entorno de producción, sustitúyela por:*https://platform.senior.com.br

Encabezado (Header)

Authorization

Bearer​ <access_token>

Content-Type

application/json

Sustituye<access_token>por la clave de acceso obtenida a partir de la API de autenticación de la plataforma.

Parámetros

* Obligatorios

Parámetro

Tipo

Descripción

Requerido

País

employeeName *

String

Nombre completo del nuevo colaborador.

Obligatorio

Brasil/Colombia

employeeEmail

String

Correo electrónico del nuevo colaborador.

Opcional

Brasil/Colombia

employeeMobilePhone

String

Número de teléfono móvil del nuevo colaborador.

Opcional

Brasil/Colombia

key

String

Clave de preadmisión. Para invitaciones en Brasil, la clave de identificación es el CPF del nuevo colaborador.

Este parámetro es obligatorio solo si la empresa lo definió como obligatorio en el envío del modelo de invitación. De lo contrario, permanece opcional.

Brasil/Colombia

admissionDate *

Date

Fecha de admisión del nuevo colaborador.

Obligatorio

Brasil/Colombia

modelId *

String

Identificador único del modelo de invitación asociado a la preadmisión.

Obligatorio

Brasil/Colombia

additionalInfo

String

Información adicional que puede enviarse en el modelo de invitación.

Opcional

Brasil/Colombia

vacancyCode

Long

Número de la vacante generada por el módulo ATS Gestão de Recrutamento e Seleção del HCM senior X. Este parámetro es utilizado por GRS para enviar la información de la vacante y del candidato a las preadmisiones en el sistema de Admissão Digital.

El parámetro vacancyCode es opcional y se utiliza exclusivamente por GRS. Si no tienes la integración de Admissão Digital con este sistema, este parámetro no debe utilizarse.

Cuando este código exista, puedes obtenerlo realizando una solicitud al endpoint preAdmissionQuery.

Opcional

Brasil/Colombia

jobPosition

String

Identificador único del cargo.

Este parámetro es obligatorio solo si la empresa lo definió como obligatorio en el envío del modelo de invitación. De lo contrario, permanece opcional.

Brasil/Colombia

branchOffice

String

Identificador único de la sucursal.

Este parámetro es obligatorio solo si la empresa lo definió como obligatorio en el envío del modelo de invitación. De lo contrario, permanece opcional.

Brasil/Colombia

costCenterld

String

Identificador único del centro de costos.

Este parámetro es obligatorio solo si la empresa lo definió como obligatorio en el envío del modelo de invitación. De lo contrario, permanece opcional.

Brasil/Colombia

workstationld

String

Identificador único del puesto de trabajo.

Este parámetro es obligatorio solo si la empresa lo definió como obligatorio en el envío del modelo de invitación. De lo contrario, permanece opcional.

Brasil/Colombia

company

String

Identificador único de la empresa.

Opcional

Brasil/Colombia

employeeMobilePhoneOption

String

Forma de recepción de la invitación por el nuevo colaborador.

Valores permitidos:
  • SMS = Envío de la invitación por SMS
  • WHATSAPP = Envío de la invitación por WhatsApp
  • ALL = Envío de la invitación por SMS y WhatsApp

Opcional

Brasil/Colombia

personalData { }

Datos personales de la preadmisión. Estos datos pueden enviarse a la API directamente desde el proceso de reclutamiento del nuevo colaborador.

Opcional

Brasil/Colombia

companyName

String

Nombre de la empresa.

Opcional

Brasil/Colombia

branchOfficeName

String

Nombre de la sucursal.

Opcional

Brasil/Colombia

costCenterName

String

Nombre del centro de costos.

Opcional

Brasil/Colombia

workstationGroupName

String

Nombre del puesto de trabajo.

Opcional

Brasil/Colombia

tradingName

String

Nombre comercial de la sucursal.

Opcional

Brasil/Colombia

jobPositionName

String

Nombre del cargo.

Opcional

Brasil/Colombia

customFieldsContract { }

Campos personalizados del contrato.

Opcional

Brasil/Colombia

origin

String

Origen de la admisión.

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

Opcional

Brasil/Colombia

salaryType

String

Tipo de salario.

Valores permitidos:
  • MONTHLY = Mensual
  • HOURLY = Por horas
  • DAILY = Diario
  • DYNAMIC = Salario variable (Comisionado)
  • TAKERS = Por tareas
  • THIRD_PARTY = Tercero
  • FORTNIGHTLY = Quincenal

Opcional

Brasil/Colombia

salary

Double

Salario.

Opcional

Brasil/Colombia

workshift

String

Identificador único del turno.

Opcional

Brasil/Colombia

workshiftDescription

String

Descripción del turno.

Opcional

Brasil/Colombia

personalData:

Parámetro

Tipo

Descripción

Requerido

País

personalData { }

Datos de información personal.

Opcional

Brasil

personalDataCOL{ }

Datos de información personal Col

Opcional

Colombia

documentData { }

Datos de documentos.

Opcional

Brasil

documentDataCOL { }

Datos de documentos Col

Opcional

Colombia

hasDependent

Boolean

Identifica si el nuevo colaborador tiene dependientes.

Opcional

Brasil/Colombia

saveAsDraft

Boolean

Identifica si la preadmisión se guardará como borrador.

Opcional

Brasil/Colombia

hasDisability

Boolean

Identifica si el nuevo colaborador es una persona con discapacidad.

Opcional

Brasil/Colombia

preAdmissionPersonalBRADataComplete:

Parámetro

Descripción

Requerido

País

basic { }

Información personal básica.

Opcional

Brasil

complementary { }

Información complementaria.

Opcional

Brasil

birthPlace { }

Información del lugar de nacimiento.

Opcional

address { }

Información de dirección.

Opcional

Brasil

email { }

Información de correo electrónico.

Opcional

telephone { }

Información del teléfono de contacto.

Opcional

basic:

Parámetro

Tipo

Descripción

Requerido

País

employeeFullName

String

Nombre completo del nuevo colaborador.

Opcional

Brasil

preferredName

String

Nombre por el cual el nuevo colaborador prefiere ser llamado.

Opcional

Brasil

badgeFileId

String

Dirección donde se guarda la imagen de la credencial.

Opcional

Brasil

badgeFileVersion

String

Versión para realizar el commit del archivo.

Opcional

Brasil

badgeFileIdPermanentUrl

String

Ruta permanente (URL) del lugar donde se encuentra el archivo de imagen de la credencial.

Opcional

Brasil

gender { } (ver enumInformationItemData)

Género del nuevo colaborador.

Opcional

Brasil

birthDate

Date

Fecha de nacimiento del nuevo colaborador.

Opcional

Brasil

mothersName

String

Nombre de la madre del nuevo colaborador.

Opcional

Brasil

fathersName

String

Nombre del padre del nuevo colaborador.

Opcional

Brasil

customFields { }

Campos personalizados creados en el modelo de invitación de preadmisión.

Importante

Sobre el envío de los campos birthDate (fecha de nacimiento), mothersName (nombre de la madre) y fathersName (nombre del padre) en la solicitud de la API:

  • Para nuevos colaboradores brasileños, puedes enviar estos campos en el grupo **basic** o **rg** — la información se sincroniza automáticamente entre ambos.
  • Para nuevos colaboradores extranjeros, debes enviar estos campos en el grupo **rne**. La información no se sincroniza con **basic** ni con **rg**.

complementary:

Parámetro

Tipo

Descripción

Requerido

País

maritalStatus { } (ver enumInformationItemData)

Información sobre el estado civil.

Opcional

Brasil

degreeOfEducation { }

Información sobre el nivel de educación.

Opcional

degreeOfEducationFileId

String

Comprobante del nivel de educación.

Opcional

Brasil

degreeOfEducationFileVersion

String

Versión para realizar el commit del anexo de nivel de educación.

Opcional

Brasil

degreeOfEducationFileIdPermanentUrl

String

Ruta permanente (URL) del lugar donde se encuentra el archivo que comprueba el nivel de educación.

Opcional

Brasil

nationality { }

Información sobre la nacionalidad.

Opcional

religion { }

Información sobre la religión.

Opcional

race { } (ver enumInformationItemData)

Información sobre la raza/color.

Opcional

Brasil

socialName

String

Nombre social del nuevo colaborador, si lo hay.

Opcional

Brasil

customFields { }

Campos personalizados creados en el modelo de invitación de preadmisión.

ethnicity { }

Información sobre la etnia

Opcional

address:

Parámetro

Tipo

Descripción

Requerido

País

country { }

Datos del país de la dirección.

Opcional

state { }

Datos del estado de la dirección.

Opcional

city { }

Datos de la ciudad de la dirección.

Opcional

cep

String

Código postal (CEP) de la dirección.

Opcional

Brasil

neighborhood

String

Barrio de la dirección.

Importante

Si el valor del campo Barrio (neighborhood) supera los 40 caracteres, el envío de la admisión no se realizará.

Opcional

Brasil

addressType { } (ver enumInformationItemData)

Datos del tipo de vía de la dirección.

Opcional

Brasil

address

String

Dirección.

Opcional

Brasil

number

String

Número de la dirección.

Opcional

Brasil

firstFileId

String

Primera imagen.

Opcional

Brasil

firstFileVersion

String

Versión para realizar el commit del primer archivo.

Opcional

Brasil

firstFilePermanentUrl

String

URL de acceso a la primera imagen.

Opcional

Brasil

additional

String

Información adicional referente a la dirección.

Opcional

Brasil

documentData:

Parámetro

Descripción

Requerido

País

cpf { }

Datos del Cadastro de Pessoa Física (CPF).

Opcional

Brasil

pis { }

Datos del Programa de Integração Social (PIS).

Opcional

Brasil

ctps { }

Datos de la Carteira de Trabalho e Previdência Social (CTPS).

Opcional

Brasil

rg { }

Datos del Registro Geral (RG).

Opcional

Brasil

passport { }

Datos del pasaporte.

Opcional

ric { }

Datos del Registro de Identidade Civil (RIC).

Opcional

Brasil

voter { }

Datos del Título de Eleitor.

Opcional

Brasil

cnh { }

Datos de la Carteira Nacional de Habilitação (CNH).

Opcional

Brasil

reservist { }

Datos del Certificado de Reservista.

Opcional

Brasil

civilCertificate { }

Datos de la Certidão Civil.

Opcional

Brasil

cns { }

Datos del Cartão Nacional de Saúde (CNS).

Opcional

Brasil

dnv { }

Datos de la Declaração de Nascido Vivo (DNV).

Opcional

Brasil

bankAccount { }

Datos bancarios.

Opcional

receiveSalaryAdvance { } (ver enumInformationItemData)

Identifica si el nuevo colaborador desea recibir adelanto salarial.

Opcional

Brasil

rne { }

Datos del Registro Nacional de Estrangeiro (RNE).

Opcional

Brasil

hiringMedicalExamDataComplete{}

Datos del examen de admisión

Opcional

Brasil

professionalRecordDataComplete{}

Datos del registro profesional

Opcional

Brasil

cpf:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (CPF).

Opcional

Brasil

pis:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (PIS).

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

ctps:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (CTPS).

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

serie

String

Serie del documento.

Opcional

Brasil

digit

String

Dígito del documento.

Opcional

Brasil

rg:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (RG).

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

issuer

String

Órgano emisor del documento.

Opcional

Brasil

fathersName

String

Nombre del padre del nuevo colaborador.

Opcional

Brasil

mothersName

String

Nombre de la madre del nuevo colaborador.

Opcional

Brasil

birthDate

Date

Fecha de nacimiento del nuevo colaborador.

Opcional

Brasil

doesntHave

Boolean

Indica si la persona posee la cédula de identidad (RG).

Opcional

Brasil

Importante

Sobre el envío de los campos birthDate (fecha de nacimiento), mothersName (nombre de la madre) y fathersName (nombre del padre) en la solicitud de la API:

  • Para nuevos colaboradores brasileños, puedes enviar estos campos en el grupo **basic** o **rg** — la información se sincroniza automáticamente entre ambos.
  • Para nuevos colaboradores extranjeros, debes enviar estos campos en el grupo **rne**. La información no se sincroniza con **basic** ni con **rg**.

ric:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (RIC).

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

issuer

String

Órgano emisor del documento.

Opcional

Brasil

issuerCity { }

Ciudad de emisión del documento.

Opcional

Brasil

expiryDate

Date

Fecha de vencimiento del documento.

Opcional

Brasil

voter:

Parámetro

Tipo

Descripción

Requerido

País

number

String

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

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

issuerCity { }

Ciudad de emisión del documento.

Opcional

Brasil

votingDistrict

String

Zona de votación.

Opcional

Brasil

votingSection

String

Sección de votación.

Opcional

Brasil

cnh:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (CNH).

Opcional

Brasil

category { } (ver enumInformationItemData)

Categoría del documento.

Opcional

Brasil

issuer

String

Órgano emisor del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

expiryDate

Date

Fecha de vencimiento del documento.

Opcional

Brasil

firstDriveLicenceDate

Date

Fecha de la primera CNH.

Opcional

Brasil

reservist:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (Certificado de Reservista).

Opcional

Brasil

serie

String

Serie del documento.

Opcional

Brasil

ra

String

Número del Registro de Alistamiento (RA).

Opcional

Brasil

exemptionDate

Date

Fecha de dispensa.

Opcional

Brasil

doesntHave

Boolean

Identifica si la persona posee el Certificado de Reservista.

Opcional

Brasil

civilCertificate:

Parámetro

Tipo

Descripción

Requerido

País

type { } (ver enumInformationItemData)

Tipo del documento (Certidão Civil).

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

registry

Date

Matrícula del documento.

Opcional

Brasil

term

String

Término del documento.

Opcional

Brasil

book

String

Libro del documento.

Opcional

Brasil

sheet

String

Hoja del documento.

Opcional

Brasil

notaryOffice

String

Notaría del documento.

Opcional

Brasil

issuerState { }

Estado de emisión del documento.

Opcional

Brasil

issuerCity { }

Ciudad de emisión del documento.

Opcional

Brasil

cns:

Parámetro

Tipo

Descripción

Requerido

País

number

String

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

Opcional

Brasil

dnv:

Parámetro

Tipo

Descripción

Requerido

País

number

String

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

Opcional

Brasil

rne:

Parámetro

Tipo

Descripción

Requerido

País

number

String

Número del documento (RNE).

Opcional

Brasil

arrivalDate

DateTime

Fecha y hora de llegada al país.

Opcional

Brasil

residenceTime { } (ver enumInformationItemData)

Tiempo de permanencia en el país.

Opcional

Brasil

residencyEndDate

Date

Fecha de finalización de la residencia

Opcional

Brasil

conditionVisaType { } (ver enumInformationItemData)

Tipo de visado.

Opcional

Brasil

issuer

String

Órgano emisor del documento.

Opcional

Brasil

issueDate

Date

Fecha de emisión del documento.

Opcional

Brasil

expiryDate

Date

Fecha de validez del documento.

Opcional

Brasil

ordinanceNumber

String

Número de la ordenanza.

Opcional

Brasil

marriedWithBrazilian { } (ver enumInformationItemData)

Identifica si el nuevo colaborador está casado con una persona brasileña.

Opcional

Brasil

brazilianChildren { } (ver enumInformationItemData)

Identifica si el nuevo colaborador tiene hijos brasileños.

Opcional

Brasil

fathersName

String

Nombre del padre del nuevo colaborador.

Opcional

Brasil

mothersName

String

Nombre de la madre del nuevo colaborador.

Opcional

Brasil

birthDate

Date

Fecha de nacimiento del nuevo colaborador.

Opcional

Brasil

doesntHave

Boolean

Indica si la persona posee el Registro Nacional de Estrangeiro (RNE), indicando que es una extranjera en Brasil.

Opcional

Brasil

customFields { }

Campos personalizados creados en el modelo de invitación de preadmisión.

Importante

Sobre el envío de los campos birthDate (fecha de nacimiento), mothersName (nombre de la madre) y fathersName (nombre del padre) en la solicitud de la API:

  • Para nuevos colaboradores brasileños, puedes enviar estos campos en el grupo **basic** o **rg** — la información se sincroniza automáticamente entre ambos.
  • Para nuevos colaboradores extranjeros, debes enviar estos campos en el grupo **rne**. La información no se sincroniza con **basic** ni con **rg**.

hiringMedicalExamDataComplete:

Parámetro

Tipo

Descripción

Requerido

País

examDate

Date

Fecha de realización del examen

Opcional

Brasil

doesntHave

Boolean

Indica si la persona no tiene examen admisional

Opcional

Brasil

professionalRecordDataComplete:

Parámetro

Tipo

Descripción

Requerido

País

professionalAdvice{}

Consejo profesional

Opcional

Brasil

number

Long

Número del registro en el consejo profesional

Opcional

Brasil

isTemporary

Boolean

Indica si el registro es temporal

Opcional

Brasil

mteNumber

Long

Número del registro en el Ministerio del Trabajo (MTE)

Opcional

Brasil

shippingDate

Date

Fecha de expedición

Opcional

Brasil

dueDate

Date

Fecha de vencimiento

Opcional

Brasil

doesntHave

Boolean

Indica si el candidato no tiene consejo profesional

Opcional

Brasil

professionalAdvice:

Parámetro

Tipo

Descripción

Requerido

País

name

String

Nombre del consejo profesional

Obligatorio

Brasil

abbreviation

String

Sigla del consejo profesional

Opcional

Brasil

code

String

Código externo

Opcional

Brasil

personalDataCOL:

Parámetro

Descripción

Requerido

País

basic { }

Datos básicos

Opcional

Colombia

complementary { }

Datos complementarios

Opcional

Colombia

emergencyContact { }

Contacto de emergencia

Opcional

Colombia

birthPlace { }

Lugar de nacimiento

Opcional

address { }

Dirección

Opcional

Colombia

telephone { }

Teléfono

Opcional

email { }

Correo electrónico

Opcional

basic:

Parámetro

Tipo

Descripción

Requerido

País

firstName

String

Primer nombre del nuevo colaborador

Opcional

Colombia

middleName

String

Segundo nombre del nuevo colaborador

Opcional

Colombia

firstSurname

String

Primer apellido del nuevo colaborador

Opcional

Colombia

secondSurname

String

Segundo apellido del nuevo colaborador

Opcional

Colombia

preferredName

String

Nombre por el cual el nuevo colaborador prefiere ser llamado

Opcional

Colombia

badgeFileId

String

Dirección donde se guarda la imagen de la credencial

Opcional

Colombia

badgeUploadDate

DateTime

Fecha de carga de la imagen de la credencial

Opcional

Colombia

badgeFileVersion

String

Versión para realizar el commit del archivo

Opcional

Colombia

badgeFilePermanentUrl

String

Ruta permanente del archivo de la imagen de la credencial

Opcional

Colombia

gender { } (ver enumInformationItemData)

Género del nuevo colaborador

Opcional

Colombia

birthDate

Fecha de nacimiento del nuevo colaborador

Opcional

Colombia

customFields { }

Campos personalizados

complementary:

Parámetro

Tipo

Descripción

Requerido

País

maritalStatus { } (ver enumInformationItemData)

Estado civil

Opcional

Colombia

degreeOfEducation { }

Nivel de educación

Opcional

nationality { }

Nacionalidad

Opcional

religion { }

Religión

Opcional

ethnicity { }

Etnia

Opcional

socialName

String

Nombre social

Opcional

Colombia

bloodType { } (ver enumInformationItemData)

Tipo de sangre

Opcional

Colombia

bloodFactor { } (ver enumInformationItemData)

Factor sanguíneo

Opcional

Colombia

height

String

Estatura

Opcional

Colombia

weight

String

Peso

Opcional

Colombia

customFields { }

Campos personalizados

emergencyContact:

Parámetro

Tipo

Descripción

Requerido

País

firstContactName

String

Nombre del primer contacto

Opcional

Colombia

firstContactKinship { } (ver enumInformationItemData)

Parentesco del primer contacto

Opcional

Colombia

firstContactPhone

String

Teléfono del primer contacto

Opcional

Colombia

secondContactName

String

Nombre del segundo contacto

Opcional

Colombia

secondContactKinship { } (ver enumInformationItemData)

Parentesco del segundo contacto

Opcional

Colombia

secondContactPhone

String

Teléfono del segundo contacto

Opcional

Colombia

customFields { }

Campos personalizados

address:

Parámetro

Tipo

Descripción

Requerido

País

country { }

País de nacimiento

Opcional

state { }

Estado de nacimiento

Opcional

city { }

Ciudad de nacimiento

Opcional

cep

String

Código postal (CEP) de la dirección

Opcional

Colombia

neighborhood

String

Barrio de la dirección

Importante

Si el valor del campo Barrio (neighborhood) supera los 40 caracteres, el envío de la admisión no se realizará.

Opcional

Colombia

addressType { } (ver enumInformationItemData)

Tipo de vía

Opcional

Colombia

address

String

Dirección

Opcional

Colombia

number

String

Número de la dirección

Opcional

Colombia

additional

String

Información adicional referente a la dirección

Opcional

Colombia

customFields { }

Campos personalizados

documentDataCOL:

Parámetro

Tipo

Descripción

Diligenciamiento

País

identityDocument { }

Documento de identificación

Opcional

Colombia

professionalRecord { }

Registro profesional

Opcional

Colombia

militaryServiceBook { }

Libreta militar

Opcional

Colombia

driverLicense { }

Licencia de conducción

Opcional

Colombia

epsAffiliation { }

Afiliación EPS

Opcional

Colombia

afpAffiliation { }

Afiliación AFP

Opcional

Colombia

severanceAffiliation { }

Afiliación de cesantías

Opcional

Colombia

bankAccount { }

Cuenta bancaria

Opcional

workCertificate { }

Certificados laborales

Opcional

Colombia

studyCertificate { }

Certificados de estudio

Opcional

Colombia

documentReference { }

Referencias

Opcional

Colombia

backgroundInformation { }

Información de antecedentes

Opcional

Colombia

passport { }

Pasaporte

Opcional

identityDocument

Parámetro

Tipo

Descripción

Diligenciamiento

País

number

String

Número del documento

Opcional

Colombia

documentType { }

Tipo de documento

Opcional

Colombia

issueDate

Date

Fecha de expedición

Opcional

Colombia

issuerCountry { }

País de expedición

Opcional

issuerState { }

Estado de expedición

Opcional

issuerCity { }

Ciudad de expedición

Opcional

doesntHave

Boolean

Si la persona no posee documento de identificación?

Opcional

Colombia

customFields { }

Campos personalizados

documentType:

Parámetro

Tipo

Descripción

Diligenciamiento

País

code

Integer

Código del documento

Opcional

Colombia

name

String

Nombre del documento

Opcional

Colombia

professionalRecord:

Parámetro

Tipo

Descripción

Diligenciamiento

País

number

String

Número del documento

Opcional

Colombia

issueDate

Date

Fecha de expedición

Opcional

Colombia

doesntHave

Boolean

Si la persona no posee registro profesional

Opcional

Colombia

customFields { }

Campos personalizados

militaryServiceBook:

Parámetro

Tipo

Descripción

Diligenciamiento

País

number

String

Número del documento

Opcional

Colombia

issueDate

Date

Fecha de expedición

Opcional

Colombia

militaryServiceBookClass { } (ver enumInformationItemData)

Relacionamiento de militaryServiceBookClassCOL

Opcional

Colombia

district

String

Distrito del documento

Opcional

Colombia

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee datos de la libreta de servicio militar

Opcional

Colombia

driverLicense:

Parámetro

Tipo

Descripción

Diligenciamiento

País

number

String

Número del documento

Opcional

Colombia

category { } (ver enumInformationItemData)

Categoría del documento

Opcional

Colombia

issueDate

Date

Fecha de expedición

Opcional

Colombia

expiryDate

Date

Fecha de vencimiento

Opcional

Colombia

issuer

String

Emisor del documento

Opcional

Colombia

restrictions

String

Restricciones del documento

Opcional

Colombia

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee datos de licencia de conducción

Opcional

Colombia

eps:

Parámetro

Tipo

Descripción

Diligenciamiento

País

code

Integer

Código del documento

Opcional

Colombia

name

String

Nombre de la EPS

Opcional

Colombia

type { } (ver enumSocialSecurityTypeCOL)

Tipo de EPS

Opcional

Colombia

epsAffiliation:

Parámetro

Tipo

Descripción

Diligenciamiento

País

name { }

Nombre de la EPS

Opcional

Colombia

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee EPS

Opcional

Colombia

afpAffiliation:

Parámetro

Tipo

Descripción

Diligenciamiento

País

name { }

Nombre de la AFP

Opcional

Colombia

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee AFP

Opcional

Colombia

severanceAffiliation:

Parámetro

Tipo

Descripción

Diligenciamiento

País

name { }

Nombre de la afiliación de cesantías

Opcional

Colombia

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee datos de afiliación de cesantías

Opcional

Colombia

workCertificate:

Parámetro

Tipo

Descripción

Diligenciamiento

País

workCertificateItem { }

Ítems de certificados del candidato

Opcional

Colombia

hasWorkCertificate

Boolean

Informa si el candidato tiene certificado laboral

Opcional

Colombia

doesntHave

Boolean

Campo no posee

Opcional

Colombia

workCertificateItem:

Parámetro

Tipo

Descripción

Diligenciamiento

País

name

String

Nombre del ítem del certificado laboral

Opcional

Colombia

studyCertificate:

Parámetro

Tipo

Descripción

Diligenciamiento

País

studyCertificateItem { }

Ítems de certificados del candidato

Opcional

Colombia

hasStudyCertificate

Boolean

Informa si el candidato tiene certificado de estudio

Opcional

Colombia

doesntHave

Boolean

Campo no posee

Opcional

Colombia

studyCertificateItem:

Parámetro

Tipo

Descripción

Diligenciamiento

País

name

String

Nombre del ítem del certificado de estudio

Opcional

Colombia

documentReference:

Parámetro

Tipo

Descripción

Diligenciamiento

País

documentReferenceItem { }

Ítems de certificados del candidato

Opcional

Colombia

hasDocumentReference

Boolean

Informa si el candidato tiene certificado laboral

Opcional

Colombia

doesntHave

Boolean

Campo no posee

Opcional

Colombia

documentReferenceItem:

Parámetro

Tipo

Descripción

Diligenciamiento

País

reference { } (ver enumInformationItemData

Nombre del ítem del documento de referencia

Opcional

Colombia

backgroundInformation:

Parámetro

Tipo

Descripción

Diligenciamiento

País

customFields { }

Campos personalizados

doesntHave

Boolean

Si la persona no posee datos de documento de antecedentes

Opcional

Colombia

birthPlace:

Parámetro

Tipo

Descripción

Diligenciamiento

País

country { }

Datos del país de nacimiento.

Opcional

Brasil/Colombia

state { }

Datos del estado de nacimiento.

Opcional

Brasil/Colombia

city { }

Datos de la ciudad de nacimiento.

Opcional

Brasil/Colombia

email:

Parámetro

Tipo

Descripción

Diligenciamiento

País

firstEmail

String

E-mail principal del nuevo colaborador.

Opcional

Brasil/Colombia

firstType { } (ver enumInformationItemData)

Tipo del e-mail principal.

Opcional

Brasil/Colombia

secondEmail

String

E-mail secundario del nuevo colaborador.

Opcional

Brasil/Colombia

secondType { } (ver enumInformationItemData)

Tipo del e-mail secundario.

Opcional

Brasil/Colombia

telephone:

Parámetro

Tipo

Descripción

Diligenciamiento

País

firstPhone

String

Teléfono de contacto principal del nuevo colaborador.

Opcional

Brasil/Colombia

firstType { } (ver enumInformationItemData)

Tipo del teléfono de contacto principal.

Opcional

Brasil/Colombia

secondPhone

String

Teléfono de contacto secundario del nuevo colaborador.

Opcional

Brasil/Colombia

secondType { } (ver enumInformationItemData)

Tipo del teléfono de contacto secundario.

Opcional

Brasil/Colombia

passport:

Parámetro

Tipo

Descripción

Diligenciamiento

País

number

String

Número del documento (Pasaporte).

Opcional

Brasil/Colombia

issueDate

Date

Fecha de expedición del documento.

Opcional

Brasil/Colombia

issuerState { }

Estado de expedición del documento.

Opcional

Brasil/Colombia

issuer

String

Órgano emisor del documento.

Opcional

Brasil/Colombia

issuerCountry { }

País de expedición del documento.

Opcional

Brasil/Colombia

expiryDate

Date

Fecha de expiración del documento.

Opcional

Brasil/Colombia

bankAccount:

Parámetro

Tipo

Descripción

Diligenciamiento

País

bank { }

Banco.

Opcional

Brasil/Colombia

branch

Integer

Número de la agencia bancaria.

Opcional

Brasil/Colombia

accountType { } (ver enumInformationItemData)

Tipo de la cuenta.

Opcional

Brasil/Colombia

bankAccount

String

Número de la cuenta bancaria.

Opcional

Brasil/Colombia

digit

String

Dígito de la cuenta bancaria.

Opcional

Brasil/Colombia

degreeOfEducation:

Parámetro

Tipo

Descripción

Diligenciamiento

País

code

Integer

Código del grado de instrucción.

Opcional

Brasil/Colombia

name

String

Nombre del grado de instrucción.

Opcional

Brasil/Colombia

type

String

Tipo del grado de instrucción.

Valores permitidos:
  • ILLITERATE = 01 - Analfabeto, incluso aquel que, aunque haya recibido instrucción, no se alfabetizó
  • ELEMENTARY_SCHOOL_INCOMPLETE = 02 - Enseñanza fundamental incompleta
  • ELEMENTARY_SCHOOL_COMPLETE = 03 - 5º año completo de la enseñanza fundamental
  • MIDDLE_SCHOOL_INCOMPLETE = 04 - Del 6º al 9º año de la enseñanza fundamental incompleta (antigua 5ª a 8ª serie)
  • MIDDLE_SCHOOL_COMPLETED = 05 - Enseñanza fundamental completa
  • HIGH_SCHOOL_INCOMPLETE = 06 - Enseñanza media incompleta
  • HIGH_SCHOOL_COMPLETED = 07 - Enseñanza media completa
  • HIGHER_INCOMPLETE = 08 - Educación superior incompleta
  • HIGHER_COMPLETED = 09 - Educación superior completa
  • POST_GRADUATED = 10 - Posgrado completo
  • MASTER = 11 - Maestría completa
  • DOCTORAL = 12 - Doctorado completo

Opcional

Brasil/Colombia

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ê?