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/preAdmissionSendSustituye<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
* ObligatoriosPará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:
| Opcional | Brasil/Colombia |
— | 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 |
— | Campos personalizados del contrato. | Opcional | Brasil/Colombia | |
origin | String | Origen de la admisión. Valores permitidos:
| Opcional | Brasil/Colombia |
salaryType | String | Tipo de salario. Valores permitidos:
| 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 |
|---|---|---|---|---|
Datos de información personal. | Opcional | Brasil | ||
Datos de información personal Col | Opcional | Colombia | ||
Datos de documentos. | Opcional | Brasil | ||
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 |
|---|---|---|---|
Información personal básica. | Opcional | Brasil | |
Información complementaria. | Opcional | Brasil | |
Información del lugar de nacimiento. | Opcional | ||
Información de dirección. | Opcional | Brasil | |
Información de correo electrónico. | Opcional | ||
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 |
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 | |
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 |
Información sobre la nacionalidad. | Opcional | |||
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 |
Campos personalizados creados en el modelo de invitación de preadmisión. | ||||
Información sobre la etnia | Opcional |
address:
Parámetro | Tipo | Descripción | Requerido | País |
|---|---|---|---|---|
Datos del país de la dirección. | Opcional | |||
Datos del estado de la dirección. | Opcional | |||
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 |
|---|---|---|---|
Datos del Cadastro de Pessoa Física (CPF). | Opcional | Brasil | |
Datos del Programa de Integração Social (PIS). | Opcional | Brasil | |
Datos de la Carteira de Trabalho e Previdência Social (CTPS). | Opcional | Brasil | |
Datos del Registro Geral (RG). | Opcional | Brasil | |
Datos del pasaporte. | Opcional | ||
Datos del Registro de Identidade Civil (RIC). | Opcional | Brasil | |
Datos del Título de Eleitor. | Opcional | Brasil | |
Datos de la Carteira Nacional de Habilitação (CNH). | Opcional | Brasil | |
Datos del Certificado de Reservista. | Opcional | Brasil | |
Datos de la Certidão Civil. | Opcional | Brasil | |
Datos del Cartão Nacional de Saúde (CNS). | Opcional | Brasil | |
Datos de la Declaração de Nascido Vivo (DNV). | Opcional | Brasil | |
Datos bancarios. | Opcional | ||
receiveSalaryAdvance { } (ver enumInformationItemData) | Identifica si el nuevo colaborador desea recibir adelanto salarial. | Opcional | Brasil |
Datos del Registro Nacional de Estrangeiro (RNE). | Opcional | Brasil | |
Datos del examen de admisión | Opcional | Brasil | |
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 |
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 |
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 |
Estado de emisión del documento. | Opcional | Brasil | ||
issuer | String | Órgano emisor del documento. | Opcional | Brasil |
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 |
Estado de emisión del documento. | Opcional | Brasil | ||
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 |
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 |
Estado de emisión del documento. | Opcional | Brasil | ||
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 |
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 |
|---|---|---|---|---|
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 |
|---|---|---|---|
Datos básicos | Opcional | Colombia | |
Datos complementarios | Opcional | Colombia | |
Contacto de emergencia | Opcional | Colombia | |
Lugar de nacimiento | Opcional | ||
Dirección | Opcional | Colombia | |
Teléfono | Opcional | ||
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 | |
Campos personalizados |
complementary:
Parámetro | Tipo | Descripción | Requerido | País |
|---|---|---|---|---|
maritalStatus { } (ver enumInformationItemData) | Estado civil | Opcional | Colombia | |
Nivel de educación | Opcional | |||
Nacionalidad | Opcional | |||
Religión | Opcional | |||
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 |
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 |
Campos personalizados |
address:
Parámetro | Tipo | Descripción | Requerido | País |
|---|---|---|---|---|
País de nacimiento | Opcional | |||
Estado de nacimiento | Opcional | |||
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 |
Campos personalizados |
documentDataCOL:
Parámetro | Tipo | Descripción | Diligenciamiento | País |
|---|---|---|---|---|
Documento de identificación | Opcional | Colombia | ||
Registro profesional | Opcional | Colombia | ||
Libreta militar | Opcional | Colombia | ||
Licencia de conducción | Opcional | Colombia | ||
Afiliación EPS | Opcional | Colombia | ||
Afiliación AFP | Opcional | Colombia | ||
Afiliación de cesantías | Opcional | Colombia | ||
Cuenta bancaria | Opcional | |||
Certificados laborales | Opcional | Colombia | ||
Certificados de estudio | Opcional | Colombia | ||
Referencias | Opcional | Colombia | ||
Información de antecedentes | Opcional | Colombia | ||
Pasaporte | Opcional |
identityDocument
Parámetro | Tipo | Descripción | Diligenciamiento | País |
|---|---|---|---|---|
number | String | Número del documento | Opcional | Colombia |
Tipo de documento | Opcional | Colombia | ||
issueDate | Date | Fecha de expedición | Opcional | Colombia |
País de expedición | Opcional | |||
Estado de expedición | Opcional | |||
Ciudad de expedición | Opcional | |||
doesntHave | Boolean | Si la persona no posee documento de identificación? | Opcional | Colombia |
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 |
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 |
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 |
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 |
|---|---|---|---|---|
Nombre de la EPS | Opcional | Colombia | ||
Campos personalizados | ||||
doesntHave | Boolean | Si la persona no posee EPS | Opcional | Colombia |
afpAffiliation:
Parámetro | Tipo | Descripción | Diligenciamiento | País |
|---|---|---|---|---|
Nombre de la AFP | Opcional | Colombia | ||
Campos personalizados | ||||
doesntHave | Boolean | Si la persona no posee AFP | Opcional | Colombia |
severanceAffiliation:
Parámetro | Tipo | Descripción | Diligenciamiento | País |
|---|---|---|---|---|
Nombre de la afiliación de cesantías | Opcional | Colombia | ||
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 |
|---|---|---|---|---|
Í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 |
|---|---|---|---|---|
Í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 |
|---|---|---|---|---|
Í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 |
|---|---|---|---|---|
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 |
|---|---|---|---|---|
Datos del país de nacimiento. | Opcional | Brasil/Colombia | ||
Datos del estado de nacimiento. | Opcional | Brasil/Colombia | ||
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 |
Estado de expedición del documento. | Opcional | Brasil/Colombia | ||
issuer | String | Órgano emisor del documento. | Opcional | Brasil/Colombia |
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 |
|---|---|---|---|---|
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:
| 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:
| 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 | 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 | 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
gender
maritalStatus
race
addressType (Brasil)
addressType (Colômbia)
firstType e secondType (email)
bloodType
bloodFactor
militaryServiceBookClass
reference
firstContactKinship e secondContactKinship (emergency contact)
firstType e secondType (telephone)
category (Brasil)
category (Colômbia)
type
accountType
residenceTime
ConditionVisaType
marriedWithBrazilian
brazilianChildren
| 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
| Opcional |
English
Español

English
Español

