onboardingintegration

2.0info: 1.75.4 onboardingintegration description: Serviço do onboarding para integração com outros sistemas. x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: onboardingintegration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /onboardingintegration/queries/searchPendingAdmission: post: description: Busca todas as pré-admissões com status Admissão pendente e que estão entre as datas pesquisadas.\nAtualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/pendingAdmissionListData description: Resultado com as informações da pré-admissão necessárias para apresentar no módulo Administração de Pessoal. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as pré-admissões com status Admissão pendente e que estão entre as datas pesquisadas.\nAtualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Data inicial para a pesquisa pela data de admissão. in: query type: string format: date – name: endDate description: Data final para a pesquisa pela data de admissão. in: query type: string format: date responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/pendingAdmissionListData description: Resultado com as informações da pré-admissão necessárias para apresentar no módulo Administração de Pessoal. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/inviteModelQuery: post: description: Retorna os modelos de convite para envio da pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Tamanho das páginas. default: 10 offset: type: integer format: int64 description: Indicativo da página atual. default: 0 filter: type: string description: Filtro a ser aplicado na pesquisa – baseado no nome do modelo responses: 200: description: Ok schema: type: object required: – inviteModelData properties: inviteModelData: type: array items: type: object allOf: – #/definitions/inviteModelData minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os modelos de convite para envio da pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: offset description: Indicativo da página atual. in: query type: integer format: int64 – name: filter description: Filtro a ser aplicado na pesquisa – baseado no nome do modelo in: query type: string responses: 200: description: Ok schema: type: object required: – inviteModelData properties: inviteModelData: type: array items: type: object allOf: – #/definitions/inviteModelData minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionQuery: post: description: Busca todas as informações de uma pré-admissão de acordo com o identificador único. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/preAdmissionData description: Resultado com todas as informações da pré-admissão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as informações de uma pré-admissão de acordo com o identificador único. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/preAdmissionData description: Resultado com todas as informações da pré-admissão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/companyQuery: post: description: Retorna uma lista de empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Tamanho das páginas. default: 10 offset: type: integer format: int64 description: Indicativo da página atual. default: 0 filter: type: string description: Filtro a ser aplicado na pesquisa – baseado no nome da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de empresas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: offset description: Indicativo da página atual. in: query type: integer format: int64 – name: filter description: Filtro a ser aplicado na pesquisa – baseado no nome da empresa in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/branchOfficeQuery: post: description: Retorna uma lista de filiais tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – company properties: size: type: integer format: int64 description: Tamanho das páginas. default: 10 offset: type: integer format: int64 description: Indicativo da página atual. default: 0 filter: type: string description: Filtro a ser aplicado na pesquisa – baseado no nome da filial company: type: string description: id da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/branchOffice minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de filiais tags: – Queries x-senior-visibility: PUBLIC parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: offset description: Indicativo da página atual. in: query type: integer format: int64 – name: filter description: Filtro a ser aplicado na pesquisa – baseado no nome da filial in: query type: string – name: company description: id da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/branchOffice minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/areaQuery: post: description: Retorna uma lista de áreas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Tamanho das páginas. default: 10 offset: type: integer format: int64 description: Indicativo da página atual. default: 0 filter: type: string description: Filtro a ser aplicado na pesquisa – baseado no nome da filial company: type: string description: id da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/area minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de áreas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: offset description: Indicativo da página atual. in: query type: integer format: int64 – name: filter description: Filtro a ser aplicado na pesquisa – baseado no nome da filial in: query type: string – name: company description: id da empresa in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/area minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/jobPositionQuery: post: description: Retorna uma lista de cargos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Tamanho das páginas. default: 10 offset: type: integer format: int64 description: Indicativo da página atual. default: 0 filter: type: string description: Filtro a ser aplicado na pesquisa – baseado no nome do cargo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/jobPosition minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de cargos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: offset description: Indicativo da página atual. in: query type: integer format: int64 – name: filter description: Filtro a ser aplicado na pesquisa – baseado no nome do cargo in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/jobPosition minimum: 1 description: Resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionFinishedListQuery: post: description: Busca todas as pré-admissões finalizadas de um determinado período e para cada uma, lista todas as informações.\nA lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\nAlgumas regras são aplicadas na busca das pré-admissões:\n* A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n* O período de admissão não pode ser superior a 31 dias.\n* A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\nadmissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. size: type: integer format: int64 description: Quantidade de registros que deve ser apresentada em cada página. default: 10 page: type: integer format: int64 description: Número da página atual. A primeira página inicia em zero. default: 0 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as pré-admissões finalizadas de um determinado período e para cada uma, lista todas as informações.\nA lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\nAlgumas regras são aplicadas na busca das pré-admissões:\n* A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n* O período de admissão não pode ser superior a 31 dias.\n* A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\nadmissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: startDate description: Data inicial para a pesquisa pela data de admissão. in: query required: true type: string format: date – name: endDate description: Data final para a pesquisa pela data de admissão. in: query required: true type: string format: date – name: size description: Quantidade de registros que deve ser apresentada em cada página. in: query type: integer format: int64 – name: page description: Número da página atual. A primeira página inicia em zero. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/preAdmissionListQuery: post: description: Busca todas as pré-admissões de um status de um determinado período e para cada uma, lista todas as informações.\nA lista de pré-admissões possui paginação, ou seja, somente alguns registros são exibidos em cada página.\nAlgumas regras são aplicadas na busca das pré-admissões:\n* A quantidade de registros por página não pode ser superior a 30 registros (A quantidade padrão é igual a 10).\n* O período de admissão não pode ser superior a 31 dias.\n* A ordenação das pré-admissões será efetuada por data de admissão e, caso houver mais de uma pré-admissão com a mesma data de\nadmissão, será pelo nome do novo colaborador.\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – status properties: startDate: type: string format: date description: Data inicial para a pesquisa pela data de admissão. endDate: type: string format: date description: Data final para a pesquisa pela data de admissão. status: type: string allOf: – #/definitions/enumInvitationStatus description: Status atual da pré-admissão. size: type: integer format: int64 description: Quantidade de registros que deve ser apresentada em cada página. default: 10 page: type: integer format: int64 description: Número da página atual. A primeira página inicia em zero. default: 0 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionList description: Lista das pré-admissões encontradas com base nas informações fornecidas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/getBadgeFileFromPreAdmissionId: post: description: Busca a URL de download da imagem do crachá de uma pré admissão tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 200: description: Ok schema: type: object required: – key – value properties: key: type: string description: Chave value: type: string description: URL da Imagem no S3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a URL de download da imagem do crachá de uma pré admissão tags: – Queries x-senior-visibility: PUBLIC parameters: – name: preAdmissionId description: Identificador único da pré-admissão in: query required: true type: string responses: 200: description: Ok schema: type: object required: – key – value properties: key: type: string description: Chave value: type: string description: URL da Imagem no S3 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/requestUploadDocumentSign: post: description: Solicita o upload de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome que irá corresponder ao arquivo. responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Solicita o upload de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: fileName description: Nome que irá corresponder ao arquivo. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/preAdmissionStatusUpdate: post: description: Esta ação possibilita atualizar o status de uma pré-admissão de acordo com a operação que o usuário está executando.\nAtualmente esta ação é utilizada para integração com o módulo Administração de Pessoal.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – hiringProcessAction properties: preAdmissionId: type: string description: Identificador único da pré-admissão. hiringProcessAction: type: string allOf: – #/definitions/enumHiringProcessActions description: Ação que está sendo executada pelo usuário. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da ação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/preAdmissionSend: post: description: Efetua o envio de um convite para iniciar o processo de admissão de um novo colaborador.\nDurante o processo de envio as informações serão validadas e você receberá um retorno positivo ou negativo, caso o convite tenha sido enviado com sucesso, ou não.\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – employeeName – admissionDate – modelId properties: employeeName: type: string maxLength: 255 description: Nome completo do novo colaborador. employeeEmail: type: string maxLength: 255 description: E-mail do novo colaborador. employeeMobilePhone: type: string maxLength: 20 description: Número de telefone celular do novo colaborador. key: type: string maxLength: 255 description: Chave da pré-admissão, para convites brasileiros, a chave de identificação é o CPF do novo colaborador. admissionDate: type: string format: date description: Data de admissão do novo colaborador. modelId: type: string description: Identificador único do modelo de convite associado a pré-admissão. additionalInfo: type: string description: Informação adicional que pode ser enviada no modelo de convite. jobPosition: type: string description: Identificador único do cargo. branchOffice: type: string description: Identificador único da filial. area: type: string description: Identificador único da área. company: type: string description: Identificador único da empresa. employeeMobilePhoneOption: type: string allOf: – #/definitions/enumMobilePhoneOption description: Opção de recebimento de convite (SMS, WhatsApp) personalData: type: object allOf: – #/definitions/personalData description: Dados pessoais da preAdmission companyName: type: string description: Nome da empresa branchOfficeName: type: string description: Nome da filial areaName: type: string description: Nome da área tradingName: type: string description: Nome fantasia da filial jobPositionName: type: string description: Nome do cargo customFieldsContract: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados do contrato vacancyCode: type: integer format: int64 description: Código da vaga quando tem integração com GRS workstationId: type: string description: Posto de trabalho workstationGroupName: type: string description: Nome do posto de trabalho costCenterId: type: string description: Centro de custo costCenterName: type: string description: Nome do centro de custo origin: type: string allOf: – #/definitions/enumOriginIntegration description: Origem da admissão externalId: type: string description: ID externo responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado do envio do convite. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/preAdmissionUpdate: post: description: Edita um convite de um colaborador tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificação da pré-admissão. employeeName: type: string maxLength: 255 description: Nome do novo colaborador admissionDate: type: string format: date description: Data prevista de admissão do novo colaborador company: type: object allOf: – #/definitions/company description: Empresa para integração. branchOffice: type: object allOf: – #/definitions/branchOffice description: Filial do contrato area: type: object allOf: – #/definitions/area description: Área do contrato jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Posto de trabalho costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados do contrato customFieldsInviteModelContract: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados contrato modelo de convite responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/documentsSend: post: description: Envia documentos para assinatura. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – contracts – signer – instructionsToSigner – preAdmissionId properties: contracts: type: array items: type: object allOf: – #/definitions/contractData minimum: 1 description: Lista de documentos selecionados. signer: type: array items: type: object allOf: – #/definitions/signerData minimum: 1 description: dados do assinante do contrato. instructionsToSigner: type: string description: Um texto com instruções para o assinante preAdmissionId: type: string description: ID da Pre Admissão demandGeolocation: type: boolean description: Obrigar geolocalização default: false sendSms: type: boolean description: Obrigar enviar por SMS default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboardingintegration/actions/reasonWithdrawalSend: post: description: Insere um registro de desistência de pré-admissão na base tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – enumWithdrawal – reason properties: preAdmissionId: type: string description: Id da pré-admission enumWithdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Status da desistência/reabilitação reason: type: string description: Razão da desistência/reabilitação responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumHiringProcessActions: description: Ações que podem ser executadas no módulo Administração de pessoal. type: string enum: – IMPORT – HIRE enumInvitationStatus: description: Status que uma pré-admissão pode assumir. type: string enum: – UNREAD – READ – EXPIRED – IN_VALIDATION – FINISHED – PENDING_ADMISSION – STARTED_ADMISSION – FINISHED_ADMISSION – IN_SIGNATURE – SIGNED – PENDING_EMAIL – EMAIL_ERROR – VALIDATING_DESK – VALIDATED_BY_DESK enumDegreeOfEducation: description: Tipo de grau de instrução. type: string enum: – ILLITERATE – ELEMENTARY_SCHOOL_INCOMPLETE – ELEMENTARY_SCHOOL_COMPLETE – MIDDLE_SCHOOL_INCOMPLETE – MIDDLE_SCHOOL_COMPLETED – HIGH_SCHOOL_INCOMPLETE – HIGH_SCHOOL_COMPLETED – HIGHER_INCOMPLETE – HIGHER_COMPLETED – POST_GRADUATED – MASTER – DOCTORAL – POST_DOCTORATE enumNationalityType: description: Tipo de nacionalidade. type: string enum: – BRAZILIAN – OTHER enumRacialType: description: Tipo de raça. type: string enum: – WHITE – BLACK – BROWN – YELLOW – INDIGENOUS – NOT_INFORMED situation: description: Situação do cadastro de modelos de convite. type: string enum: – ACTIVE – INACTIVE enumYesNo: description: Enumeração para identificar valores de Sim e Não. type: string enum: – YES – NO enumMobilePhoneOption: description: Opção de comunicação via celular type: string enum: – SMS – WHATSAPP – ALL categoryField: description: Categorias relacionadas ao campo. type: string enum: – PATTERN valueType: description: Tipos de valores possíveis para um campo no convite. type: string enum: – PATTERN_UPPERCASE – PATTERN_SPECIAL_CHARACTER enumTelephone: description: Tipos de telefone para contato – Detalhes da pré-admissão. type: string enum: – PERSONAL_TELEPHONE – COMMERCIAL_TELEPHONE – CELLPHONE – PERSONAL_FAX – COMMERCIAL_FAX – OTHER_TELEPHONE_TYPE enumCivilCertificate: description: Tipo de certidão civil. type: string enum: – BIRTH_CERTIFICATE – MARRIAGE_CERTIFICATE – INDIGENOUS_PERSONS_BIRTH_CERTIFICATE – DEATH_CERTIFICATE – MARRIAGE_CERTIFICATE_WITH_DIVORCE_ANNOTATION enumEmail: description: Tipo de e-mail – Detalhes da pré-admissão. type: string enum: – PERSONAL_EMAIL – PROFESSIONAL_EMAIL enumDriverLicenceCategory: description: Categorias de carteira de habilitação. type: string enum: – A – B – C – D – E – AB – AC – AD – AE enumDocumentStatus: description: Enumeração de status dos documentos da assinatura eletrônica type: string enum: – PROCESSING – IN_SIGNATURE – PARTIAL_IN_SIGNATURE – CANCELED – SIGNED – FAILURE_PROCESSING_FILE – EXPIRED_GED – SIGNED_PARTIAL – DECLINED enumConditionVisaType: description: Condição do visto do estrangeiro type: string enum: – PERMANENT – TEMPORARY – ASYLUM – REFUGEE – REFUGEE_APPLICANT – BORDER_COUNTRY_TO_BRAZIL – DISABILITY – PROVISIONAL_RESIDENCE_AND_AMNESTY – PERMANENCE_IN_BRAZIL_DUE_TO_CHILDREN_OR_SPOUSE – BENEFITED_BY_MERCOSUR – DEPENDENT_ON_DIPLOMATIC_AGENT – BENEFITED_BY_THE_TREATY_OF_FRIENDSHIP – OTHER_CONDITION enumResidenceTime: description: Tempo de Residência type: string enum: – DETERMINED – UNDETERMINED enumWithdrawal: description: Tipo de desistência type: string enum: – WITHDRAWAL – NO_WITHDRAWAL enumOriginIntegration: description: Origem da integração type: string enum: – GRS – EXTERNAL – INTERNAL userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN inviteModelData: description: Contém as informações relacionadas ao modelo de convite. type: object required: – modelId – name – country – deadline properties: modelId: type: string description: Id do modelo de convite. name: type: string maxLength: 100 description: Descrição do modelo. country: type: string description: País relacionado ao modelo. deadline: type: integer format: int64 description: Prazo do convite. resultBaseData: description: Contém as informações relacionadas ao retorno das primitivas. type: object required: – ok properties: ok: type: boolean description: Indicativo se o resultado foi efetuado com sucesso ou não. message: type: string description: Mensagem de retorno da primitiva. default: idPreAdmission: type: string description: ID da PreAdmission default: linkWhatsApp: type: string description: Link para o whatsapp pendingAdmissionListData: description: Contém a lista dos registros pendentes de admissão. type: object properties: employees: type: array items: type: object allOf: – #/definitions/pendingAdmissionData description: Lista com os registros pendentes de admissão. pendingAdmissionData: description: Contém as informações básicas de uma pré-admissão. type: object properties: preAdmissionId: type: string description: Identificador único da pré-admissão. employeeName: type: string description: Nome do novo colaborador. employeeCpf: type: string description: CPF do novo colaborador. admissionDate: type: string format: date description: Data que o colaborador será admitido. vacancyCode: type: integer format: int64 description: Codigo da vaga quando tem integração com GRS company: type: object allOf: – #/definitions/companyData description: Dados da empresa branchOffice: type: object allOf: – #/definitions/branchOfficeData description: Dados da filial preAdmissionList: description: Contém todas as informações das pré-admissões de um determinado período, utilizando paginação. type: object properties: totalElements: type: integer format: int64 description: Total de pré-admissões encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/preAdmissionData description: Relação das pré-admissões relacionadas a página. preAdmissionData: description: Contém todas as informações de uma determinada pré-admissão. type: object properties: preAdmissionId: type: string description: Identificador único da pré-admissão. admissionDate: type: string format: date description: Data que o novo colaborador será admitido. contract: type: object allOf: – #/definitions/contractData description: Informações de contrato com a empresa. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Informações pessoais do novo colaborador. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Documentos do novo colaborador. dependents: type: array items: type: object allOf: – #/definitions/dependentData description: Relação de dependentes do novo colaborador. preAdmissionCustomEntities: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Informação das entidades Customizadas. vacancyCode: type: integer format: int64 description: Codigo da vaga quando tem integração com GRS withdrawal: type: object allOf: – #/definitions/enumInformationItemData description: Flag sinalizando se o candidato desistiu da pré-admissão withdrawalData: type: array items: type: object allOf: – #/definitions/preAdmissionReasonWithdrawalData description: Retorna todas os registros de desistência da pré-admissão company: description: empresa type: object required: – id – companyName – code properties: id: type: string description: Identificador da empresa. companyName: type: string maxLength: 255 description: Nome da empresa. code: type: string maxLength: 255 description: Código externo da empresa. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. companyData: description: Objeto de trasnferência para dados da empresa, utilizado na integração com Administração de Pessoal type: object required: – companyName – code properties: companyName: type: string maxLength: 255 description: Identificador da empresa. code: type: string maxLength: 255 description: Código externo da empresa. branchOffice: description: filial type: object required: – id – branchOfficeName – tradingName – code properties: id: type: string description: Identificador único do registro. branchOfficeName: type: string maxLength: 255 description: Razão social. tradingName: type: string maxLength: 255 description: Nome fantasia. code: type: string maxLength: 255 description: Código do sistema externo. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. branchOfficeData: description: Objeto de transferência para dados da filial, utilizado na integração com Administração de Pessoal type: object required: – branchOfficeName – code properties: branchOfficeName: type: string maxLength: 255 description: Identificador único do registro. code: type: string maxLength: 255 description: Codigo do sistema externo. area: description: área type: object required: – id – name – code properties: id: type: string description: Identificador único do registro. name: type: string maxLength: 255 description: Nome da área. code: type: string maxLength: 255 description: Código do sistema externo. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. costCenter: description: Cadastro de centro de custo type: object required: – id – name properties: id: type: string description: Identificador único do registro. name: type: string maxLength: 255 description: Nome. code: type: string maxLength: 255 description: Código customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. workstationGroup: description: Cadastro de grupo do posto de trabalho type: object required: – id – name properties: id: type: string description: Identificador único do registro. name: type: string maxLength: 255 description: Nome. code: type: string maxLength: 255 description: Código customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. jobPosition: description: Cadastro de cargo type: object required: – id – name properties: id: type: string description: Identificador único do registro. name: type: string maxLength: 255 description: Nome. code: type: string maxLength: 255 description: Código externo. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. contractData: description: Contém as informações relacionadas ao contrato com a empresa. type: object required: – company – branchOffice – area – jobPosition properties: employeeType: type: string description: Tipo do colaborador. employeeContract: type: string description: Tipo de contrato. eSocialCategory: type: string description: Categoria do eSocial. sefipCategory: type: string description: Categoria da SEFIP. unemploymentInsurance: type: string description: Tipo do seguro desemprego. raisType: type: string description: Vínculo RAIS. company: type: object allOf: – #/definitions/company description: empresa do contrato branchOffice: type: object allOf: – #/definitions/branchOffice description: filial do contrato area: type: object allOf: – #/definitions/area description: área do contrato jobPosition: type: object allOf: – #/definitions/jobPosition description: cargo do contrato workstationId: type: string description: ID Posto de trabalho costCenterId: type: string description: ID Centro de custo customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. preAdmissionPersonalBRAData: description: Contém todas as informações pessoais do novo colaborador. type: object properties: basic: type: object allOf: – #/definitions/personalBasicData description: Informações pessoais básicas. complementary: type: object allOf: – #/definitions/personalComplementaryData description: Informações complementares. birthPlace: type: object allOf: – #/definitions/personalBirthPlaceData description: Informações do local de nascimento. address: type: object allOf: – #/definitions/personalAddressBRAData description: Informações de endereço. email: type: object allOf: – #/definitions/personalEmailData description: Informações de e-mail. phone: type: object allOf: – #/definitions/personalTelephoneData description: Informações de telefone. disability: type: object allOf: – #/definitions/disabilityData description: Dados de deficiência preAdmissionPersonalBRADataComplete: description: Contém todas as informações pessoais do novo colaborador. type: object properties: basic: type: object allOf: – #/definitions/personalBasicDataComplete description: Informações pessoais básicas. complementary: type: object allOf: – #/definitions/personalComplementaryDataComplete description: Informações complementares. birthPlace: type: object allOf: – #/definitions/personalBirthPlaceDataComplete description: Informações do local de nascimento. address: type: object allOf: – #/definitions/personalAddressBRADataComplete description: Informações de endereço. email: type: object allOf: – #/definitions/personalEmailDataComplete description: Informações de e-mail. telephone: type: object allOf: – #/definitions/personalTelephoneDataComplete description: Informações de telefone. disability: type: object allOf: – #/definitions/disabilityDataComplete description: Dados de deficiência preAdmissionDocumentBRAData: description: Contém todos os documentos do novo colaborador. type: object properties: cpf: type: object allOf: – #/definitions/cpfData description: Cadastro de pessoas físicas (CPF). pis: type: object allOf: – #/definitions/pisData description: Programa de integração social (PIS). ctps: type: object allOf: – #/definitions/ctpsData description: Carteira de trabalho e previdência social (CTPS). rg: type: object allOf: – #/definitions/rgData description: Registro geral (RG). passport: type: object allOf: – #/definitions/passportData description: Passaporte. ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil (RIC). voter: type: object allOf: – #/definitions/voterData description: Título de eleitor. cnh: type: object allOf: – #/definitions/cnhData description: Carteira nacional de habilitação (CNH). reservist: type: object allOf: – #/definitions/reservistData description: Certificado de reservista. civilCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão civil. cns: type: object allOf: – #/definitions/cnsData description: Cartão nacional de saúde (CNS). dnv: type: object allOf: – #/definitions/dnvData description: Declaração de nascido vivo (DNV). bankAccount: type: object allOf: – #/definitions/bankAccountData description: Dados bancários. receiveSalaryAdvance: type: string description: Indicativo se o novo colaborador gostaria de receber adiantamento salarial. professionalRecord: type: object allOf: – #/definitions/professionalRecordData description: Registro profissional hiringMedicalExam: type: object allOf: – #/definitions/hiringMedicalExamData description: Exame admissional. rne: type: object allOf: – #/definitions/rneData description: Registro Nacional do Estrangeiro isForeign: type: string description: É estrangeiro? preAdmissionDocumentBRADataComplete: description: Contém todos os documentos do novo colaborador. type: object properties: cpf: type: object allOf: – #/definitions/cpfDataComplete description: Cadastro de pessoas físicas (CPF). pis: type: object allOf: – #/definitions/pisDataComplete description: Programa de integração social (PIS). ctps: type: object allOf: – #/definitions/ctpsDataComplete description: Carteira de trabalho e previdência social (CTPS). rg: type: object allOf: – #/definitions/rgDataComplete description: Registro geral (RG). passport: type: object allOf: – #/definitions/passportDataComplete description: Passaporte. ric: type: object allOf: – #/definitions/ricDataComplete description: Registro de identidade civil (RIC). voter: type: object allOf: – #/definitions/voterDataComplete description: Título de eleitor. cnh: type: object allOf: – #/definitions/cnhDataComplete description: Carteira nacional de habilitação (CNH). reservist: type: object allOf: – #/definitions/reservistDataComplete description: Certificado de reservista. civilCertificate: type: object allOf: – #/definitions/civilCertificateDataComplete description: Certidão civil. cns: type: object allOf: – #/definitions/cnsDataComplete description: Cartão nacional de saúde (CNS). dnv: type: object allOf: – #/definitions/dnvDataComplete description: Declaração de nascido vivo (DNV). bankAccount: type: object allOf: – #/definitions/bankAccountDataComplete description: Dados bancários. receiveSalaryAdvance: type: object allOf: – #/definitions/enumInformationItemData description: Indicativo se o novo colaborador gostaria de receber adiantamento salarial. rne: type: object allOf: – #/definitions/rneDataComplete description: Registro Nacional do Estrangeiro isForeign: type: object allOf: – #/definitions/enumInformationItemData description: É estrangeiro? personalBasicData: description: Contém as informações pessoais básicas da pré-admissão. type: object properties: employeeFullName: type: string description: Nome completo do novo colaborador. gender: type: string description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. preferredName: type: string description: Nome pelo qual o novo colaborador prefere ser chamado. mothersName: type: string description: Nome da mãe do novo colaborador. fathersName: type: string description: Nome do pai do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalBasicDataComplete: description: DTO com os dados pessoais básicos da pré-admissão. type: object properties: id: type: string description: Identificador único do registro. employeeFullName: type: string maxLength: 255 description: Nome completo do novo colaborador. preferredName: type: string maxLength: 255 description: Nome pelo qual o novo colaborador prefere ser chamado. badgeFileId: type: string maxLength: 300 description: Endereço onde a imagem do crachá está salva. badgeFileVersion: type: string description: Versão para realizar o commit do arquivo badgeFileIdPermanentUrl: type: string description: Caminho permanente do arquivo da imagem do crachá. gender: type: object allOf: – #/definitions/enumInformationItemData description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalComplementaryData: description: Contém as informações complementares da pré-admissão. type: object properties: maritalStatus: type: string description: Estado civil. degreeOfEducation: type: integer format: int64 description: Grau de instrução. nationality: type: string description: Nacionalidade. religion: type: string description: Religião. ethnicity: type: object allOf: – #/definitions/ethnicity description: Etnia race: type: string description: Raça/Cor. socialName: type: string description: Nome social. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalComplementaryDataComplete: description: DTO com Dados complementares da pré-admissão. type: object properties: id: type: string description: Identificador da tabela maritalStatus: type: object allOf: – #/definitions/enumInformationItemData description: Estado civil degreeOfEducation: type: object allOf: – #/definitions/degreeOfEducation description: Grau de instrução degreeOfEducationFileId: type: string maxLength: 300 description: Comprovante do grau de instrução degreeOfEducationFileVersion: type: string description: Versão para realizar o commit do anexo de grau de instrução degreeOfEducationFileIdPermanentUrl: type: string description: Caminho permanente do arquivo do arquivo que comprova o grau de instrução. nationality: type: object allOf: – #/definitions/nationality description: Nacionalidade religion: type: object allOf: – #/definitions/religion description: Religião ethnicity: type: object allOf: – #/definitions/ethnicity description: Etnia race: type: object allOf: – #/definitions/enumInformationItemData description: Raça/Cor socialName: type: string maxLength: 255 description: Nome social. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalBirthPlaceData: description: Contém as informações do local de nascimento da pré-admissão. type: object properties: country: type: string description: País de nascimento. state: type: string description: Estado de nascimento. city: type: string description: Cidade de nascimento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalEmailData: description: Contém as informações de e-mails para contato com o novo colaborador da pré-admissão. type: object properties: emailPersonal: type: string description: Email pessoal do novo colaborador. Esta informação só estará disponível em integrações internas. emailBusiness: type: string description: Email comercial do novo colaborador. Esta informação só estará disponível em integrações internas. firstType: type: string description: Tipo do email principal. firstEmail: type: string description: Email principal do novo colaborador. secondType: type: string description: Tipo do email secundário. secondEmail: type: string description: Email secundário do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalTelephoneData: description: Contém as informações de telefones para contato com o novo colaborador da pré-admissão. type: object properties: firstType: type: string description: Tipo do contato do telefone principal. firstPhone: type: string description: Número do telefone principal. secondType: type: string description: Tipo do contato do telefone principal. secondPhone: type: string description: Número do telefone secundário. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalAddressBRAData: description: Contém as informações dos dados do endereço da pré-admissão. type: object properties: country: type: string description: País de nascimento. state: type: string description: Estado de nascimento. city: type: string description: Cidade de nascimento. cep: type: string description: CEP do endereço. neighborhood: type: string maxLength: 255 description: Bairro. addressType: type: string description: Logradouro. address: type: string description: Endereço. number: type: string description: Número do endereço. additional: type: string description: Informação adicional referente ao endereço. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cpfData: description: Contém as informações do cadastro de pessoas físicas (CPF). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. pisData: description: Contém as informações do programa de integração social (PIS). type: object properties: number: type: string description: Número. issueDate: type: string format: date description: Data de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ctpsData: description: Contém as informações da carteira de trabalho e previdência social (CTPS). type: object properties: number: type: string description: Número. serie: type: string description: Série. digit: type: string maxLength: 2 description: Dígito. issuerState: type: string description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. rgData: description: Contém as informações do registro geral (RG). type: object properties: number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerState: type: string description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. passportData: description: Contém as informações do passaporte. type: object properties: number: type: string description: Número. issuer: type: string description: Emissor. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. issuerCountry: type: string description: País da emissão. issuerState: type: string description: Estado da emissão do passaporte. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ricData: description: Contém as informações do Registro de Identidade Civil (RIC). type: object properties: number: type: string description: Número. issuer: type: string description: Órgão emissor. issuerCity: type: string description: Cidade da emissão. issuerState: type: string description: Estado da emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. voterData: description: Contém as informações do título de eleitor. type: object properties: number: type: string description: Número. votingDistrict: type: string description: Zona. votingSection: type: string description: Seção. issueDate: type: string format: date description: Data de emissão. issuerCity: type: string description: Cidade de emissão. issuerState: type: string description: Estado de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnhData: description: Contém as informações da carteira nacional de habilitação (CNH). type: object properties: number: type: string description: Número. category: type: string maxLength: 4 description: Categoria. issuer: type: string description: Órgão emissor. issuerState: type: string maxLength: 2 description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade do CNH. firstDriverLicenseDate: type: string format: date description: Data da primeira habilitação. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. reservistData: description: Contém as informações do certificado de reservista. type: object properties: number: type: string description: Número. serie: type: string description: Série. ra: type: string description: RA. exemptionDate: type: string format: date description: Data de dispensa. hasCertificate: type: boolean description: Indica se a pessoa possui certificado de reservista. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. civilCertificateData: description: Contém as informações do certificado civil. type: object properties: type: type: string description: Tipo. issueDate: type: string format: date description: Data de emissão. registry: type: string description: Matrícula. term: type: string description: Termo. book: type: string description: Livro. sheet: type: string description: Folha. notaryOffice: type: string description: Cartório. issuerCity: type: string description: Cidade de emissão. issuerState: type: string description: Estado de emissão. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dnvData: description: Contém as informações da declaração de nascido vivo (DNV). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnsData: description: Contém as informações do cartão nacional de saúde (CNS). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. bankAccountData: description: Contém as informações bancárias. type: object properties: bank: type: string description: Identificador do banco. branch: type: integer format: int64 description: Número da agência. accountType: type: string description: Tipo da conta. bankAccount: type: string description: Conta bancária. digit: type: string description: Digito da conta. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. professionalRecordData: description: DTO com as informações do registro profissional. type: object properties: id: type: string description: Identificador único do registro profissional. professionalAdvice: type: string description: Conselho profissional number: type: string description: Número de registro no conselho profissional isTemporary: type: string description: É temporário? mteNumber: type: string description: Órgão emissor. shippingDate: type: string format: date description: Data de expedição do registro dueDate: type: string format: date description: Data de vencimento do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. customFieldsProfessionalRecord: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentData: description: Contém os dados do dependente do novo colaborador. type: object properties: fullName: type: string description: Nome completo. degreeOfKinship: type: string description: Grau de parentesco. gender: type: string description: Gênero. birthDate: type: string format: date description: Data de nascimento. mothersName: type: string description: Nome da mãe. maritalStatus: type: string description: Estado civil. declareIncomeTax: type: string description: Indica que o dependente declara imposto de renda. cpf: type: object allOf: – #/definitions/cpfData description: Cadastro de pessoas físicas (CPF). rg: type: object allOf: – #/definitions/rgData description: Registro geral (RG). ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil (RIC). sus: type: object allOf: – #/definitions/susData description: Cartão do sistema único de saúde (SUS). vaccinationBooklet: type: object allOf: – #/definitions/vaccinationBookletData description: Caderneta de vacinação. proofOfEnrollment: type: object allOf: – #/definitions/proofOfEnrollmentData description: Comprovante de matrícula. deathCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão de óbito. birthCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certidão Civil. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. susData: description: Contém as informações do cartão do sistema único de saúde (SUS). type: object properties: number: type: string description: Número. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. vaccinationBookletData: description: Contém as informações da caderneta de vacinação. type: object properties: customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. proofOfEnrollmentData: description: Contém as informações de comprovante de matrícula. type: object properties: customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customData: description: Contém com os valores relacionados aos campos customizados. type: object required: – field properties: field: type: string description: Nome do campo customizado. value: type: string description: Valor do campo customizado. valueList: type: array items: type: string description: Valor do campo customizado quando do tipo lista. personalData: description: Contém as informações de pre admissão para API type: object properties: personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRADataComplete description: Dados de informações pessoais. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRADataComplete description: Dados de documentos. hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. hasDisability: type: boolean description: Identifica se colaborador é deficiente. enumInformationItemData: description: DTO de lista com os items das enumerações. type: object required: – key – value properties: key: type: string description: Chave do item da enumeração. value: type: string description: Valor traduzido do item da enumeração. rneData: description: Dados do Registro Nacional de Estrangeiro type: object properties: arrivalDate: type: string format: date-time description: Data de chegada. residenceTime: type: string description: Tempo de residência conditionVisaType: type: string description: Condição de estrangeiro number: type: string maxLength: 255 description: Número issuer: type: string maxLength: 255 description: Emissor issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade ordinanceNumber: type: string maxLength: 255 description: Número da portaria marriedWithBrazilian: type: string description: Casado com brasileiro brazilianChildren: type: string description: Filhos brasileiros fathersName: type: string maxLength: 255 description: Nome do pai mothersName: type: string maxLength: 255 description: Nome da mãe birthDate: type: string format: date description: Data de nascimento customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. residencyEndDate: type: string format: date description: Data de Término da Residência personalAddressBRADataComplete: description: DTO com Dados do endereço da pré-admissão. type: object properties: id: type: string description: Identificador único do registro. country: type: object allOf: – #/definitions/country description: País de nascimento. state: type: object allOf: – #/definitions/state description: Estado de nascimento. city: type: object allOf: – #/definitions/city description: Cidade de nascimento. cep: type: string maxLength: 10 description: CEP do endereço. neighborhood: type: string maxLength: 255 description: Bairro. addressType: type: object allOf: – #/definitions/enumInformationItemData description: Logradouro. address: type: string maxLength: 255 description: Endereço. number: type: string maxLength: 10 description: Número do endereço. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Versão para realizar o commit do primeiro arquivo firstFilePermanentUrl: type: string description: Url de acesso a primeira imagem additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. personalBirthPlaceDataComplete: description: DTO com Local de nascimento. type: object properties: id: type: string description: Identificador único do registro. country: type: object allOf: – #/definitions/country description: País de nascimento. state: type: object allOf: – #/definitions/state description: Estado de nascimento. city: type: object allOf: – #/definitions/city description: Cidade de nascimento. personalTelephoneDataComplete: description: DTO com Telefones para contato com o novo colaborador. type: object properties: id: type: string description: Identificador único do registro. firstPhone: type: string maxLength: 50 description: Número do telefone principal. firstType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do contato do telefone principal. secondPhone: type: string maxLength: 50 description: Número do telefone secundário. secondType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do contato do telefone principal. personalEmailDataComplete: description: DTO com Emails para contato com o novo colaborador. type: object properties: id: type: string description: Identificador único do registro. firstEmail: type: string maxLength: 255 description: Email principal do novo colaborador. firstType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do email principal. secondEmail: type: string maxLength: 255 description: Email secundário do novo colaborador. secondType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do email secundário. ctpsDataComplete: description: DTO com as informações da carteira de trabalho. type: object properties: id: type: string description: Identificador único da CTPS. number: type: string maxLength: 255 description: Número. serie: type: string maxLength: 255 description: Série. digit: type: string maxLength: 2 description: Dígito. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. doesntHave: type: boolean description: Se a pessoa não possui CTPS default: false cpfDataComplete: description: DTO com as informações do CPF. type: object properties: id: type: string description: Identificador único do CPF. number: type: string maxLength: 255 description: Número. pisDataComplete: description: DTO com as informações do PIS. type: object properties: id: type: string description: Identificador único do PIS. number: type: string maxLength: 255 description: Número. issueDate: type: string format: date description: Data de emissão. doesntHave: type: boolean description: Se a pessoa não possui PIS default: false rgDataComplete: description: DTO com as informações do RG. type: object properties: id: type: string description: Identificador único do RG. number: type: string maxLength: 255 description: Número. issuer: type: string maxLength: 255 description: Órgão emissor. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. doesntHave: type: boolean description: Se a pessoa não possui RG default: false voterDataComplete: description: DTO com as informações do título de eleitor. type: object properties: id: type: string description: Identificador único do Título de eleitor. number: type: string maxLength: 255 description: Número. votingDistrict: type: string maxLength: 255 description: Zona. votingSection: type: string maxLength: 255 description: Seção. issuerCity: type: object allOf: – #/definitions/city description: Cidade de emissão. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. doesntHave: type: boolean description: Se a pessoa não possui Título de eleitor default: false cnhDataComplete: description: DTO com as informações da CNH. type: object properties: id: type: string description: Identificador único da CNH. number: type: string maxLength: 255 description: Número. category: type: object allOf: – #/definitions/enumInformationItemData description: Categoria. issuer: type: string maxLength: 255 description: Órgão emissor. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade do CNH. firstDriverLicenceDate: type: string format: date description: Data da primeira habilitação. doesntHave: type: boolean description: Se a pessoa não possui CNH default: false reservistDataComplete: description: DTO com as informações da certificado de reservista. type: object properties: id: type: string description: Identificador único do certificado de reservista. number: type: string maxLength: 255 description: Número. serie: type: string maxLength: 255 description: Série. ra: type: string maxLength: 255 description: RA. exemptionDate: type: string format: date description: Data de dispensa. doesntHave: type: boolean description: Se a pessoa não possui certificado de reservista default: false dnvDataComplete: description: DTO com as informações da declaração de nascido vivo. type: object properties: id: type: string description: Identificador único do registro. number: type: string maxLength: 255 description: Número. doesntHave: type: boolean description: Se a pessoa não possui DNV default: false cnsDataComplete: description: DTO com as informações do cartão nacional de saúde. type: object properties: id: type: string description: Identificador único da CNS. number: type: string maxLength: 255 description: Número. doesntHave: type: boolean description: Se a pessoa não possui CNS default: false civilCertificateDataComplete: description: DTO com as informações do certificado civil. type: object properties: id: type: string description: Identificador único do certificado civil. type: type: object allOf: – #/definitions/enumInformationItemData description: Tipo. issueDate: type: string format: date description: Data de emissão. registry: type: string maxLength: 255 description: Matrícula. term: type: string maxLength: 255 description: Termo. book: type: string maxLength: 255 description: Livro. sheet: type: string maxLength: 255 description: Folha. notaryOffice: type: string maxLength: 255 description: Cartório. issuerCity: type: object allOf: – #/definitions/city description: Cidade de emissão. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. doesntHave: type: boolean description: Se a pessoa não possui Certidão civil default: false passportDataComplete: description: DTO com as informações do passaporte. type: object properties: id: type: string description: Identificador único do passaporte. number: type: string maxLength: 255 description: Número. issuer: type: string maxLength: 255 description: Emissor. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. issuerCountry: type: object allOf: – #/definitions/country description: País da emissão. issuerState: type: object allOf: – #/definitions/state description: Estado da emissão do passaporte. doesntHave: type: boolean description: Se a pessoa não possui Passaporte default: false ricDataComplete: description: DTO com as informações do RIC. type: object properties: id: type: string description: Identificador único do RIC. number: type: string maxLength: 255 description: Número. issuer: type: string maxLength: 255 description: Órgão emissor. issuerCity: type: object allOf: – #/definitions/city description: Cidade da emissão. issuerState: type: object allOf: – #/definitions/state description: Estado da emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. doesntHave: type: boolean description: Se a pessoa não possui RIC default: false bankAccountDataComplete: description: DTO com as informações bancárias. type: object properties: id: type: string description: Identificador da conta bancária. bank: type: object allOf: – #/definitions/bank description: Identificador do banco. branch: type: integer format: int64 description: Número da agência. accountType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo da conta. bankAccount: type: string maxLength: 100 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta. doesntHave: type: boolean description: Se a pessoa não possui Conta bancária default: false rneDataComplete: description: Dados do Registro Nacional de Estrangeiro type: object properties: id: type: string description: Identificador único do RNE arrivalDate: type: string format: date-time description: Data de chegada. residenceTime: type: object allOf: – #/definitions/enumInformationItemData description: Tempo de residência conditionVisaType: type: object allOf: – #/definitions/enumInformationItemData description: Condição de estrangeiro number: type: string maxLength: 255 description: Número issuer: type: string maxLength: 255 description: Emissor issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade ordinanceNumber: type: string maxLength: 255 description: Número da portaria marriedWithBrazilian: type: object allOf: – #/definitions/enumInformationItemData description: Casado com brasileiro brazilianChildren: type: object allOf: – #/definitions/enumInformationItemData description: Filhos brasileiros fathersName: type: string maxLength: 255 description: Nome do pai mothersName: type: string maxLength: 255 description: Nome da mãe birthDate: type: string format: date description: Data de nascimento doesntHave: type: boolean description: Se a pessoa não possui RNE default: false residencyEndDate: type: string format: date description: Data de Término da Residência customEntityOneData: description: Entidade Customizada 1 type: object properties: id: type: string description: Identificador único do registro. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customEntityTwoData: description: Entidade Customizada 2 type: object properties: id: type: string description: Identificador único do registro. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customEntityThreeData: description: Entidade Customizada 3 type: object properties: id: type: string description: Identificador único do registro. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. preAdmissionCustomEntitiesData: description: DTO com Dados das entidades Customizadas type: object properties: customEntityOne: type: object allOf: – #/definitions/customEntityOneData description: Relacionamento com a entidade customizada 1 customEntityTwo: type: object allOf: – #/definitions/customEntityTwoData description: Relacionamento com a entidade customizada 2 customEntityThree: type: object allOf: – #/definitions/customEntityThreeData description: Relacionamento com a entidade customizada 3 degreeOfEducation: description: Grau de instrução (r022gra) type: object properties: id: type: string description: Identificador único do grau de instrução. code: type: integer format: int64 description: Código do grau de instrução. name: type: string maxLength: 255 description: Nome do grau de instrução. type: type: string allOf: – #/definitions/enumDegreeOfEducation description: Tipo do grau de instrução. nationality: description: Nacionalidade da pessoa. type: object required: – name properties: id: type: string description: Id da nacionalidade. code: type: integer format: int64 description: Código da nacionalidade name: type: string maxLength: 255 description: Nome da nacionalidade type: type: string allOf: – #/definitions/enumNationalityType description: Tipo da nacionalidade. religion: description: Religião. type: object required: – code – name properties: id: type: string description: Id da religião. code: type: integer format: int64 description: Código da religião. name: type: string maxLength: 255 description: Descrição da religião. ethnicity: description: Etnia type: object required: – name properties: id: type: string description: Id da Etnia. code: type: integer format: int64 description: Código da etnia name: type: string maxLength: 255 description: Nome da etnia eSocialRacialType: type: string allOf: – #/definitions/enumRacialType description: Tipo da etnia. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o cargo está ativo ou não. city: description: Cidade. type: object required: – name properties: id: type: string description: Identificador da cidade. name: type: string maxLength: 255 description: Nome da cidade. state: type: string description: Relacionamento com estado da cidade. state: description: Estado da cidade. type: object properties: id: type: string description: Identificador do estado. name: type: string maxLength: 255 description: Nome do estado. abbreviation: type: string maxLength: 255 description: Abreviação do nome do estado. country: type: string description: Relacionamento com país. country: description: País do estado. type: object properties: id: type: string description: Identificador do país. name: type: string maxLength: 255 description: Nome do país. abbreviation: type: string maxLength: 255 description: Abreviação do nome do país. bank: description: Banco. type: object required: – name properties: id: type: string description: Identificador do banco. code: type: integer format: int64 description: Número do banco. name: type: string maxLength: 255 description: Descrição. professionalAdviceData: description: Conselho profissional type: object required: – name – abbreviation properties: id: type: string description: Identificador único do registro name: type: string maxLength: 255 description: Nome do conselho profissional abbreviation: type: string maxLength: 10 description: Sigla do conselho profissional code: type: string description: Código externo. hiringMedicalExamData: description: Exame admissional. type: object properties: customFieldsHiringMedicalExam: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. examDate: type: string format: date description: Data do exame. signerData: description: Cadastro de modelo de contrato. type: object required: – signerName – signerEmail – signerPhone – signerInstructions properties: signerName: type: string maxLength: 255 description: Nome do assinante. signerEmail: type: string maxLength: 255 description: Texto base do contrato. signerPhone: type: string maxLength: 20 description: Telefone do assinante signerInstructions: type: string description: Instruções para o assinante contract: type: string maxLength: 255 description: ID do documento preAdmission: type: string maxLength: 255 description: ID da pré admissão envelope: type: string maxLength: 255 description: Id do Envelope status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do envelope preAdmissionReasonWithdrawalData: description: DTO com os dados de desistências das pré-admissões type: object properties: id: type: string description: Identificador único do registro preAdmission: type: string description: preAdmission a que se refere a motivação withdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Identificador da situação gerou do registro reason: type: string maxLength: 300 description: Justificativa da desistência disabilityData: description: DTO com os dados de deficiência type: object required: – hasDisability properties: id: type: string description: Identificador único do registro preAdmission: type: string description: Pré-admissão disabilityItem: type: array items: type: object allOf: – #/definitions/disabilityItemData description: Lista de deficiências do candidato hasDisability: type: boolean description: Identifica se a pessoa tem deficiência disabilityItemData: description: DTO com os dados dos itens de deficiência type: object required: – type properties: id: type: string description: Identificador único do registro type: type: object allOf: – #/definitions/enumInformationItemData description: Tipo de deficiência startDate: type: string format: date description: Data de início isRehabilitated: type: boolean description: Reabilitado default: false isMainDisability: type: boolean description: Principal deficiência default: false disabilityDataComplete: description: DTO com os dados de deficiência type: object required: – hasDisability properties: id: type: string description: Identificador único do registro preAdmission: type: string description: Pré-admissão disabilityItem: type: array items: type: object allOf: – #/definitions/disabilityItemDataComplete description: Lista de deficiências do candidato hasDisability: type: boolean description: Identifica se a pessoa tem deficiência disabilityItemDataComplete: description: DTO com os dados dos itens de deficiência type: object required: – type properties: id: type: string description: Identificador único do registro type: type: object allOf: – #/definitions/enumInformationItemData description: Tipo de deficiência startDate: type: string format: date description: Data de início isRehabilitated: type: boolean description: Reabilitado default: false isMainDisability: type: boolean description: Principal deficiência default: false notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE