2.0info: 1.30.0 onboarding description: Serviço do onboarding x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: onboarding contact: name: Senior X Platform url: http://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: /onboarding/queries/enumInformation: post: description: Retorna uma lista com as enumerações traduzidas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nome das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com as enumerações traduzidas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nome das enumerações in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeEnumInformation: post: description: Retorna uma lista com as enumerações traduzidas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – names properties: names: type: array items: type: string minimum: 1 description: Nome das enumerações responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com as enumerações traduzidas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: names description: Nome das enumerações in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/enumInformationData minimum: 1 description: Lista com as enumerações traduzidas default: description: Error response schema: #/definitions/genericError /onboarding/queries/inviteModelFieldListQuery: post: description: Retorna a lista de campos do modelo de convite de acordo com o tipo e subtipo.\n Esta lista é retornada ordenada pela categoria do campo e a ordem de exibição na tela. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – country – fieldType – fieldSubType properties: inviteModelId: type: string description: Código do modelo de convite, caso convite já existente. country: type: string allOf: – #/definitions/inviteModelCountry description: País relacionado ao convite. fieldType: type: string allOf: – #/definitions/inviteFieldType description: Tipo do campo do modelo de convite. fieldSubType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo do modelo de convite. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteModelFieldListQueryData description: Lista dos campos de acordo com os parâmetros de entrada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/inviteModelLayoutQuery: post: description: Retorna as informações de leiaute de um modelo de convite.\n Caso o modelo não for informado, retorna um DTO vazio. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Código do modelo de convite, caso convite já existente. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteModelLayoutData description: Lista dos campos de acordo com os parâmetros de entrada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de leiaute de um modelo de convite.\n Caso o modelo não for informado, retorna um DTO vazio. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId description: Código do modelo de convite, caso convite já existente. in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteModelLayoutData description: Lista dos campos de acordo com os parâmetros de entrada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionCountByStatus: post: description: Retorna a quantidade de registros relacionado aos estados de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess properties: statusAll: type: string description: Filtros que indicam a quantidade total de pré-admissões. statusInProgress: type: string description: Filtros que indicam a quantidade de pré-admissões em andamento. statusInValidation: type: string description: Filtros que indicam a quantidade de pré-admissões em validação. statusComplete: type: string description: Filtros que indicam a quantidade de pré-admissões completadas. statusInHiringProcess: type: string description: Filtros que indicam a quantidade de pré-admissões em processo de admissão (Utilizado apenas quando integrado ao módulo Administração de Pessoal). contractFilter: type: object allOf: – #/definitions/contractFilterData description: Filtros para abrangência. responses: 200: description: Ok schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess properties: statusAll: type: integer format: int64 description: Quantidade total de pré-admissões. statusInProgress: type: integer format: int64 description: Quantidade de pré-admissões em andamento. statusInValidation: type: integer format: int64 description: Quantidade de pré-admissões em validação. statusComplete: type: integer format: int64 description: Quantidade de pré-admissões completadas. statusInHiringProcess: type: integer format: int64 description: Quantidade de pré-admissões em processo de admissão (Utilizado apenas quando integrado ao módulo Administração de Pessoal). 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionMessageQuery: post: description: Retorna os perfis da conversa e as mensagens desta. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – reader properties: preAdmissionId: type: string description: Código da pré admissão na qual a mensagem está referenciada. reader: type: string allOf: – #/definitions/messageSender description: Enum informando quem que está lendo as mensagens responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionMessageData description: Informações de mensagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/globalSettingsQuery: post: description: Retorna as configurações globais do módulo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: linkId: type: string description: Id da admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/globalSettingsData description: Informações globais do módulo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as configurações globais do módulo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: linkId description: Id da admissão in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/globalSettingsData description: Informações globais do módulo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/purchaseInfoQuery: post: description: Retorna as informações de teste/compra do produto. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/purchaseInfoData description: Informações de teste/compra do produto. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de teste/compra do produto. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/purchaseInfoData description: Informações de teste/compra do produto. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/purchaseInfoQueryEmployee: post: description: Retorna as informações de teste compra do produto para a etapa do employee tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/purchaseInfoData description: Informações de teste compra do produto. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de teste compra do produto para a etapa do employee tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/purchaseInfoData description: Informações de teste compra do produto. default: description: Error response schema: #/definitions/genericError /onboarding/queries/inviteModelContractQuery: post: description: Retorna as informações do contrato de um modelo de convite.\n Caso o modelo não for informado, retorna um DTO vazio. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Código do modelo de convite, caso o convite já existente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteModelContractQueryData description: Campos do contrato de acordo com o modelo de entrada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do contrato de um modelo de convite.\n Caso o modelo não for informado, retorna um DTO vazio. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId description: Código do modelo de convite, caso o convite já existente in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteModelContractQueryData description: Campos do contrato de acordo com o modelo de entrada. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/invitationLayoutConfigurationQuery: post: description: Retorna as informações da configuração do layout de um modelo de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão, no caso de reenvio de convite inviteModelId: type: string description: Id do modelo de convite responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/invitationLayoutConfigurationData description: Configurações e valores da tela de envio de convite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações da configuração do layout de um modelo de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Id da pré-admissão, no caso de reenvio de convite in: query type: string – name: inviteModelId description: Id do modelo de convite in: query type: string responses: 200: description: Ok schema: type: object properties: result: type: object allOf: – #/definitions/invitationLayoutConfigurationData description: Configurações e valores da tela de envio de convite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionQuery: post: description: Retorna as informações de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Dados da pré-admissão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Dados da pré-admissão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionDependentQuery: post: description: Retorna as informações de dependentes de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Identificador único do dependente. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentData description: Dados do dependente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de dependentes de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dependentId description: Identificador único do dependente. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentData description: Dados do dependente. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionListQuery: post: description: Retorna as informações básicas 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 page: type: integer format: int64 description: Indicativo da página atual. default: 0 orderby: type: string description: Ordenação a ser aplicada. filterQuery: type: string description: Filtro a ser aplicado na pesquisa. contractFilter: type: object allOf: – #/definitions/contractFilterData description: Filtros para abrangência. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/preAdmissionListData description: Relação dos países. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionDependentListQuery: post: description: Retorna uma lista com os dependentes de uma 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 page: type: integer format: int64 description: Indicativo da página atual. default: 0 filterQuery: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionDependentListData description: Lista de dependentes. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os dependentes de uma pré-admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: page description: Indicativo da página atual. in: query type: integer format: int64 – name: filterQuery description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionDependentListData description: Lista de dependentes. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/purchaseHistoryIsTrialEndOrCancel: post: description: Retorna se PurchaseActions é TRIAL_END ou CANCEL tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se EnumPurchaseActions é TRIAL_END ou CANCEL default: description: Error response schema: #/definitions/genericError get: description: Retorna se PurchaseActions é TRIAL_END ou CANCEL tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se EnumPurchaseActions é TRIAL_END ou CANCEL default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionCountByMonth: post: description: Retorna os dados para se montar o analytics das pré-admissões por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: monthPeriod: type: integer format: int64 description: Quantidade de meses para buscar default: 6 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionMonthData minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados para se montar o analytics das pré-admissões por mês tags: – Queries x-senior-visibility: PRIVATE parameters: – name: monthPeriod description: Quantidade de meses para buscar in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionMonthData minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionAnalyticsSituationQuery: post: description: Retorna os dados para se montar o analytics de situação das pré-admissões tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionAnalyticsSituationData minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados para se montar o analytics de situação das pré-admissões tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionAnalyticsSituationData minimum: 1 description: Retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/countryListQuery: post: description: Retorna as informações básicas do cadastro de país. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/country description: Relação dos países. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de país. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/country description: Relação dos países. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/stateListQuery: post: description: Retorna as informações básicas do cadastro de estado/unidades federativa. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/state description: Relação dos estados/unidades federativas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de estado/unidades federativa. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/state description: Relação dos estados/unidades federativas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/cityListQuery: post: description: Retorna as informações básicas do cadastro de cidade. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/city description: Relação das cidades. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de cidade. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/city description: Relação das cidades. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/nationalityListQuery: post: description: Retorna as informações básicas do cadastro de nacionalidade. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/nationality description: Relação das nacionalidades. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de nacionalidade. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/nationality description: Relação das nacionalidades. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/religionListQuery: post: description: Retorna as informações básicas do cadastro de religiã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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/religion description: Relação das religiões. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de religiã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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/religion description: Relação das religiões. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/bankListQuery: post: description: Retorna as informações básicas do cadastro de banco. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/bank description: Relação dos bancos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de banco. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/bank description: Relação dos bancos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/degreeOfEducationListQuery: post: description: Retorna as informações básicas do cadastro de grau de instruçã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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/degreeOfEducation description: Relação dos graus de instrução. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de grau de instruçã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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/degreeOfEducation description: Relação dos graus de instrução. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/companyListQuery: post: description: Retorna as informações do cadastro de empresas. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/company description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de empresas. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/company description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/getPreAdmissionEntities: post: description: Retorna a lista de entidades utilizada na pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Id da pré-admissão translated: type: boolean description: Se b true /b , retorna o label e o tooltip da customização traduzidos. default: false responses: 200: description: Ok schema: type: object required: – entities properties: entities: type: array items: type: object allOf: – #/definitions/entityDefList minimum: 1 description: Entidades utilizadas na pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de entidades utilizada na pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Id da pré-admissão in: query required: true type: string – name: translated description: Se b true /b , retorna o label e o tooltip da customização traduzidos. in: query type: boolean responses: 200: description: Ok schema: type: object required: – entities properties: entities: type: array items: type: object allOf: – #/definitions/entityDefList minimum: 1 description: Entidades utilizadas na pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionContractBraQuery: post: description: Retorna as informações do contrato de uma pré admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionContractBraData description: Informações do contrato da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do contrato de uma pré admissão. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionContractBraData description: Informações do contrato da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/branchOfficeListQuery: post: description: Retorna as informações do cadastro de filiais. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/branchOffice description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de filiais. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/branchOffice description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/jobPositionListQuery: post: description: Retorna as informações do cadastro de cargo. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/jobPosition description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de cargo. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/jobPosition description: Relação das empresas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/inviteModelInvitationLayoutQuery: post: description: Retorna as informações do leiaute da tela de envio de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Id do modelo de convite. responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/inviteModelInvitationLayoutData description: Informações do layout da tela de envio de convite. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do leiaute da tela de envio de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId description: Id do modelo de convite. in: query type: string responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/inviteModelInvitationLayoutData description: Informações do layout da tela de envio de convite. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/paramsForTracksaleQuery: post: description: Retorna as informações necessárias para o tracksale. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/paramsForTracksaleData description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações necessárias para o tracksale. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/paramsForTracksaleData description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/professionalAdviceListQuery: post: description: Retorna as informações do cadastro de conselho profissional. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/professionalAdvice description: Relação dos conselhos profissionais. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de conselho profissional. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/professionalAdvice description: Relação dos conselhos profissionais. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeInviteInfoQuery: post: description: Retorna as informações do layout da tela do colaborador. tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: object allOf: – #/definitions/inviteInfoData description: Dados do layout da tela do colaborador. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do layout da tela do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/inviteInfoData description: Dados do layout da tela do colaborador. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeePersonalQuery: post: description: Retorna todas as informações pessoais de uma pré-admissão na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Informações pessoais da pré-admissão. default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as informações pessoais de uma pré-admissão na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Informações pessoais da pré-admissão. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeDocumentQuery: post: description: Retorna todos os documentos de uma pré-admissão na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Documentos da pré-admissão. default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os documentos de uma pré-admissão na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionData description: Documentos da pré-admissão. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeDependentListQuery: post: description: Retorna uma lista com os dependentes de uma pré-admissão para a jornada do colaborador. 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 page: type: integer format: int64 description: Indicativo da página atual. default: 0 filterQuery: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionDependentListData description: Lista dos dependentes da pré-admissão default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os dependentes de uma pré-admissão para a jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Tamanho das páginas. in: query type: integer format: int64 – name: page description: Indicativo da página atual. in: query type: integer format: int64 – name: filterQuery description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionDependentListData description: Lista dos dependentes da pré-admissão default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeDependentQuery: post: description: Retorna as informações de dependentes de uma pré-admissão para a jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dependentId properties: dependentId: type: string description: Identificador único do dependente. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentData description: Dados do dependente. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de dependentes de uma pré-admissão para a jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dependentId description: Identificador único do dependente. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/dependentData description: Dados do dependente. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeInviteModelFieldQuery: post: description: Retorna os campos para montar layout tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: array items: type: object allOf: – #/definitions/inviteModelFieldData minimum: 1 description: Campos da pré-admissão default: description: Error response schema: #/definitions/genericError get: description: Retorna os campos para montar layout tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/inviteModelFieldData minimum: 1 description: Campos da pré-admissão default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCountryListQuery: post: description: Retorna as informações básicas do cadastro de país. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/country description: Relação dos países. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de país. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/country description: Relação dos países. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeStateListQuery: post: description: Retorna as informações básicas do cadastro de estado/unidades federativa. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/state description: Relação dos estados/unidades federativas. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de estado/unidades federativa. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/state description: Relação dos estados/unidades federativas. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCityListQuery: post: description: Retorna as informações básicas do cadastro de cidade. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/city description: Relação das cidades. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de cidade. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/city description: Relação das cidades. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeNationalityListQuery: post: description: Retorna as informações básicas do cadastro de nacionalidade. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/nationality description: Relação das nacionalidades. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de nacionalidade. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/nationality description: Relação das nacionalidades. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeReligionListQuery: post: description: Retorna as informações básicas do cadastro de religiã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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/religion description: Relação das religiões. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de religiã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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/religion description: Relação das religiões. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeBankListQuery: post: description: Retorna as informações básicas do cadastro de banco. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/bank description: Relação dos bancos. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de banco. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/bank description: Relação dos bancos. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeDegreeOfEducationListQuery: post: description: Retorna as informações básicas do cadastro de grau de instruçã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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/degreeOfEducation description: Relação dos graus de instrução. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de grau de instruçã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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/degreeOfEducation description: Relação dos graus de instrução. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCompanyListQuery: post: description: Retorna as informações básicas do cadastro de empresas do Payroll.\n Este endpoint foi concebido para ser utilizado apenas quando o Onboarding está integrado com o Payroll. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/company description: Relação das empresas. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do cadastro de empresas do Payroll.\n Este endpoint foi concebido para ser utilizado apenas quando o Onboarding está integrado com o Payroll. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/company description: Relação das empresas. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeProfessionalAdviceListQuery: post: description: Retorna as informações do cadastro de conselho profissional. 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 orderby: type: string description: Ordenação a ser aplicada. filter: type: string description: Filtro a ser aplicado na pesquisa. responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/professionalAdvice description: Relação dos conselhos profissionais. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de conselho profissional. 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: orderby description: Ordenação a ser aplicada. in: query type: string – name: filter description: Filtro a ser aplicado na pesquisa. in: query type: string responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. contents: type: array items: type: object allOf: – #/definitions/professionalAdvice description: Relação dos conselhos profissionais. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeePreAdmissionMessagesQuery: post: description: Retorna os perfis da conversa e as mensagens desta – visão do novo colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código da pré admissão na qual a mensagem está referenciada. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionMessageData description: Dados da troca de mensagem com o colaborador. default: description: Error response schema: #/definitions/genericError get: description: Retorna os perfis da conversa e as mensagens desta – visão do novo colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Código da pré admissão na qual a mensagem está referenciada. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/preAdmissionMessageData description: Dados da troca de mensagem com o colaborador. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCaptchaForSocialQualificationQuery: post: description: Retorna o captcha para o usuário preencher tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/captchaData description: Url do captcha default: description: Error response schema: #/definitions/genericError get: description: Retorna o captcha para o usuário preencher tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/captchaData description: Url do captcha default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeVerifySocialQualificationQuery: post: description: Retorna status de verificação do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – name – birthDate – cpf – pis – challengeField – captcha properties: preAdmissionId: type: string description: Código da pré admissão. name: type: string description: Nome do colaborador birthDate: type: string format: date description: Data de nascimento do colaborador cpf: type: string description: CPF do colaborador pis: type: string description: PIS do colaborador challengeField: type: string description: Chave do desafio captcha: type: string description: Captcha do desafio ignoreGovernmentQualification: type: boolean description: Quando o site do governo estiver indisponível, essa flag deverá ser true, assim irá ignorar a qualificação cadastral e\n permitirá a finalização do processo. default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/socialQualificationData description: Resultado da verificação da qualificação social default: description: Error response schema: #/definitions/genericError get: description: Retorna status de verificação do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Código da pré admissão. in: query required: true type: string – name: name description: Nome do colaborador in: query required: true type: string – name: birthDate description: Data de nascimento do colaborador in: query required: true type: string format: date – name: cpf description: CPF do colaborador in: query required: true type: string – name: pis description: PIS do colaborador in: query required: true type: string – name: challengeField description: Chave do desafio in: query required: true type: string – name: captcha description: Captcha do desafio in: query required: true type: string – name: ignoreGovernmentQualification description: Quando o site do governo estiver indisponível, essa flag deverá ser true, assim irá ignorar a qualificação cadastral e\n permitirá a finalização do processo. in: query type: boolean responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/socialQualificationData description: Resultado da verificação da qualificação social default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeSocialQualificationInfoQuery: post: description: Retorna informações da qualificação social tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: object allOf: – #/definitions/socialQualification description: Dados da qualificação social. default: description: Error response schema: #/definitions/genericError get: description: Retorna informações da qualificação social tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/socialQualification description: Dados da qualificação social. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeePreAdmissionEntitiesQuery: post: description: Retorna a lista de entidades utilizada na pré-admissão de forma anônima na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Id da pré-admissão translated: type: boolean description: Se b true /b , retorna o label e o tooltip da customização traduzidos. default: false responses: 200: description: Ok schema: type: object required: – entities properties: entities: type: array items: type: object allOf: – #/definitions/entityDefList minimum: 1 description: Entidades utilizadas na pré-admissão default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de entidades utilizada na pré-admissão de forma anônima na jornada do colaborador. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Id da pré-admissão in: query required: true type: string – name: translated description: Se b true /b , retorna o label e o tooltip da customização traduzidos. in: query type: boolean responses: 200: description: Ok schema: type: object required: – entities properties: entities: type: array items: type: object allOf: – #/definitions/entityDefList minimum: 1 description: Entidades utilizadas na pré-admissão default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeGlobalSettingsQuery: post: description: Retorna as configurações globais do módulo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: linkId: type: string description: Id da admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/globalSettingsData description: Configurações globais. default: description: Error response schema: #/definitions/genericError get: description: Retorna as configurações globais do módulo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: linkId description: Id da admissão in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/globalSettingsData description: Configurações globais. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeIsAValidPreAdmissionQuery: post: description: Retorna se o Id do link é uma pré-admissão válida. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – linkId properties: linkId: type: string description: Identificador único do convite responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Identifica se o Id é uma pré-admissão válida. default: description: Error response schema: #/definitions/genericError get: description: Retorna se o Id do link é uma pré-admissão válida. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: linkId description: Identificador único do convite in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Identifica se o Id é uma pré-admissão válida. default: description: Error response schema: #/definitions/genericError /onboarding/queries/autocompleteFilterCompany: post: description: Retorna as empresas utilizadas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as empresas utilizadas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/autocompleteFilterBranchOffice: post: description: Retorna as filiais utilizadas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as filiais utilizadas pelo campo de lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/autocompleteFilter minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/getAllURLFilesFromPreAdmissionId: post: description: Busca todas as URLs de imagens de uma pré admissão tags: – Queries x-senior-visibility: PRIVATE 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: – result properties: result: type: array items: type: object allOf: – #/definitions/rKeyValueData minimum: 1 description: Lista com todas as URLS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todas as URLs de imagens de uma pré admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/rKeyValueData minimum: 1 description: Lista com todas as URLS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeEntityQuery: post: description: Retorna uma entidade baseado no domínio, serviço e no id. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityId properties: entityId: type: object allOf: – #/definitions/entityIdDef description: Entity id translated: type: boolean description: Se b true /b , retorna o label e o tooltip da customização traduzidos. responses: 200: description: Ok schema: type: object properties: entity_: type: object allOf: – #/definitions/entityDef description: Entity definition. default: description: Error response schema: #/definitions/genericError /onboarding/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 /onboarding/queries/exportCountryField: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportInviteModel: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportInviteModelLayout: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportInviteModelField: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportInviteModelContract: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmission: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmissionMessage: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmissionDocumentBRA: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCtps: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCpf: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPis: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportRg: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportVoter: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCnh: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportReservist: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportDnv: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCns: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCivilCertificate: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPassport: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportRic: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportHiringMedicalExam: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportBankAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportValidationData: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportBank: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCity: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportState: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportCountry: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportReligion: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportNationality: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportDegreeOfEducation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmissionPersonalBRA: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalBasic: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalComplementary: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalBirthPlace: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalAddressBRA: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalTelephone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPersonalEmail: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportSocialQualification: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportSus: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportVaccinationBooklet: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportProofOfEnrollment: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportDependentBasic: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportDependentDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmissionDependentBra: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPurchaseHistory: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportAddressBra: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportExternalModules: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportPreAdmissionContractBra: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportBranchOffice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportJobPosition: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportInviteModelInvitationLayout: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportProfessionalAdvice: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportProfessionalRecord: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /onboarding/actions/inviteModelSave: post: description: Salva o modelo de convite completo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inviteModel properties: inviteModel: type: object allOf: – #/definitions/inviteModelData description: Entidade inviteModel. 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 /onboarding/actions/inviteModelDelete: post: description: Exclui o modelo de convite caso este não esteja vinculado a nenhuma pre-admissão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Id do 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 /onboarding/actions/preAdmissionSendSms: post: description: Envio do SMS para uma lista de colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: array items: type: string minimum: 1 description: Id do futuro colaborador 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 /onboarding/actions/preAdmissionSaveHeader: post: description: Salva uma lista de novos colaboradores e faz o envio dos convites. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionSaveData properties: preAdmissionSaveData: type: array items: type: object allOf: – #/definitions/preAdmissionSaveData minimum: 1 description: Lista de colaboradores que serão enviado os convites responses: 200: description: Ok schema: type: object required: – result – listWithError – employeesWithSuccess – messageFromSmartphoneData properties: result: type: boolean description: Resultado da action listWithError: type: array items: type: object allOf: – #/definitions/preAdmissionSaveData minimum: 1 description: Lista de colaboradores malsucedidos employeesWithSuccess: type: integer format: int64 description: Quantidade de colaboradores bem-sucedidos messageFromSmartphoneData: type: array items: type: object allOf: – #/definitions/messageFromSmartphoneData minimum: 1 description: Mensagem de boas vindas para celular (WhatsApp) preAdmissionData: type: string description: Dados da preAdmissao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionResend: post: description: Reenvia o convite para um colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: object allOf: – #/definitions/preAdmissionSaveData description: Colaborador que será reenviado responses: 200: description: Ok schema: type: object required: – result – messageFromSmartphoneData properties: result: type: boolean description: Resultado da action message: type: string description: Mensagem de retorno messageFromSmartphoneData: type: object allOf: – #/definitions/messageFromSmartphoneData description: Mensagem de boas vindas para celular (WhatsApp) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/blobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. thumbnail: type: boolean description: Condicional se será salvo um thumbnail. default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestUploadData description: Retorno do upload de um arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/blobServiceCommit: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto, e que deve ser criada a foto e seu Thumbnail(128X128px). default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno do commit de um arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/blobServiceRequestAccess: post: description: Solicitação para acessar um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos). default: 30 thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px). default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestAccessData description: Retorno do acesso do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/blobServiceDelete: post: description: Solicitação para apagar um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser apagado seu Thumbnail(128X128px). default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Retorno de delete do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/changeInviteModelStatus: post: description: Ação para modificar o status do modelo de convite. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inviteModelId properties: inviteModelId: type: string description: Código do modelo de convite status: type: string allOf: – #/definitions/situation description: Situação desejada para o convite. caso nulo será trocada para a opção contraria (ativo/inativo) 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 /onboarding/actions/preAdmissionMessageSend: post: description: Ação para adicionar mensagens na conversa. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – message – sender properties: preAdmissionId: type: string description: Código da pré admissão message: type: string description: Mensagem a ser enviada sender: type: string allOf: – #/definitions/messageSender description: Quem enviou a mensagem 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 /onboarding/actions/preAdmissionSendEmail: post: description: Ação para enviar o e-mail ao colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código da pré admissão 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 /onboarding/actions/preAdmissionSave: post: description: Ação para salvar as informações de uma pré-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – document – personalData – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados do documento. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Dados do contrato. hasDependent: type: boolean description: Identifica se existem dependentes. default: true saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionSaveAndFinish: post: description: Ação para salvar e finalizar uma pré-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – document – personalData – contract – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados do documento. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Dados do contrato. hasDependent: type: boolean description: Identifica se existem dependentes. default: true saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionExpire: post: description: Ação para expirar uma pré-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da expiração. message: type: string description: Mensagem detalhando o resultado da expiração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionFinish: post: description: Ação para trocar status de uma pré-admissão para FINISHED_ADMISSION. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da finalização. message: type: string description: Mensagem detalhando o resultado da finalização 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionPending: post: description: Ação para trocar status de uma pré-admissão para PENDING_ADMISSION. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único da pré-admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado de tornar pendente. message: type: string description: Mensagem detalhando o resultado de tornar pendente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/dependentSave: post: description: Ação para salvar as informações de um dependente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – basic – document – saveAsDraft properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. basic: type: object allOf: – #/definitions/dependentBasicData description: Dados básicos. document: type: object allOf: – #/definitions/dependentDocumentData description: Dados dos documentos. validation: type: object allOf: – #/definitions/validationData description: Dados de validação. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da gravação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/dependentDelete: post: description: Ação para excluir um dependente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: dependentId: type: string description: Identificador único do dependente. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da exclusão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/searchAddress: post: description: Ação para obter informações do cep e caso não exista, inserir na base tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cep properties: cep: type: string description: Cep do logradouro responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/personalAddressBRAData description: Informações do cep pesquisado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/extendTrial: post: description: Ação para efetuar a prorrogação do período de trial do produto. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reason properties: reason: type: string maxLength: 255 description: Motivo da prorrogação do período de trial. 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 /onboarding/actions/companyDelete: post: description: Exclui a empresa caso esta não esteja vinculada a nenhuma pre-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da empresa 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 /onboarding/actions/branchOfficeDelete: post: description: Exclui a filial caso esta não esteja vinculada a nenhuma pre-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da filial 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 /onboarding/actions/changeBranchOfficeStatus: post: description: Ativa ou inativa a filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchOfficeId properties: branchOfficeId: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/situation description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/jobPositionDelete: post: description: Exclui o cargo caso não esteja vinculado a nenhuma pre-admissão. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do cargo 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 /onboarding/actions/changeJobPositionStatus: post: description: Ativa ou inativa o cargo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do cargo responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/situation description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/changeCompanyStatus: post: description: Ativa ou inativa a empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/situation description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/professionalAdviceDelete: post: description: Exclui o conselho profissional caso não esteja vinculado a nenhum registro profissional. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do conselho profissional 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 /onboarding/actions/changeProfessionalAdviceStatus: post: description: Ativa ou inativa o conselho profissional tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – professionalAdviceId properties: professionalAdviceId: type: string description: Id do conselho profissional responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/situation description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeePersonalSave: post: description: Ação para salvar as informações pessoais de uma pré-admissão na jornada do colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personalData – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeDocumentSave: post: description: Ação para salvar os documentos de uma pré-admissão na jornada do colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – documentData – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeDependentSave: post: description: Ação para salvar se uma pré-admissão tem dependentes vinculados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – hasDependent properties: preAdmissionId: type: string description: Identificador único da pré-admissão. hasDependent: type: boolean description: Identifica se existem dependentes. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeSave: post: description: Ação para salvar as informações pessoais e documentos de uma pré-admissão na jornada do colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personalData – documentData – hasDependent – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeePreAdmissionDependentSave: post: description: Ação para salvar as informações de um dependente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – basic – document – saveAsDraft properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. basic: type: object allOf: – #/definitions/dependentBasicData description: Dados básicos. document: type: object allOf: – #/definitions/dependentDocumentData description: Dados dos documentos. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeSaveAndSubmit: post: description: Ação que salva as informações pessoais e documentos de uma pré-admissão e envia para validação na jornada do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personalData – documentData – saveAsDraft – hasDependent properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. hasDependent: type: boolean description: Identifica se possui dependente responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da gravação e informações da pré-admissão atualizadas default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeePreAdmissionSendMessage: post: description: Ação para enviar a mensagem ao analista de RH na jornada do colaborador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – message properties: preAdmissionId: type: string description: Código da pré admissão message: type: string description: Mensagem a ser enviada responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeDependentDelete: post: description: Ação para excluir um dependente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pre-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionSaveData description: Resultado da exclusão. default: description: Error response schema: #/definitions/genericError /onboarding/actions/purchaseHistorySave: post: description: Ação para ajustar o histórico de teste/compra do produto. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – purchaseAction properties: id: type: string description: Identificador único do registro. purchaseAction: type: string allOf: – #/definitions/enumPurchaseActions description: Ação do teste/compra. purchaseDate: type: string format: date-time description: Data do teste/compra. reason: type: string maxLength: 255 description: Motivo da alteração do teste/compra. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da ação de ajuste. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeSearchAddress: post: description: Ação para buscar o cep informado na base do onboarding e cadastrar caso não o tenha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cep properties: cep: type: string description: Cep do logradouro responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/personalAddressBRAData description: Informações do cep pesquisado default: description: Error response schema: #/definitions/genericError /onboarding/actions/externalModulesSave: post: description: Ação para salvar/alterar um novo registro na entidade ExternalModules tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – enumExternalModule properties: id: type: string description: Identificador único enumExternalModule: type: string allOf: – #/definitions/enumExternalModules description: Módulo a ser integrado responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /onboarding/actions/externalModulesDelete: post: description: Ação para remover um registro na entidade ExternalModules tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – enumExternalModule properties: enumExternalModule: type: string allOf: – #/definitions/enumExternalModules description: Módulo a ser removido responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeSocialQualificationSave: post: description: Ação para salvar a qualificação cadastral quando o site do governo estiver indisponível. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Código da pré admissão. responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da action default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeBlobServiceRequestUpload: post: description: Solicitação para realizar o upload de um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. thumbnail: type: boolean description: Condicional se será salvo um thumbnail. default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestUploadData description: Retorno do upload de um arquivo. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeBlobServiceRequestAccess: post: description: Solicitação para acessar um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). ttl: type: integer format: int64 description: Tempo em minutos que o arquivo deve ficar disponível para download no link que será retornado (padrão 30 minutos). default: 30 thumbnail: type: boolean description: Se for verdadeiro, entende que o arquivo é uma foto e que deve ser retornado seu Thumbnail(128X128px). default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/blobServiceRequestAccessData description: Retorno do acesso do arquivo. default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeRequestUploadFromCustomFields: post: description: Solicita a importação de um arquivo dos campos customizados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service – entityName – field – fileName properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço entityName: type: string description: Nome da entidade field: type: string description: Nome do campo fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – location – version – objectId properties: location: type: string description: URL para upload do arquivo type: string description: Versão objectId: type: string description: Id de identificação do objeto default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeRequestAccessFromCustomFields: post: description: Solicitação para acessar um arquivo dos campos customizados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objectId properties: objectId: type: string description: Identificador para retornar a url do arquivo seguindo o padrão – objectId/fileName responses: 200: description: Ok schema: type: object required: – fileName – uri properties: fileName: type: string description: Nome do arquivo uri: type: string description: Url do arquivo default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeCommitObjectFromCustomFields: post: description: Commita uma lista de arquivos (blob) dos campos customizados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – objects properties: objects: type: array items: type: object allOf: – #/definitions/commitObjectDef minimum: 1 description: Lista de objetos para fazer o commit responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeDeleteObjectsFromCustomFields: post: description: Deleta uma lista de arquivos (blob) dos campos customizados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service – objects – entityName properties: domain: type: string description: Domínio do serviço service: type: string description: Nome do serviço objects: type: array items: type: object allOf: – #/definitions/deleteObjectDef minimum: 1 description: Lista de objetos para deletar entityName: type: string description: Nome da entidade responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /onboarding/actions/startDigitalTrial: post: description: Ação responsável por iniciar um período de trial do Onboarding a partir do digital tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – request properties: request: type: object allOf: – #/definitions/digitalTrialData description: Informações do formulário de trial. responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação de início de trial. default: description: Error response schema: #/definitions/genericError /onboarding/actions/startDigitalTrialRD: post: description: Ação responsável por iniciar um período de trial do Onboarding a partir do RD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – leads properties: leads: type: array items: type: object allOf: – #/definitions/rRDData minimum: 1 description: Dados vindo da integração com o RD responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação de início de trial. default: description: Error response schema: #/definitions/genericError /onboarding/actions/setUpOnboarding: post: description: Realiza as configurações de um tenant existente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – username properties: tenant: type: string description: Tenant que será configurado. username: type: string description: Usuário existente que terá o papel do Onboarding vinculado. companyName: type: string description: Nome da empresa que será criada caso não exista nenhuma cadastrada. enumExternalModule: type: string allOf: – #/definitions/enumExternalModules description: Caso tiver algum módulo externo, informá-lo de acordo com a enumeração. isPurchase: type: boolean description: Indica se o produto foi adquirido. default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação de configuração do tenant. default: description: Error response schema: #/definitions/genericError /onboarding/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCountryField: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importInviteModel: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importInviteModelLayout: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importInviteModelField: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importInviteModelContract: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmission: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmissionMessage: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmissionDocumentBRA: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCtps: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCpf: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPis: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importRg: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importVoter: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCnh: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importReservist: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importDnv: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCns: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCivilCertificate: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPassport: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importRic: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importHiringMedicalExam: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importBankAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importValidationData: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importBank: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCity: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importState: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importCountry: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importReligion: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importNationality: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importDegreeOfEducation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmissionPersonalBRA: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalBasic: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalComplementary: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalBirthPlace: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalAddressBRA: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalTelephone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPersonalEmail: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importSocialQualification: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importSus: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importVaccinationBooklet: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importProofOfEnrollment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importDependentBasic: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importDependentDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmissionDependentBra: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPurchaseHistory: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importAddressBra: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importExternalModules: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importPreAdmissionContractBra: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importBranchOffice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importJobPosition: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importInviteModelInvitationLayout: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importProfessionalAdvice: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importProfessionalRecord: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/signals/verifyExpiredPreAdmissions: post: description: Expira os convites que a data de validade é menor que hoje e o status é diferente de finalizado, expirado e em validação tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/verifyTrialEndSituation: post: description: Verifica a situação do trial para o tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/lgpdSyncField: post: description: Sincroniza os campos para atender a LGPD tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/entities/countryField: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/countryField responses: 200: description: The created resource schema: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/countryField responses: 200: description: The created resource schema: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/countryField/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: Ok schema: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/countryField responses: 200: description: Ok schema: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/countryField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/countryField/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/countryField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/company: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/company/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/company/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModel: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModel responses: 200: description: The created resource schema: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModel responses: 200: description: The created resource schema: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModel/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: Ok schema: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModel responses: 200: description: Ok schema: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModel/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayout: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelLayout responses: 200: description: The created resource schema: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelLayout responses: 200: description: The created resource schema: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayout/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: Ok schema: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelLayout responses: 200: description: Ok schema: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayout/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelLayout responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelField: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelField responses: 200: description: The created resource schema: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelField responses: 200: description: The created resource schema: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelField/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: Ok schema: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelField responses: 200: description: Ok schema: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelField/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelContract: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelContract responses: 200: description: The created resource schema: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelContract responses: 200: description: The created resource schema: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelContract/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: Ok schema: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelContract responses: 200: description: Ok schema: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelContract/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelContract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmission: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmission responses: 200: description: The created resource schema: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmission responses: 200: description: The created resource schema: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmission/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: Ok schema: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmission responses: 200: description: Ok schema: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmission/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionMessage: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionMessage responses: 200: description: The created resource schema: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionMessage responses: 200: description: The created resource schema: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionMessage/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: Ok schema: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionMessage responses: 200: description: Ok schema: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionMessage 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionMessage/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionMessage responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDocumentBRA: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDocumentBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDocumentBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDocumentBRA/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDocumentBRA responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDocumentBRA/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDocumentBRA responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ctps: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ctps responses: 200: description: The created resource schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ctps responses: 200: description: The created resource schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ctps/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: Ok schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ctps responses: 200: description: Ok schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ctps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ctps/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ctps responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cpf: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cpf responses: 200: description: The created resource schema: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cpf responses: 200: description: The created resource schema: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cpf/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: Ok schema: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cpf responses: 200: description: Ok schema: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cpf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cpf/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cpf responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/pis: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pis responses: 200: description: The created resource schema: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/pis responses: 200: description: The created resource schema: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/pis/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: Ok schema: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pis responses: 200: description: Ok schema: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/pis/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pis responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/rg: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rg responses: 200: description: The created resource schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rg responses: 200: description: The created resource schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/rg/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: Ok schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rg responses: 200: description: Ok schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/rg/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rg responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/voter: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/voter responses: 200: description: The created resource schema: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/voter responses: 200: description: The created resource schema: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/voter/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: Ok schema: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/voter responses: 200: description: Ok schema: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/voter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/voter/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/voter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cnh: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cnh responses: 200: description: The created resource schema: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cnh responses: 200: description: The created resource schema: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cnh/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: Ok schema: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cnh responses: 200: description: Ok schema: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cnh 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cnh/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cnh responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/reservist: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reservist responses: 200: description: The created resource schema: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/reservist responses: 200: description: The created resource schema: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/reservist/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: Ok schema: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reservist responses: 200: description: Ok schema: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reservist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/reservist/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/reservist responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dnv: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dnv responses: 200: description: The created resource schema: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dnv responses: 200: description: The created resource schema: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dnv/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: Ok schema: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dnv responses: 200: description: Ok schema: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dnv 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dnv/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dnv responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cns: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cns responses: 200: description: The created resource schema: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cns responses: 200: description: The created resource schema: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cns/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: Ok schema: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cns responses: 200: description: Ok schema: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/cns/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cns responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/civilCertificate: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/civilCertificate responses: 200: description: The created resource schema: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/civilCertificate responses: 200: description: The created resource schema: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/civilCertificate/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: Ok schema: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/civilCertificate responses: 200: description: Ok schema: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/civilCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/civilCertificate/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/civilCertificate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/passport: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/passport responses: 200: description: The created resource schema: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/passport responses: 200: description: The created resource schema: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/passport/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: Ok schema: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/passport responses: 200: description: Ok schema: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/passport 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/passport/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/passport responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ric: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ric responses: 200: description: The created resource schema: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ric responses: 200: description: The created resource schema: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ric/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: Ok schema: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ric responses: 200: description: Ok schema: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ric 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ric/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ric responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/hiringMedicalExam: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hiringMedicalExam responses: 200: description: The created resource schema: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/hiringMedicalExam responses: 200: description: The created resource schema: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/hiringMedicalExam/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: Ok schema: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/hiringMedicalExam responses: 200: description: Ok schema: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/hiringMedicalExam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/hiringMedicalExam/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/hiringMedicalExam responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bankAccount: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bankAccount responses: 200: description: The created resource schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bankAccount/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bankAccount responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bankAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bankAccount/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bankAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/validationData: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validationData responses: 200: description: The created resource schema: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/validationData responses: 200: description: The created resource schema: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/validationData/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: Ok schema: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/validationData responses: 200: description: Ok schema: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/validationData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/validationData/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/validationData responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bank: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bank responses: 200: description: The created resource schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bank/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/bank responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/bank 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/bank/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bank responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/city: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/city responses: 200: description: The created resource schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/city responses: 200: description: The created resource schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/city/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/city responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/city 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/city/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/city responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/state: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/state responses: 200: description: The created resource schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/state responses: 200: description: The created resource schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/state/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/state responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/state 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/state/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/state responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/country: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/country/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/country/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/religion: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/religion responses: 200: description: The created resource schema: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/religion responses: 200: description: The created resource schema: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/religion/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: Ok schema: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/religion responses: 200: description: Ok schema: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/religion 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/religion/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/religion responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/nationality: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/nationality responses: 200: description: The created resource schema: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/nationality/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nationality responses: 200: description: Ok schema: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/nationality 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/nationality/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/nationality responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/degreeOfEducation: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/degreeOfEducation responses: 200: description: The created resource schema: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/degreeOfEducation responses: 200: description: The created resource schema: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/degreeOfEducation/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: Ok schema: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/degreeOfEducation responses: 200: description: Ok schema: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/degreeOfEducation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/degreeOfEducation/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/degreeOfEducation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionPersonalBRA: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionPersonalBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionPersonalBRA responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionPersonalBRA/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionPersonalBRA responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionPersonalBRA/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionPersonalBRA responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBasic: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBasic responses: 200: description: The created resource schema: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBasic responses: 200: description: The created resource schema: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBasic/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: Ok schema: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasic responses: 200: description: Ok schema: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBasic/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalBasic responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalComplementary: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalComplementary responses: 200: description: The created resource schema: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalComplementary responses: 200: description: The created resource schema: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalComplementary/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: Ok schema: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementary responses: 200: description: Ok schema: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalComplementary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalComplementary/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalComplementary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBirthPlace: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBirthPlace responses: 200: description: The created resource schema: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBirthPlace responses: 200: description: The created resource schema: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBirthPlace/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: Ok schema: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBirthPlace responses: 200: description: Ok schema: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalBirthPlace 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBirthPlace/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalBirthPlace responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalAddressBRA: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalAddressBRA responses: 200: description: The created resource schema: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalAddressBRA responses: 200: description: The created resource schema: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalAddressBRA/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: Ok schema: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressBRA responses: 200: description: Ok schema: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalAddressBRA 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalAddressBRA/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalAddressBRA responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalTelephone: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalTelephone responses: 200: description: The created resource schema: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalTelephone responses: 200: description: The created resource schema: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalTelephone/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: Ok schema: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalTelephone responses: 200: description: Ok schema: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalTelephone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalTelephone/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalTelephone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalEmail: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalEmail responses: 200: description: The created resource schema: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalEmail responses: 200: description: The created resource schema: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalEmail/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: Ok schema: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmail responses: 200: description: Ok schema: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalEmail/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalEmail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/socialQualification: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/socialQualification responses: 200: description: The created resource schema: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/socialQualification responses: 200: description: The created resource schema: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/socialQualification/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: Ok schema: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/socialQualification responses: 200: description: Ok schema: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/socialQualification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/socialQualification/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/socialQualification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/sus: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sus responses: 200: description: The created resource schema: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/sus responses: 200: description: The created resource schema: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/sus/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: Ok schema: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/sus responses: 200: description: Ok schema: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/sus/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/vaccinationBooklet: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vaccinationBooklet responses: 200: description: The created resource schema: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vaccinationBooklet responses: 200: description: The created resource schema: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/vaccinationBooklet/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: Ok schema: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vaccinationBooklet responses: 200: description: Ok schema: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vaccinationBooklet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/vaccinationBooklet/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vaccinationBooklet responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/proofOfEnrollment: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/proofOfEnrollment responses: 200: description: The created resource schema: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/proofOfEnrollment responses: 200: description: The created resource schema: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/proofOfEnrollment/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: Ok schema: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/proofOfEnrollment responses: 200: description: Ok schema: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/proofOfEnrollment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/proofOfEnrollment/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/proofOfEnrollment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentBasic: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentBasic responses: 200: description: The created resource schema: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentBasic responses: 200: description: The created resource schema: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentBasic/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: Ok schema: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasic responses: 200: description: Ok schema: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentBasic 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentBasic/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentBasic responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentDocument responses: 200: description: The created resource schema: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentDocument responses: 200: description: The created resource schema: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: Ok schema: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentDocument responses: 200: description: Ok schema: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDependentBra: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDependentBra responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDependentBra responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDependentBra/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionDependentBra responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionDependentBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDependentBra/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDependentBra responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/purchaseHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/purchaseHistory responses: 200: description: The created resource schema: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/purchaseHistory responses: 200: description: The created resource schema: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/purchaseHistory/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: Ok schema: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/purchaseHistory responses: 200: description: Ok schema: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/purchaseHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/purchaseHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/purchaseHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/addressBra: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/addressBra responses: 200: description: The created resource schema: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/addressBra responses: 200: description: The created resource schema: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/addressBra/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: Ok schema: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/addressBra responses: 200: description: Ok schema: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/addressBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/addressBra/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/addressBra responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/externalModules: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/externalModules responses: 200: description: The created resource schema: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/externalModules responses: 200: description: The created resource schema: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/externalModules/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: Ok schema: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalModules responses: 200: description: Ok schema: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/externalModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/externalModules/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/externalModules responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionContractBra: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionContractBra responses: 200: description: The created resource schema: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionContractBra responses: 200: description: The created resource schema: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionContractBra/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preAdmissionContractBra responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preAdmissionContractBra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionContractBra/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionContractBra responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/branchOffice: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchOffice responses: 200: description: The created resource schema: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branchOffice responses: 200: description: The created resource schema: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/branchOffice/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: Ok schema: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branchOffice responses: 200: description: Ok schema: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branchOffice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/branchOffice/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/branchOffice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/jobPosition: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/jobPosition responses: 200: description: The created resource schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/jobPosition/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/jobPosition responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/jobPosition/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/jobPosition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelInvitationLayout: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelInvitationLayout responses: 200: description: The created resource schema: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelInvitationLayout responses: 200: description: The created resource schema: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelInvitationLayout/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/inviteModelInvitationLayout responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/inviteModelInvitationLayout 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelInvitationLayout/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelInvitationLayout responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalAdvice: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalAdvice responses: 200: description: The created resource schema: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalAdvice responses: 200: description: The created resource schema: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalAdvice/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: Ok schema: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalAdvice responses: 200: description: Ok schema: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalAdvice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalAdvice/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/professionalAdvice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalRecord: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalRecord responses: 200: description: The created resource schema: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalRecord responses: 200: description: The created resource schema: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalRecord/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: Ok schema: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecord responses: 200: description: Ok schema: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalRecord/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/professionalRecord responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: inviteModelCountry: description: Países suportados no cadastro de modelos. type: string enum: – BRAZIL heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN inviteFieldType: description: Tipos de campos que serão aceitos no convite. type: string enum: – EMPLOYEE inviteFieldSubType: description: Sub-tipos de campos que serão aceitos no convite. type: string enum: – PERSONAL_DATA – DOCUMENT – DEPENDENT – COMPLEMENTARY – SOCIAL_QUALIFICATION – PATTERN categoryField: description: Categorias relacionadas ao campo. type: string enum: – BASIC – COMPLEMENTARY – PLACE_OF_BIRTH – ADDRESS – PHONES – EMAILS – DOCUMENT – INVITATION_LAYOUT – SOCIAL_QUALIFICATION – PATTERN valueType: description: Tipos de valores possíveis para um campo no convite. type: string enum: – FULL_NAME – PREFERRED_NAME – BADGE_PHOTO – GENDER – BIRTH_DATE – MOTHER_NAME – FATHER_NAME – MARITAL_STATUS – DEGREE_OF_EDUCATION – NATIONALITY – RELIGION – RACE – SOCIAL_NAME – COUNTRY – STATE – CITY – FIRST_PHONE – SECOND_PHONE – FIRST_EMAIL – SECOND_EMAIL – ADDRESS – BANKINFO – RECEIVE_SALARY_ADVANCE – CTPS – CPF – PIS – RG – VOTER_CARD – CNH – RESERVIST – DNV – CNS – CIVIL_CERTIFICATE – PASSPORT – CIVILIAN_IDENTITY_REGISTRY – HIRING_MEDICAL_EXAM – PROFESSIONAL_RECORD – DEPENDENT_FULL_NAME – DEPENDENT_DEGREE_OF_KINSHIP – DEPENDENT_GENDER – DEPENDENT_BIRTH_DATE – DEPENDENT_DECLARE_INCOME_TAX – DEPENDENT_MOTHER_NAME – DEPENDENT_MARITAL_STATUS – DEPENDENT_CPF – DEPENDENT_RG – DEPENDENT_RIC – DEPENDENT_SUS_CARD – DEPENDENT_VACCINATION_BOOKLET – DEPENDENT_PROOF_OF_ENROLLMENT – DEPENDENT_DEATH_CERTIFICATE – DEPENDENT_BIRTH_CERTIFICATE – SOCIAL_QUALIFICATION – PATTERN_UPPERCASE – PATTERN_SPECIAL_CHARACTER situation: description: Situação do cadastro de modelos de convite. type: string enum: – ACTIVE – INACTIVE messageSender: description: Tipos de remetente das mensagens. type: string enum: – EMPLOYEE – COMPANY eSocialStatus: description: Status do eSocial. type: string enum: – VERIFIED – NOT_VERIFIED searchType: description: Definição do tipo de pesquisa utilizada para obter a lista de pré-admissões. type: string enum: – IN_PROGRESS – COMPLETED – ALL invitationStatus: description: Definição dos statuses que um convite pode assumir. type: string enum: – UNREAD – READ – EXPIRED – IN_VALIDATION – FINISHED – PENDING_ADMISSION – STARTED_ADMISSION – FINISHED_ADMISSION eSocialCategory: description: Categoria do eSocial. type: string enum: – CATEGORY_101 – CATEGORY_102 – CATEGORY_103 – CATEGORY_104 – CATEGORY_105 – CATEGORY_106 – CATEGORY_111 – CATEGORY_201 – CATEGORY_202 – CATEGORY_301 – CATEGORY_302 – CATEGORY_303 – CATEGORY_305 – CATEGORY_306 – CATEGORY_307 – CATEGORY_308 – CATEGORY_309 – CATEGORY_401 – CATEGORY_410 – CATEGORY_701 – CATEGORY_711 – CATEGORY_712 – CATEGORY_721 – CATEGORY_722 – CATEGORY_723 – CATEGORY_731 – CATEGORY_734 – CATEGORY_738 – CATEGORY_741 – CATEGORY_751 – CATEGORY_761 – CATEGORY_771 – CATEGORY_781 – CATEGORY_901 – CATEGORY_902 – CATEGORY_903 – CATEGORY_904 – CATEGORY_905 – CATEGORY_997 – CATEGORY_998 – CATEGORY_999 unemploymentInsuranceType: description: Tipo do seguro desemprego. type: string enum: – NOT_CONSULTED – NOT_RECEIVING – IS_RECEIVING sefipCategoryType: description: Categoria SEFIP. type: string enum: – TYPE_01 – TYPE_02 – TYPE_03 – TYPE_04 – TYPE_05 – TYPE_06 – TYPE_07 – TYPE_11 – TYPE_12 – TYPE_13 – TYPE_14 – TYPE_15 – TYPE_16 – TYPE_17 – TYPE_18 – TYPE_19 – TYPE_20 – TYPE_21 – TYPE_22 – TYPE_23 – TYPE_24 – TYPE_25 – TYPE_26 – TYPE_99 employeeContractType: description: Tipo de contrato type: string enum: – EMPLOYEE – MANAGER – FARM_WORKER – RETIRED – TRAINEE – APPRENTICE – FIXED_DUE_DATE – RETIRED_MANAGER – PUBLIC_AGENT – TEACHER – COOPERATIVE_WORKER – DOMESTIC_WORKER – TEACHER_FIXED_DUE_DATE employeeType: description: Tipo do colaborador. type: string enum: – EMPLOYEE – THIRD – PARTNER raisType: description: RAIS. type: string enum: – TYPE_10 – TYPE_15 – TYPE_20 – TYPE_25 – TYPE_30 – TYPE_31 – TYPE_35 – TYPE_40 – TYPE_49 – TYPE_50 – TYPE_55 – TYPE_60 – TYPE_65 – TYPE_70 – TYPE_75 – TYPE_80 – TYPE_90 – TYPE_95 – TYPE_96 – TYPE_97 enumAccountType: description: Tipos de contas bancárias. type: string enum: – CURRENT_ACCOUNT – SAVINGS_ACCOUNT – SALARY_ACCOUNT – OTHER enumDriverLicenceCategory: description: Categorias de carteira de habilitação. type: string enum: – A – B – C – D – E – AB – AC – AD – AE enumCivilCertificate: description: Tipo de certidão civil. type: string enum: – BIRTH_CERTIFICATE – MARRIAGE_CERTIFICATE – INDIGENOUS_PERSONS_BIRTH_CERTIFICATE – DEATH_CERTIFICATE enumEmail: description: Tipo de e-mail – Detalhes da pré-admissão. type: string enum: – PERSONAL_EMAIL – PROFESSIONAL_EMAIL 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 enumGender: description: Gênero da pessoa. type: string enum: – MALE – FEMALE enumMaritalStatus: description: Estado civil. type: string enum: – SINGLE – MARRIED – DIVORCED – WIDOWER – CONCUBINAGE – SEPARATED – STABLEUNION – OTHERS enumRacialType: description: Tipo de raça. type: string enum: – WHITE – BLACK – BROWN – YELLOW – INDIGENOUS – NOT_INFORMED 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 enumAddressType: description: Tipo de endereço. type: string enum: – OTHERS – AIRPORT – LANE – AREA – AVENUE – BALNEARY – BLOCK – FIELD – FARMSTEAD – COLOGNE – CONDOMINIUM – SET – DISTRICT – TERRACE – SEASON – ROAD – SHANTYTOWN – FARM – MARKET – GALLERY – GRANJA – GARDEN – SLOPE – LAKE – LAGOON – LONG – ALLOTMENT – HILL – CORE – PARK – FOOTBRIDGE – COURTYARD – SQUARE – BEACH – COURT – NOOK – RESIDENTIAL – HIGHWAY – STREET – SECTOR – SITE – BYSTREET – EXCERPT – CLOVER – VALLEY – PATH – VIA – VIADUCT – ALLEY – VILLAGE – ACCESS – CAMP – LOCAL_ACCESS – CHURCHYARD – SPECIAL_AREA – RIGHT_MARGINAL_AVENUE – LEFT_MARGINAL_AVENUE – RING_ROAD – LATER_ROAD_BETWEEN – ARTERY – HIGH – SHORTCUT – GREEN_AREA – CONTOUR_AVENUE – MARGINAL_AVENUE – OLD_AVENUE – ALLEYWAY – HOLE – BELVEDERE – BALLOON – BLOCKS – BULEVAR – FOREST – BOULEVARD – LOW – PIER – SIDEWALK – WAY – CHANNEL – CHAPADAO – BICYCLE_PATH – CIRCULAR_ROAD – HOUSING_COMPLEX – ROAD_COMPLEX – COMMUNITY – HALL – STREAM – CONTOUR – DESCENT – DETOUR – BETWEEN_BLOCK – INTERMUNICIPAL_ROAD – COVE – PRIVATE_ENTRANCE – BETWEEN_QUARTER – LADDER – STAIRCASE – STATE_HIGHWAY – VICINAL_ROAD – ROAD_CONNECTION – MUNICIPAL_ROAD – ROAD_TO_SERFDOM – OLD_ROAD – LATER_ROAD – STADIUM – OFFICE – PRIVATE_ROAD – PARKING – EVANGELICAL – LOFTY – INDUSTRIAL_AXIS – RAILROAD – SOURCE – STRONG – HOUSING_NUCLEUS – ISLAND – UNDETERMINED – ISLET – WINDOW – LOT – MARKETPLACE – MARINA – MODULE – PROJECTION – MOUNT – RURAL_NUCLEUS – KNOLL – PARALLEL – TOUR – SPORTS_SQUARE – STOP – REST_AREA – TIP – PROLONGING – CITY_PARK – RESIDENTIAL_PARK – PASSAGE – PEDESTRIAN_WALKWAY – UNDERGROUND_PASSAGE – BRIDGE – PORT – FIFTH – FARMS – INTEGRATION_STREET – LINK_STREET – PRIVATE_STREET – OLD_STREET – BRANCH – PLAYGROUND – RETREAT – STRAIGHT – SIDE_STREET – RAMP – RODO_RING – KNEECAP – PEDESTRIAN_STREET – MARGIN – RETURN – ROUNDABOUT – SECOND_AVENUE – BONDAGE – UPLOADING – TRENCH – TERMINAL – TUNNEL – PRIVATE_BYSTREET – OLD_BYSTREET – UNITY – COLLECTOR_ROAD – LOCAL_WAY – ACCESS_WAY – DITCH – COASTAL_WAY – EXPRESSWAY – HIGHROAD – COASTAL_ROAD – WALKWAY – VARIANT – ZIGZAG enumNationalityType: description: Tipo de nacionalidade. type: string enum: – BRAZILIAN – OTHER enumYesNo: description: Enumeração para identificar valores de Sim e Não. type: string enum: – YES – NO enumDegreeOfKinship: description: Tipo de dependentes. type: string enum: – ADOPTED – CHILD – CONCUBINE – EX_SPOUSE – EX_PARTNER – GRANDPARENT – GRANDCHILD – GREAT_GRANDPARENT – GREAT_GRANDCHILD – GUARDIANSHIP – NEPHEW_NIECE – OTHER – PARENT – FATHER_IN_LAW – PARTNER – PENSIONERS – PUPIL – SIBLING – SON_DAUGHTER_IN_LAW – SPOUSE – STEPFATHER – STEPMOTHER – STEPCHILD – TRUSTED – UNCLE_AUNT – TUTOR enumPurchaseActions: description: Enumeração para ações de teste/compra do produto. type: string enum: – TRIAL_START – TRIAL_END – TRIAL_EXTEND – PURCHASE – CANCEL – PILOT enumExternalModules: description: Enumeração de módulos disponíveis para integração. type: string enum: – ADM_DE_PESSOAL – PAYROLL – API enumInvitationFieldsType: description: Enumaração dos campos disponíveis para customização das informações utilizadas no envio do convite. type: string enum: – KEY enumMobilePhoneOption: description: Opção de comunicação via celular type: string enum: – SMS – WHATSAPP – ALL enumEmployeeQuantity: description: Enumeração da quantidade de colaboradores. type: string enum: – UP_100 – BETWEEN_100_250 – BETWEEN_250_500 – BETWEEN_500_1000 – BETWEEN_1000_2500 – BETWEEN_2500_5000 – MORE_5000 enumBusinessSegment: description: Enumeração de segmentos de negócios type: string enum: – AGENCY – CONSULTING – E_COMMERCE – EDUCATION – HARDWARE – REAL_STATE – MANUFACTURE_INDUSTRY – LEGAL – HR_AND_RECRUITMENT – HEALTH – CORPORATE_SERVICES – FINANCIAL_SERVICES – CONSUMER_SERVICES – SOFTWARE_AND_CLOUD – TELECOMMUNICATIONS – TOURISM_AND_LEISURE – COMMUNICATION_VEHICLE enumAverageAdmissions: description: Enumeração da média mensal de admissões type: string enum: – UP_10 – BETWEEN_10_25 – BETWEEN_25_50 – BETWEEN_50_100 – MORE_100 fieldTypeDef: description: Tipo de campo. type: string enum: – String – Boolean – Integer – Double – Date – DateTime – Time – Money – Uuid – Blob – Binary – Any – Enumeration – Record 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR rRDData: description: Dados de integração do RD type: object required: – email – name – company – personal_phone properties: email: type: string description: Email name: type: string description: Nome company: type: string description: Empresa personal_phone: type: string description: telefone checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status enumInformationData: description: DTO de lista com as enumerações traduzidas. type: object required: – enumName – items properties: enumName: type: string description: Nome da enumeração. items: type: array items: type: object allOf: – #/definitions/enumInformationItemData minimum: 1 description: Lista com os items das enumerações. 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. inviteModelFieldListQueryData: description: Registro das categorias existentes em um determinado modelo de convite. type: object required: – categories properties: categories: type: array items: type: object allOf: – #/definitions/inviteModelFieldCategory minimum: 1 description: Lista de categorias do modelo de convite. inviteModelFieldCategory: description: Modelo de categoria com seus respectivos campos. type: object required: – category – fields properties: category: type: string allOf: – #/definitions/categoryField description: Nome da categoria. fields: type: array items: type: object allOf: – #/definitions/inviteModelFieldData minimum: 1 description: Campos. inviteModelData: description: Modelo com o cadastro de modelo de convite utilizado na gravação de um modelo de convite. type: object required: – name – enabled – country – deadline – fields – layout – contract properties: id: type: string description: Identificador do modelo. name: type: string maxLength: 100 description: Descrição do modelo. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o modelo está ativo ou não. country: type: string allOf: – #/definitions/inviteModelCountry description: País relacionado ao modelo. deadline: type: integer format: int64 description: Prazo do convite fields: type: array items: type: object allOf: – #/definitions/inviteModelFieldData minimum: 1 description: Campos relacionados ao dados do colaborador layout: type: object allOf: – #/definitions/inviteModelLayoutData description: Informações relacionadas ao layout do e-mail. contract: type: object allOf: – #/definitions/inviteModelContractData description: Informações da empresa relacionadas ao contrato. invitationLayout: type: array items: type: object allOf: – #/definitions/inviteModelInvitationLayoutData description: Layout da tela de envio de convites. inviteModelFieldData: description: Modelo com todas as informações de um campo do modelo de convite. type: object required: – type – subType – category – description – valueOrder – valueType – canReceiveAttachment properties: id: type: string description: Identificação do campo, quando não for um novo registro. type: type: string allOf: – #/definitions/inviteFieldType description: Tipo do campo. subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo. category: type: string allOf: – #/definitions/categoryField description: Categoria do campo. description: type: string description: Chave de tradução correspondente a descrição do campo. valueOrder: type: integer format: int64 description: Ordem de apresentação do campo na tela. valueType: type: string allOf: – #/definitions/valueType description: Tipos de valores aceitos pelo campo. canReceiveAttachment: type: boolean description: Indicativo se o seletor de foto será exibido ou não. visible: type: boolean description: Indicativo se o campo está visível ou não. default: false mandatory: type: boolean description: Indicativo se o campo é obrigatório ou não. default: false attachFile: type: boolean description: Indicativo se o usuário pode anexar foto ou não. default: false acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. default: false guidance: type: string description: Texto de orientação. dependsOn: type: string allOf: – #/definitions/valueType description: Em qual campo este campo depende inviteModelContractData: description: DTO da seção de contrato do modelo de convite. type: object properties: id: type: string description: Identificação do campo, quando não for um novo registro. employeeContractType: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato. eSocialCategory: type: string allOf: – #/definitions/eSocialCategory description: Categoria eSocial. unemploymentInsuranceType: type: string allOf: – #/definitions/unemploymentInsuranceType description: Tipo do seguro desemprego. sefipCategoryType: type: string allOf: – #/definitions/sefipCategoryType description: Categoria SEFIP. employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. raisType: type: string allOf: – #/definitions/raisType description: Vínculo RAIS. company: type: object allOf: – #/definitions/company description: Empresa para integração. branchOffice: type: object allOf: – #/definitions/branchOffice description: Filial jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo customFieldsInviteModelContract: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. inviteModelLayoutData: description: DTO de configuração do leiaute de e-mail/SMS do modelo de convite. type: object required: – sender – subject – baseColor – companyLogoId – circularCompanyLogoId – emailMessage – smsMessage properties: id: type: string description: Identificador da configuração. sender: type: string maxLength: 100 description: Remetente do convite. subject: type: string maxLength: 100 description: Assunto do convite. baseColor: type: string maxLength: 7 description: Cor base da jornada do colaborador em hexadecimal. companyLogoId: type: string maxLength: 300 description: Endereço da logomarca da empresa. companyLogoVersionId: type: string description: Versão do arquivo temporário da logomarca da empresa. companyLogoPermanentUrl: type: string description: Caminho permanente do arquivo da logomarca da empresa. circularCompanyLogoId: type: string maxLength: 300 description: Logomarca da empresa em formato circular. circularCompanyLogoVersionId: type: string description: Versão do arquivo temporário da logomarca da empresa em formato circular. circularCompanyLogoPermanentUrl: type: string description: Caminho permanente do arquivo da logomarca da empresa em formato circular. emailHeaderImageId: type: string maxLength: 300 description: Imagem do cabeçalho do e-mail. emailHeaderImageVersionId: type: string description: Versão do arquivo temporário da imagem do cabeçalho do e-mail. emailHeaderImagePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do cabeçalho do e-mail. emailMessage: type: string description: Conteúdo da mensagem enviada por e-mail. emailFooterImageId: type: string maxLength: 300 description: Imagem do rodapé do e-mail. emailFooterImageVersionId: type: string description: Versão do arquivo temporário da imagem do rodapé do e-mail. emailFooterImagePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do rodapé do e-mail. smsMessage: type: string maxLength: 160 description: Conteúdo da mensagem enviada por SMS. inviteModelContractQueryData: description: DTO da seção de contrato do modelo de convite. allOf: – #/definitions/contractQueryData – type: object invitationLayoutConfigurationData: description: Record com as configurações e valores necessários para montar a tela de envio de convites type: object properties: contract: type: object allOf: – #/definitions/contractQueryData description: Campos do contrato vinculados à um modelo de convite fields: type: array items: type: object allOf: – #/definitions/inviteModelInvitationLayoutData description: Configuração dos campos resultBaseData: description: Retorno base para os endpoints. discriminator: _discriminator type: object required: – ok – _discriminator properties: ok: type: boolean description: Flag para indicar sucesso. message: type: string description: Mensagem de retorno. default: _discriminator: type: string description: blobServiceRequestUploadData: description: Dados de retorno do upload de um arquivo. allOf: – #/definitions/resultBaseData – type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. blobServiceRequestAccessData: description: Dados de retorno do acesso do arquivo. allOf: – #/definitions/resultBaseData – type: object required: – locationURI properties: locationURI: type: string description: URI onde o arquivo está disponível para download. messageProfile: description: DTO do perfil do usuario que enviou as mensagens. type: object required: – name – messageSender properties: name: type: string description: Nome de quem enviou a mensagem photoUrl: type: string description: foto do perfil do usuario messageSender: type: string allOf: – #/definitions/messageSender description: Tipo de pessoa do perfil sentMessage: description: DTO das mensagens enviadas. type: object required: – dateSent – message – isNew – messageSender properties: dateSent: type: string format: date-time description: Data de envio da mensagem message: type: string description: Mensagem enviada isNew: type: boolean description: Se a mensagem é nova messageSender: type: string allOf: – #/definitions/messageSender description: Tipo de pessoa que enviou a mensagem preAdmissionSaveData: description: DTO da Pré-Admissão. type: object required: – inviteModel – employeeName – admissionDate properties: id: type: string description: Identificador único da pré-admissão inviteModel: type: object allOf: – #/definitions/inviteModel description: Modelo do convite. key: type: string maxLength: 255 description: Chave de identificação única da pré-admissão. employeeName: type: string maxLength: 100 description: Nome do novo colaborador employeeEmail: type: string maxLength: 150 description: Email do novo colaborador employeeMobilePhone: type: string maxLength: 20 description: Número de telefone celular do novo colaborador admissionDate: type: string format: date description: Data prevista de admissão do novo colaborador additionalInfo: type: string description: Informação adicional para ser enviada no modelo de convite employeeContractType: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato company: type: string description: Empresa branchOffice: type: string description: Filial jobPosition: type: string description: Cargo employeeMobilePhoneOption: type: string allOf: – #/definitions/enumMobilePhoneOption description: Opção de comunicação via celular fromIntegration: type: boolean description: flag se a chamada veio de integracao default: false preAdmissionData: description: DTO com as informações de uma pré-admissão. type: object required: – status properties: id: type: string description: Identificação da pré-admissão. employeeName: type: string description: Nome do colaborador. status: type: object allOf: – #/definitions/enumInformationItemData description: Status inviteModelId: type: string description: Identificador do modelo de convite inviteModelName: type: string description: Nome do modelo de convite hasDependent: type: boolean description: Identifica se existem dependentes. default: true inviteFields: type: array items: type: object allOf: – #/definitions/inviteModelFieldData description: Campos personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados pessoais document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Documentos contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Contrato companyData: description: DTO com as informações da empresa. type: object properties: id: type: string description: Identificador da empresa. companyName: type: string description: Nome da empresa. code: type: integer format: int64 description: Código. customFieldsCompany: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ctpsData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsCtps: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cpfData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsCpf: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. pisData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPis: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. rgData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsRg: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. voterData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsVoter: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnhData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsCnh: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. reservistData: 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 firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsReservist: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dnvData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsDnv: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. cnsData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsCns: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. civilCertificateData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsCivilCertificate: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. passportData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPassport: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ricData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsRic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. hiringMedicalExamData: description: DTO com as informações do hiring medical exam. type: object properties: id: type: string description: Identificador único do exame admissional. fileId: type: string maxLength: 300 description: Arquivo do exame. fileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. filePermanentUrl: type: string description: URL de acesso ao arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsHiringMedicalExam: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. bankAccountData: 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. bankAccount: type: string maxLength: 100 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsBankAccount: 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: object allOf: – #/definitions/professionalAdvice description: Conselho profissional number: type: string description: Número de registro no conselho profissional isTemporary: type: object allOf: – #/definitions/enumInformationItemData 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. doesntHave: type: boolean description: Se a pessoa não possui registro profissional default: false firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsProfessionalRecord: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. preAdmissionDocumentBRAData: description: DTO com as informações de documentos de uma pré-admissão. type: object properties: ctps: type: object allOf: – #/definitions/ctpsData description: Carteira de trabalho e previdência social. cpf: type: object allOf: – #/definitions/cpfData description: Cadastro de pessoas físicas. pis: type: object allOf: – #/definitions/pisData description: Programa de integração social. rg: type: object allOf: – #/definitions/rgData description: Registro geral. voter: type: object allOf: – #/definitions/voterData description: Título de eleitor. cnh: type: object allOf: – #/definitions/cnhData description: Carteira nacional de habilitação. reservist: type: object allOf: – #/definitions/reservistData description: Certificado de reservista. dnv: type: object allOf: – #/definitions/dnvData description: Declaração de nascido vivo. cns: type: object allOf: – #/definitions/cnsData description: Cartão nacional de saúde. civilCertificate: type: object allOf: – #/definitions/civilCertificateData description: Certificado civil passport: type: object allOf: – #/definitions/passportData description: Passaporte. ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil. hiringMedicalExam: type: object allOf: – #/definitions/hiringMedicalExamData description: Exame admissional. bankAccount: type: object allOf: – #/definitions/bankAccountData description: Informações bancárias. receiveSalaryAdvance: type: object allOf: – #/definitions/enumInformationItemData description: Recebe adiantamento salarial? professionalRecord: type: object allOf: – #/definitions/professionalRecordData description: Registro profissional customData: description: DTO com os valores de campos customizados para salvar. type: object required: – field properties: field: type: string description: Nome do campo. value: type: string description: Valor do campo. valueList: type: array items: type: string description: Valor do campo tipo lista. inviteInfoLayoutData: description: DTO com as informações básicas do leiaute para a jornada do colaborador. type: object properties: companyLogoUrl: type: string description: Logo Marca circularCompanyLogoUrl: type: string description: Logo circular baseColor: type: string description: Cor base do convite inviteInfoData: description: DTO com as informações da pré-admissão para a jornada do colaborador. type: object required: – preAdmission – inviteInfoLayout properties: preAdmission: type: object allOf: – #/definitions/preAdmission description: Pre admissão inviteInfoLayout: type: object allOf: – #/definitions/inviteInfoLayoutData description: Layout do modelo do convite preAdmissionPersonalBRAData: description: DTO com as informações de dados pessoais de uma pré-admissão. 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. telephone: type: object allOf: – #/definitions/personalTelephoneData description: Informações de contato por telefone. email: type: object allOf: – #/definitions/personalEmailData description: Informações de contato por email. personalBasicData: 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 e 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalBasic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalComplementaryData: 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 race: type: object allOf: – #/definitions/enumInformationItemData description: Raça/Cor socialName: type: string maxLength: 255 description: Nome social. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalComplementary: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalBirthPlaceData: 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalBirthPlace: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalAddressBRAData: 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalAddressBRA: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalTelephoneData: 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalTelephone: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. personalEmailData: 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. customFieldsPersonalEmail: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. employeePreAdmissionSaveData: description: DTO com o retorno da ação de salvar da jornada do colaborador. type: object required: – conclusionPercentage – status – requestStatus properties: conclusionPercentage: type: integer format: int64 description: Percentual de conclusão da pré-admissão. conclusionDocumentPercentage: type: integer format: int64 description: Percentual de conclusão dos documentos da pré-admissão. default: 0 conclusionPersonalDataPercentage: type: integer format: int64 description: Percentual de conclusão dos dados pessoais da pré-admissão. default: 0 conclusionDependentDataPercentage: type: integer format: int64 description: Percentual de conclusão dos dependentes da pré-admissão. default: 0 conclusionSocialQualificationPercentage: type: integer format: int64 description: Percentual de conclusão do e-social da pré-admissão. default: 0 status: type: object allOf: – #/definitions/enumInformationItemData description: Status da pré-admissão. requestStatus: type: boolean description: Status da ação de salvar. preAdmissionListData: description: Pré-admissões. type: object required: – key – employeeName – sendDate – admissionDate – status – deadlineDate – inviteESocialStatus – hasDependent properties: id: type: string description: Identificador do campo. modelId: type: object allOf: – #/definitions/inviteModel description: Modelo do convite. key: type: string maxLength: 255 description: Chave de identificação única da pré-admissão. employeeName: type: string maxLength: 100 description: Nome do novo colaborador employeeEmail: type: string maxLength: 150 description: Email do novo colaborador employeeMobilePhone: type: string maxLength: 20 description: Número de telefone celular do novo colaborador sendDate: type: string format: date description: Data de envio do convite conclusionPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento do convite default: 0 conclusionDocumentPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento dos campos de documentos default: 0 conclusionPersonalDataPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento dos campos de dados pessoais default: 0 conclusionDependentDataPercentage: type: integer format: int64 description: Percentual de conclusão dos dependentes da pré-admissão. default: 0 conclusionSocialQualificationPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento do eSocial default: 0 admissionDate: type: string format: date description: Data prevista de admissão do novo colaborador status: type: string allOf: – #/definitions/invitationStatus description: Status do convite deadlineDate: type: string format: date description: Data de expiração do convite inviteESocialStatus: type: string allOf: – #/definitions/eSocialStatus description: Status do eSocial unreadMessages: type: integer format: int64 description: Quantidade de mensagens não lidas minimum: 0 maximum: 99 default: 0 preAdmissionImagePermanentUrl: type: string description: URL para a imagem do crachá da pré-admissão hasDependent: type: boolean description: Identifica se existem dependentes. dependentData: description: DTO com as informações de um dependente. type: object required: – id – preAdmissionId properties: id: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pré-admissão. inviteFields: type: array items: type: object allOf: – #/definitions/inviteModelFieldData description: Campos do modelo de convite. basic: type: object allOf: – #/definitions/dependentBasicData description: Dados básicos document: type: object allOf: – #/definitions/dependentDocumentData description: Documentos validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do dependente. dependentBasicData: description: DTO com os dados básicos do dependente. type: object properties: id: type: string description: Identificador único dos dados básicos. fullName: type: string maxLength: 255 description: Nome completo. degreeOfKinship: type: object allOf: – #/definitions/enumInformationItemData description: Grau de parentesco. gender: type: object allOf: – #/definitions/enumInformationItemData description: Gênero birthDate: type: string format: date description: Nascimento do dependente declareIncomeTax: type: object allOf: – #/definitions/enumInformationItemData description: Declara imposto de renda mothersName: type: string maxLength: 255 description: Nome da mãe maritalStatus: type: object allOf: – #/definitions/enumInformationItemData description: Estado civil customFieldsDependentBasic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentDocumentData: description: DTO com os documentos do dependente. type: object properties: id: type: string description: Identificador único do documento. cpf: type: object allOf: – #/definitions/cpfData description: CPF. rg: type: object allOf: – #/definitions/rgData description: Carteira de identidade. ric: type: object allOf: – #/definitions/ricData description: Registro de identidade civil. sus: type: object allOf: – #/definitions/susData description: Cartão do 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 de nascimento. susData: description: DTO com as informações do cartão do SUS. type: object properties: id: type: string description: Identificador único do cartão do SUS. number: type: string maxLength: 255 description: Número. firstFileId: type: string maxLength: 300 description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsSus: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. vaccinationBookletData: description: DTO com as informações da caderneta de vacinação. type: object properties: id: type: string description: Identificador único do registro firstFileId: type: string maxLength: 300 description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segundo arquivo secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. thirdFileId: type: string maxLength: 300 description: Terceiro arquivo thirdFileVersion: type: string description: Identificador para efetuar o commit do terceiro arquivo. thirdFilePermanentUrl: type: string description: URL de acesso ao terceiro arquivo. customFieldsVaccinationBooklet: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. proofOfEnrollmentData: description: DTO com as informações do comprovante de matrícula. type: object properties: id: type: string description: Identificador único do comprovante de matrícula. firstFileId: type: string maxLength: 300 description: Primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsProofOfEnrollment: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. listBaseResultData: description: Resultado base para listas. discriminator: _discriminator type: object required: – _discriminator properties: totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. _discriminator: type: string description: preAdmissionDependentListData: description: Lista de dependentes de uma pré-admissão. allOf: – #/definitions/listBaseResultData – type: object properties: contents: type: array items: type: object allOf: – #/definitions/preAdmissionDependentData description: Lista dos dependentes da pré-admissão companyListData: description: Lista de empresas allOf: – #/definitions/listBaseResultData – type: object properties: contents: type: array items: type: object allOf: – #/definitions/companyData description: Lista das empresas globalSettingsData: description: Configurações globais do onboarding. type: object required: – isIntegratedWithPayroll – companyName – isIntegratedWithAP properties: isIntegratedWithPayroll: type: boolean description: Indica se o módulo está integrado com o módulo de folha. companyName: type: string description: Nome da empresa isIntegratedWithAP: type: boolean description: Indica se módulo está integrado com o módulo Administração de pessoal (G5). purchaseInfoData: description: Informações relacionadas ao período de trial do produto, type: object required: – isBlocked – isTrial properties: isBlocked: type: boolean description: Indica se algumas funções devem ser bloqueadas. isTrial: type: boolean description: Indica se está em período de trial. trialEndDayDiff: type: integer format: int64 description: Dias de distância do fim do período de trial. canExtend: type: boolean description: Indica se o período de trial poderá ser prorrogado. preAdmissionMessageData: description: Dados das mensagens da pré-admissão type: object required: – employee – company – messages properties: employee: type: object allOf: – #/definitions/messageProfile description: Perfil do candidato para a pré admissão para utilizar nas mensagens company: type: object allOf: – #/definitions/messageProfile description: Perfil do RH para utilizar nas mensagens messages: type: array items: type: object allOf: – #/definitions/sentMessage minimum: 1 description: Mensagens enviadas digitalTrialData: description: Dados do formulário de trial. type: object required: – firstName – lastName – businessEmail – companyName – companyPhone – employeeQuantity – businessSegment – averageAdmissions properties: firstName: type: string maxLength: 40 description: Primeiro nome da pessoa de contato. lastName: type: string maxLength: 80 description: Sobrenome da pessoa de contato. businessEmail: type: string maxLength: 120 description: Endereço de e-mail profissional. password: type: string maxLength: 20 description: Senha de acesso. companyName: type: string maxLength: 80 description: Nome da empresa solicitando o trial. companyPhone: type: string maxLength: 25 description: Número de telefone da empresa para contato. cnpj: type: string maxLength: 18 description: CNPJ da empresa solicitando o trial. employeeQuantity: type: string allOf: – #/definitions/enumEmployeeQuantity description: Quantidade de colaboradores da empresa. businessSegment: type: string allOf: – #/definitions/enumBusinessSegment description: Segmento de negócio da empresa. averageAdmissions: type: string allOf: – #/definitions/enumAverageAdmissions description: Média de admissões da empresa. preAdmissionContractBraData: description: Dados do contrato da pré-admissão allOf: – #/definitions/contractQueryData – type: object properties: preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão. contractQueryData: description: Dados do contrato da pré-admissão discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador único do registro. employeeContractType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo de contrato. eSocialCategory: type: object allOf: – #/definitions/enumInformationItemData description: Categoria eSocial. unemploymentInsuranceType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do seguro desemprego. sefipCategoryType: type: object allOf: – #/definitions/enumInformationItemData description: Categoria SEFIP. employeeType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do colaborador. raisType: type: object allOf: – #/definitions/enumInformationItemData description: Vínculo RAIS. company: type: object allOf: – #/definitions/company description: Empresa para integração. branchOffice: type: object allOf: – #/definitions/branchOffice description: Filial do contrato jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customFieldsInviteModelContract: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. _discriminator: type: string description: inviteModelInvitationLayoutData: description: Informações do leiaute da tela de envio de convite type: object required: – description – mandatory properties: id: type: string description: Identificador único do registro. description: type: string maxLength: 255 description: Descrição do campo. field: type: string allOf: – #/definitions/enumInvitationFieldsType description: Campo que permitirá configuração. mandatory: type: boolean description: Indica se o campo será obrigatório. preAdmissionMonthData: description: Dados das pré-admissões por mês allOf: – #/definitions/highChartsBaseData – type: object required: – date properties: date: type: string format: date description: Data final do mês em vigor preAdmissionAnalyticsSituationData: description: Dados das situações das pré-admissões allOf: – #/definitions/highChartsBaseData – type: object required: – type properties: type: type: string allOf: – #/definitions/invitationStatus description: Status do convite highChartsBaseData: description: Analytics base data discriminator: _discriminator type: object required: – name – y – _discriminator properties: name: type: string description: Label para exibição y: type: integer format: int64 description: Quantidade para usar no highCharts _discriminator: type: string description: captchaData: description: DTO Retorno captcha qualificação social type: object required: – urlCaptcha – challengeField properties: urlCaptcha: type: string description: Url da imagem do captcha challengeField: type: string description: Hash do desafio socialQualificationData: description: DTO Retorno da validação da qualificação social type: object required: – status – message – orientation – isGovernmentMessage properties: status: type: boolean description: Se a qualificação social é valida message: type: string description: Mensagem de retorno do governo orientation: type: string description: Orientação para corrigir a requisição isGovernmentMessage: type: boolean description: Se o retorno é do governo ou não preAdmissionDependentData: description: DTO de retorno da listagem de dependentes. type: object properties: id: type: string description: Id do dependente fullName: type: string description: Nome completo do dependente degreeOfKinship: type: object allOf: – #/definitions/enumInformationItemData description: Grau de parentesco conclusionPercentage: type: integer format: int64 description: Percentual de conclusão. validation: type: boolean description: Validação do dependente default: false contractFilterData: description: Campos para realizar o filtro de abrangência relacionado ao contrato type: object properties: company: type: string description: ID Empresa. branchOffice: type: string description: ID Filial. jobPosition: type: string description: ID Cargo rKeyValueData: description: DTO Key e value type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor messageFromSmartphoneData: description: DTO com número de celular e mensagem de texto de boas vindas sem tag HTML type: object required: – mobilePhone – text – employeeName properties: mobilePhone: type: string description: Número de celular text: type: string description: Texto sem tag HTML employeeName: type: string description: Nome do colaborador paramsForTracksaleData: description: Parâmetros que serão utilizados no tracksale type: object required: – fullName – email – id – tenantName – clientCode – isTrial properties: fullName: type: string description: Nome completo email: type: string description: E-mail id: type: string description: ID tenantName: type: string description: Nome do tenant clientCode: type: string description: Código do cliente isTrial: type: boolean description: Indica se o tenant está em período de trial entityIdDef: description: Entity id. type: object required: – domain_ – service_ – id properties: domain_: type: string description: Domínio da entidade. service_: type: string description: Serviço da entidade. id: type: string description: identificador da entidade. entityDef: description: Entity definition. type: object required: – id – fields – active properties: id: type: string description: Id. fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Campos. active: type: boolean description: Indica se está ativo ou não. fieldDef: description: Field definition. type: object required: – id – type properties: id: type: string description: Id. type: type: string allOf: – #/definitions/fieldTypeDef description: Tipo do campo. key: type: boolean description: Indica se o campo é chave. customizable: type: boolean description: Indica se o campo é customizável. customization: type: object allOf: – #/definitions/fieldCustomizationDef description: Customization. fieldCustomizationDef: description: Field customization definition. type: object required: – label – order – active properties: change: type: object allOf: – #/definitions/changeInfoDef description: Informações sobre a criação ou última alteração do objeto. br/ b Read only. /b . label: type: string description: Rótulo do campo. order: type: integer format: int64 description: Ordem do campo. active: type: boolean description: Campo ativo. validationRegex: type: string description: Expressão regular de validação. tooltip: type: string description: Dica. mask: type: string description: Máscara. labelTranslationKey: type: string description: Chave de tradução do label. br/ b Read only. /b . tooltipTranslationKey: type: string description: Chave de transição do tooltip. br/ b Read only. /b . resourceURI: type: string description: Resource de permissão. br/ b Read only. /b . customEnumeration: type: object allOf: – #/definitions/customEnumerationDef description: Mapa de oções do enumeration, utilizado quando o fieldTypeDef for Enumeration customEnumerationDef: description: type: object required: – values properties: multiple: type: boolean description: Campo é multi valores values: type: array items: type: object allOf: – #/definitions/customEnumerationValue minimum: 1 description: Possíveis valores para o enumeration customEnumerationValue: description: type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor changeInfoDef: description: Definição de alteração do campo. type: object required: – user – time_ properties: user: type: string description: Usuário que criou ou efetuou a última alteração no objeto. time_: type: string format: date-time description: Hora que o objeto foi criado ou alterado pela última vez. entityDefList: description: Definição de lista de entidades type: object required: – id – entity_ properties: id: type: string description: Id da entidade entity_: type: object allOf: – #/definitions/entityDef description: Entidade autocompleteFilter: description: DTO com informações do lookup type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro commitObjectDef: description: DTO com informações para commitar campos customizados no blob service. type: object required: – objectId – fileName – version properties: objectId: type: string description: Id de identificação do objeto fileName: type: string description: Nome do arquivo type: string description: Versão deleteObjectDef: description: DTO com informações para deletar campos customizados no blob service. type: object required: – field – objectId properties: field: type: string description: Nome do campo objectId: type: string description: Id de identificação do objeto seguindo o padrão – objectId/fileName countryField: description: Cadastro de campos de modelo de convite por país. type: object required: – country – type – subType – category – description – valueOrder – valueType properties: id: type: string format: uuid description: Identificador do campo. country: type: string allOf: – #/definitions/inviteModelCountry description: País relacionado ao campo. type: type: string allOf: – #/definitions/inviteFieldType description: Tipo do campo. subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo. category: type: string allOf: – #/definitions/categoryField description: Categoria do campo. description: type: string maxLength: 255 description: Descrição do campo. valueOrder: type: integer format: int64 description: Ordem de apresentação do campo na tela. valueType: type: string allOf: – #/definitions/valueType description: Tipos de valores aceitos pelo campo. canReceiveAttachment: type: boolean description: Indicativo se o campo aceita anexos ou não. default: false acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. default: false dependsOn: type: string allOf: – #/definitions/valueType description: Em qual campo este campo depende createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: company: description: Cadastro de empresas. type: object required: – companyName – enabled properties: id: type: string format: uuid description: Identificador da empresa. companyName: type: string maxLength: 255 description: Nome da empresa. code: type: string maxLength: 255 description: Código externo da empresa. enabled: type: string allOf: – #/definitions/situation description: Indicativo se a empresa está ativa ou não. branchOffice: type: array items: type: object allOf: – #/definitions/branchOffice description: Filiais. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModel: description: Principais dados do modelo de convite. type: object required: – name – enabled – country – deadline properties: id: type: string format: uuid description: Identificador do modelo. name: type: string maxLength: 100 description: Descrição do modelo. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o modelo está ativo ou não. country: type: string allOf: – #/definitions/inviteModelCountry description: País relacionado ao modelo. deadline: type: integer format: int64 description: Prazo do convite. preAdmission: type: array items: type: object allOf: – #/definitions/preAdmission description: Relacionamento da preAdmission inviteModelContract: type: array items: type: object allOf: – #/definitions/inviteModelContract description: Relacionamento da inviteModelContract inviteModelLayout: type: array items: type: object allOf: – #/definitions/inviteModelLayout description: Relacionamento da inviteModelLayout inviteModelField: type: array items: type: object allOf: – #/definitions/inviteModelField description: Relacionamento da inviteModelField inviteModelInvitationLayout: type: array items: type: object allOf: – #/definitions/inviteModelInvitationLayout description: Relacionamento da inviteModelField createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelLayout: description: Configuração do leiaute de e-mail/SMS do modelo de convite. type: object required: – modelId – sender – subject – baseColor – companyLogoId – circularCompanyLogoId – emailMessage – smsMessage properties: id: type: string format: uuid description: Identificador da configuração. modelId: type: object allOf: – #/definitions/inviteModel description: Modelo do convite. sender: type: string maxLength: 100 description: Remetente do convite. subject: type: string maxLength: 100 description: Assunto do convite. baseColor: type: string maxLength: 7 description: Cor base da jornada do colaborador em hexadecimal. companyLogoId: type: string maxLength: 300 description: Endereço da logomarca da empresa. circularCompanyLogoId: type: string maxLength: 300 description: Logomarca da empresa em formato circular. emailHeaderImageId: type: string maxLength: 300 description: Imagem do cabeçalho do e-mail. emailMessage: type: string description: Conteúdo da mensagem enviada por e-mail. emailFooterImageId: type: string maxLength: 300 description: Imagem do rodapé do e-mail. smsMessage: type: string maxLength: 160 description: Conteúdo da mensagem enviada por SMS. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelField: description: Campos com as informações que devem ser preenchidas pelo colaborador. type: object required: – modelId – type – subType – category – description – valueOrder – valueType properties: id: type: string format: uuid description: Identificação do campo. modelId: type: object allOf: – #/definitions/inviteModel description: Modelo do convite. type: type: string allOf: – #/definitions/inviteFieldType description: Tipo do campo. subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo. category: type: string allOf: – #/definitions/categoryField description: Categoria do campo. description: type: string maxLength: 255 description: Descrição do campo. visible: type: boolean description: Indicativo de campo visível ou não. default: false mandatory: type: boolean description: Indicativo de campo obrigatório ou não. default: false attachFile: type: boolean description: Indicativo de obrigatoriedade para inclusão de um campo para anexos. default: false valueOrder: type: integer format: int64 description: Ordem de visualização. valueType: type: string allOf: – #/definitions/valueType description: Tipos de valores aceitos pelo campo. canReceiveAttachment: type: boolean description: Indicativo se o campo aceita anexos ou não. default: false acceptsGuidance: type: boolean description: Indicativo se o campo aceita orientação. default: false guidance: type: string maxLength: 180 description: Texto de orientação. dependsOn: type: string allOf: – #/definitions/valueType description: Em qual campo este campo depende createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelContract: description: Seção de contrato (Empresa) do modelo de convite. type: object required: – modelId properties: id: type: string format: uuid description: Identificador da tabela. modelId: type: object allOf: – #/definitions/inviteModel description: Id do Modelo de convite. employeeContract: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato. eSocialCategory: type: string allOf: – #/definitions/eSocialCategory description: Categoria eSocial. unemploymentInsurance: type: string allOf: – #/definitions/unemploymentInsuranceType description: Tipo do seguro desemprego. sefipCategory: type: string allOf: – #/definitions/sefipCategoryType description: Categoria SEFIP. employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. raisType: type: string allOf: – #/definitions/raisType description: Vínculo RAIS. company: type: string format: uuid description: Empresa para integração. branchOffice: type: string format: uuid description: Filial do contrato jobPosition: type: string format: uuid description: Cargo do contrato. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmission: description: Pré-admissões. type: object required: – employeeName – sendDate – admissionDate – status – deadlineDate – inviteESocialStatus properties: id: type: string format: uuid description: Identificador do campo. linkId: type: string format: uuid description: Identificador da pré-admissão a ser enviado no link do convite. modelId: type: object allOf: – #/definitions/inviteModel description: Modelo do convite. key: type: string maxLength: 255 description: Chave de identificação única da pré-admissão. employeeName: type: string maxLength: 100 description: Nome do novo colaborador employeeEmail: type: string maxLength: 150 description: Email do novo colaborador employeeMobilePhone: type: string maxLength: 20 description: Número de telefone celular do novo colaborador sendDate: type: string format: date description: Data de envio do convite conclusionPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento do convite default: 0 conclusionDocumentPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento dos campos de documentos default: 0 conclusionPersonalDataPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento dos campos de dados pessoais default: 0 conclusionDependentDataPercentage: type: integer format: int64 description: Percentual de conclusão dos dependentes da pré-admissão. default: 0 conclusionSocialQualificationPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento do eSocial default: 0 admissionDate: type: string format: date description: Data prevista de admissão do novo colaborador status: type: string allOf: – #/definitions/invitationStatus description: Status do convite deadlineDate: type: string format: date description: Data de expiração do convite inviteESocialStatus: type: string allOf: – #/definitions/eSocialStatus description: Status do eSocial unreadMessages: type: integer format: int64 description: Quantidade de mensagens não lidas minimum: 0 maximum: 99 default: 0 hasDependent: type: boolean description: Identifica se existem dependentes. default: true socialQualification: type: array items: type: object allOf: – #/definitions/socialQualification description: Relacionamento da socialQualification preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA preAdmissionMessage: type: array items: type: object allOf: – #/definitions/preAdmissionMessage description: Relacionamento da preAdmissionMessage preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA preAdmissionDependentBra: type: array items: type: object allOf: – #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra preAdmissionContractBra: type: array items: type: object allOf: – #/definitions/preAdmissionContractBra description: Relacionamento da preAdmissionContractBra employeeMobilePhoneOption: type: string allOf: – #/definitions/enumMobilePhoneOption description: Opção de recebimento de convite (SMS, WhatsApp) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionMessage: description: Mensagens relacionadas a pré-admissão. type: object required: – preAdmission – sender – sendDate – message properties: id: type: string format: uuid description: Identificação do campo. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pre admissão a qual a mensagem está vinculada. sender: type: string allOf: – #/definitions/messageSender description: Pessoa que enviou a mensagem. sendDate: type: string format: date-time description: Data na qual a mensagem foi enviada. readDate: type: string format: date-time description: Data na qual a mensagem foi lida. message: type: string description: Mensagem enviada. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionDocumentBRA: description: Documentos relacionados a pré-admissão. type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador único do registro. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão a qual o documento está vinculado. ctps: type: object allOf: – #/definitions/ctps description: Dados da carteira de trabalho. cpf: type: object allOf: – #/definitions/cpf description: Dados do CPF. pis: type: object allOf: – #/definitions/pis description: Dados do PIS. rg: type: object allOf: – #/definitions/rg description: Dados do RG. voter: type: object allOf: – #/definitions/voter description: Dados do título de eleitor. cnh: type: object allOf: – #/definitions/cnh description: Dados da CNH. reservist: type: object allOf: – #/definitions/reservist description: Dados da certidão de reservista. dnv: type: object allOf: – #/definitions/dnv description: Dados da declaração de nascido vivo. cns: type: object allOf: – #/definitions/cns description: Dados do cartão nacional de saúde. civilCertificate: type: object allOf: – #/definitions/civilCertificate description: Dados do certificado civil. passport: type: object allOf: – #/definitions/passport description: Dados do passaporte. ric: type: object allOf: – #/definitions/ric description: Dados do registro de identidade civil. hiringMedicalExam: type: object allOf: – #/definitions/hiringMedicalExam description: Exame admissional. bankAccount: type: object allOf: – #/definitions/bankAccount description: Dados bancários. receiveSalaryAdvance: type: string allOf: – #/definitions/enumYesNo description: Recebe adiantamento salarial? professionalRecord: type: object allOf: – #/definitions/professionalRecord description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ctps: description: Dados da carteira de trabalho (CTPS). type: object properties: id: type: string format: uuid description: Identificador único do registro. 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: string format: uuid description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cpf: description: Dados do CPF. type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pis: description: Dados do PIS. type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. issueDate: type: string format: date description: Data de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: rg: description: Dados da Carteira de Identidade (RG). type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. issuer: type: string maxLength: 255 description: Órgão emissor. issuerState: type: string format: uuid description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: voter: description: Dados do título de eleitor. type: object properties: id: type: string format: uuid description: Identificador único do registro. 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: string format: uuid description: Cidade de emissão. issuerState: type: string format: uuid description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cnh: description: Dados da Carteira de Habilitação (CNH). type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. category: type: string allOf: – #/definitions/enumDriverLicenceCategory description: Categoria. issuer: type: string maxLength: 255 description: Órgão emissor. issuerState: type: string format: uuid 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. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: reservist: description: Dados do certificado de reservista. type: object properties: id: type: string format: uuid description: Identificador único do registro. 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. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. doesntHave: type: boolean description: Se a pessoa não possui certificado de reservista default: false validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dnv: description: Dados da declaração de nascido vivo (DNV). type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cns: description: Dados do Cartão Nacional de Saúde (CNS) type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: civilCertificate: description: Dados da certidão civil (nascimento). type: object properties: id: type: string format: uuid description: Identificador único do registro. type: type: string allOf: – #/definitions/enumCivilCertificate 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: string format: uuid description: Cidade de emissão. issuerState: type: string format: uuid description: Estado de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument dependentDocument2: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: passport: description: Dados do passaporte. type: object properties: id: type: string format: uuid description: Identificador único do registro. 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: string format: uuid description: País da emissão. issuerState: type: string format: uuid description: Estado da emissão do passaporte. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ric: description: Dados do registro de identidade civil (RIC). type: object properties: id: type: string format: uuid description: Identificador único do registro. number: type: string maxLength: 255 description: Número. issuer: type: string maxLength: 255 description: Órgão emissor. issuerCity: type: string format: uuid description: Cidade da emissão. issuerState: type: string format: uuid description: Estado da emissão. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hiringMedicalExam: description: Dados do exame admissional. type: object properties: id: type: string format: uuid description: Identificador único do registro. file: type: string maxLength: 300 description: Arquivo do exame. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: bankAccount: description: Conta bancária. type: object required: – branch properties: id: type: string format: uuid description: Identificador da conta bancária. bank: type: string format: uuid description: Identificador do banco. branch: type: integer format: int64 description: Número da agência. accountType: type: string allOf: – #/definitions/enumAccountType description: Tipo da conta. bankAccount: type: string maxLength: 100 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta. firstFile: type: string maxLength: 300 description: Primeira imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: validationData: description: Informações de validação dos documentos e dados da pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do registro. validated: type: boolean description: Indica se o documento foi validado. default: false validationUser: type: string maxLength: 255 description: Indica o usuário que efetuou a validação. validationDate: type: string format: date-time description: Indica a data e hora de validação do documento. bankAccount: type: array items: type: object allOf: – #/definitions/bankAccount description: Relacionamento da bankAccount civilCertificate: type: array items: type: object allOf: – #/definitions/civilCertificate description: Relacionamento da civilCertificate cnh: type: array items: type: object allOf: – #/definitions/cnh description: Relacionamento da cnh cns: type: array items: type: object allOf: – #/definitions/cns description: Relacionamento da cns cpf: type: array items: type: object allOf: – #/definitions/cpf description: Relacionamento da cpf personalTelephone: type: array items: type: object allOf: – #/definitions/personalTelephone description: Relacionamento da personalTelephone ctps: type: array items: type: object allOf: – #/definitions/ctps description: Relacionamento da ctps voter: type: array items: type: object allOf: – #/definitions/voter description: Relacionamento da voter hiringMedicalExam: type: array items: type: object allOf: – #/definitions/hiringMedicalExam description: Relacionamento da hiringMedicalExam dnv: type: array items: type: object allOf: – #/definitions/dnv description: Relacionamento da dnv personalAddressBRA: type: array items: type: object allOf: – #/definitions/personalAddressBRA description: Relacionamento da personalAddressBRA personalBasic: type: array items: type: object allOf: – #/definitions/personalBasic description: Relacionamento da personalBasic personalEmail: type: array items: type: object allOf: – #/definitions/personalEmail description: Relacionamento da personalEmail passport: type: array items: type: object allOf: – #/definitions/passport description: Relacionamento da passport personalBirthPlace: type: array items: type: object allOf: – #/definitions/personalBirthPlace description: Relacionamento da personalBirthPlace personalComplementary: type: array items: type: object allOf: – #/definitions/personalComplementary description: Relacionamento da personalComplementary preAdmissionDependentBra: type: array items: type: object allOf: – #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra reservist: type: array items: type: object allOf: – #/definitions/reservist description: Relacionamento da reservist ric: type: array items: type: object allOf: – #/definitions/ric description: Relacionamento da ric rg: type: array items: type: object allOf: – #/definitions/rg description: Relacionamento da rg pis: type: array items: type: object allOf: – #/definitions/pis description: Relacionamento da pis professionalRecord: type: array items: type: object allOf: – #/definitions/professionalRecord description: Relacionamento da professionalRecord createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: bank: description: Banco. type: object required: – code – name properties: id: type: string format: uuid description: Identificador do banco. code: type: integer format: int64 description: Número do banco. name: type: string maxLength: 255 description: Descrição. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: city: description: Cidade. type: object required: – name properties: id: type: string format: uuid description: Identificador da cidade. name: type: string maxLength: 255 description: Nome da cidade. state: type: string format: uuid description: Relacionamento com estado da cidade. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: state: description: Estado da cidade. type: object properties: id: type: string format: uuid 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 format: uuid description: Relacionamento com país. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: country: description: País do estado. type: object properties: id: type: string format: uuid 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. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: religion: description: Religião. type: object required: – code – name properties: id: type: string format: uuid 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. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: nationality: description: Nacionalidade da pessoa. type: object properties: id: type: string format: uuid 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. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: degreeOfEducation: description: Grau de instrução (r022gra) type: object properties: id: type: string format: uuid 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. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionPersonalBRA: description: Dados pessoais da pré-admissão. type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador único do registro. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão. basic: type: object allOf: – #/definitions/personalBasic description: Dados básicos da pré-admissão. complementary: type: object allOf: – #/definitions/personalComplementary description: Dados complementares da pré-admissão. birthPlace: type: object allOf: – #/definitions/personalBirthPlace description: Dados do local de nascimento. address: type: object allOf: – #/definitions/personalAddressBRA description: Dados do endereço. telephone: type: object allOf: – #/definitions/personalTelephone description: Dados do telefones para contato. email: type: object allOf: – #/definitions/personalEmail description: Dados de emails para contato. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalBasic: description: Dados pessoais básicos da pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do registro. employeeName: 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. gender: type: string allOf: – #/definitions/enumGender description: Gênero do novo colaborador. birthDate: type: string format: date description: Data e 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. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalComplementary: description: Dados complementares da pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do registro. maritalStatus: type: string allOf: – #/definitions/enumMaritalStatus description: Estado civil. degreeOfEducation: type: string format: uuid description: Grau de instrução. degreeOfEducationFileId: type: string maxLength: 300 description: Comprovante do grau de instrução. nationality: type: string format: uuid description: Nacionalidade. religion: type: string format: uuid description: Religião. race: type: string allOf: – #/definitions/enumRacialType description: Raça/Cor. socialName: type: string maxLength: 255 description: Nome social. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalBirthPlace: description: Dados de local de nascimento da pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do registro. country: type: string format: uuid description: País de nascimento. state: type: string format: uuid description: Estado de nascimento. city: type: string format: uuid description: Cidade de nascimento. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalAddressBRA: description: Dados do endereço da pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do registro. country: type: string format: uuid description: País de nascimento. state: type: string format: uuid description: Estado de nascimento. city: type: string format: uuid description: Cidade de nascimento. cep: type: string maxLength: 10 description: CEP do endereço. neighborhood: type: string maxLength: 255 description: Bairro. addressType: type: string allOf: – #/definitions/enumAddressType description: Logradouro. address: type: string maxLength: 255 description: Endereço. firstFile: type: string maxLength: 300 description: Primeira imagem. number: type: string maxLength: 10 description: Número do endereço. additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalTelephone: description: Telefones para contato com o novo colaborador. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstPhone: type: string maxLength: 255 description: Número do telefone principal. firstType: type: string allOf: – #/definitions/enumTelephone description: Tipo do contato do telefone principal. secondPhone: type: string maxLength: 255 description: Número do telefone secundário. secondType: type: string allOf: – #/definitions/enumTelephone description: Tipo do contato do telefone principal. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalEmail: description: Emails para contato com o novo colaborador. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstEmail: type: string maxLength: 255 description: Email principal do novo colaborador. firstType: type: string allOf: – #/definitions/enumEmail description: Tipo do email principal. secondEmail: type: string maxLength: 255 description: Email secundário do novo colaborador. secondType: type: string allOf: – #/definitions/enumEmail description: Tipo do email secundário. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalBRA: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalBRA description: Relacionamento da preAdmissionPersonalBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: socialQualification: description: Verificação da qualificação social type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador único do registro. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão. name: type: string maxLength: 255 description: Nome do colaborador birthDate: type: string format: date description: Data de nascimento do colaborador cpf: type: string maxLength: 255 description: CPF do colaborador pis: type: string maxLength: 255 description: PIS do colaborador message: type: string maxLength: 255 description: Mensagem de retorno Esocial orientation: type: string maxLength: 255 description: Mensagem de orientação Esocial isGovernmentMessage: type: boolean description: Se o retorno é do governo ou não createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sus: description: Dados do cartão SUS type: object properties: id: type: string format: uuid description: Identificador único do registro number: type: string maxLength: 255 description: Número firstFile: type: string maxLength: 300 description: Primeira imagem. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vaccinationBooklet: description: Dados da caderneta de vacinação type: object properties: id: type: string format: uuid description: Identificador único do registro firstFile: type: string maxLength: 300 description: Primeiro arquivo. secondFile: type: string maxLength: 300 description: Segundo arquivo thirdFile: type: string maxLength: 300 description: Terceiro arquivo dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: proofOfEnrollment: description: Dados do comprovante de matrícula. type: object properties: id: type: string format: uuid description: Identificador único do comprovante de matrícula. firstFile: type: string maxLength: 300 description: Primeiro arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentBasic: description: Dados básicos do dependente vinculado a pré-admissão type: object properties: id: type: string format: uuid description: Identificador único do registro fullName: type: string maxLength: 255 description: Nome completo degreeOfKinship: type: string allOf: – #/definitions/enumDegreeOfKinship description: Grau de parentesco gender: type: string allOf: – #/definitions/enumGender description: Gênero birthDate: type: string format: date description: Nascimento do dependente declareIncomeTax: type: string allOf: – #/definitions/enumYesNo description: Declara imposto de renda mothersName: type: string maxLength: 255 description: Nome da mãe maritalStatus: type: string allOf: – #/definitions/enumMaritalStatus description: Estado civil preAdmissionDependentBra: type: array items: type: object allOf: – #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentDocument: description: Documentos do dependente vinculado a pré-admissão. type: object properties: id: type: string format: uuid description: Identificador único do documento. cpf: type: object allOf: – #/definitions/cpf description: CPF. rg: type: object allOf: – #/definitions/rg description: Carteira de identidade. ric: type: object allOf: – #/definitions/ric description: Registro de identidade civil. sus: type: object allOf: – #/definitions/sus description: Cartão do SUS vaccinationBooklet: type: object allOf: – #/definitions/vaccinationBooklet description: Caderneta de vacinação. proofOfEnrollment: type: object allOf: – #/definitions/proofOfEnrollment description: Comprovante de matrícula. deathCertificate: type: object allOf: – #/definitions/civilCertificate description: Certidão de óbito. birthCertificate: type: object allOf: – #/definitions/civilCertificate description: Certidão de nascimento. preAdmissionDependentBra: type: array items: type: object allOf: – #/definitions/preAdmissionDependentBra description: Relacionamento da preAdmissionDependentBra createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionDependentBra: description: Dependentes da pré-admissão. type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador único do registro. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão. dependentBasic: type: object allOf: – #/definitions/dependentBasic description: Dados básicos do dependente. dependentDocument: type: object allOf: – #/definitions/dependentDocument description: Documentos do dependente. conclusionPercentage: type: integer format: int64 description: Percentual de conclusão. default: 0 validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do dependente. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: purchaseHistory: description: Contém o histórico de testes/compra do cliente. type: object required: – purchaseAction – purchaseDate properties: id: type: string format: uuid description: Identificador único do registro. purchaseAction: type: string allOf: – #/definitions/enumPurchaseActions description: Ação do teste/compra. purchaseDate: type: string format: date-time description: Data do teste/compra. reason: type: string maxLength: 255 description: Motivo da alteração do teste/compra. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: addressBra: description: Logradouros do Brasil type: object properties: id: type: string format: uuid description: Identificador único do registro city: type: string format: uuid description: Cidade do logradouro cep: type: string maxLength: 255 description: Cep do logradouro neighborhood: type: string maxLength: 255 description: Bairro do logradouro name: type: string maxLength: 255 description: Descrição do logradouro additional: type: string maxLength: 255 description: Complemento do logradouro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: externalModules: description: Modulos habilitados type: object required: – enumExternalModules properties: id: type: string format: uuid description: Identificador único do registro enumExternalModules: type: string allOf: – #/definitions/enumExternalModules description: Modulo habilitado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionContractBra: description: Informações de contrato da pré-admissão. type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador único do registro. preAdmission: type: object allOf: – #/definitions/preAdmission description: Pré-admissão. employeeContractType: type: string allOf: – #/definitions/employeeContractType description: Tipo de contrato. eSocialCategory: type: string allOf: – #/definitions/eSocialCategory description: Categoria eSocial. unemploymentInsuranceType: type: string allOf: – #/definitions/unemploymentInsuranceType description: Tipo do seguro desemprego. sefipCategoryType: type: string allOf: – #/definitions/sefipCategoryType description: Categoria SEFIP. employeeType: type: string allOf: – #/definitions/employeeType description: Tipo do colaborador. raisType: type: string allOf: – #/definitions/raisType description: Vínculo RAIS. company: type: string format: uuid description: Empresa para integração. branchOffice: type: string format: uuid description: Filial do contrato. jobPosition: type: string format: uuid description: Cargo do contrato. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: branchOffice: description: Cadastro de filial type: object properties: id: type: string format: uuid description: Identificador único do registro. company: type: object allOf: – #/definitions/company description: Estabelecimento matriz. branchOfficeName: type: string description: Razão social. tradingName: type: string description: Nome fantasia. enabled: type: string allOf: – #/definitions/situation description: Indicativo se a filial está ativa ou não. code: type: string description: Código do sistema externo. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: jobPosition: description: Cadastro de cargo type: object required: – name properties: id: type: string format: uuid description: Identificador único do registro. name: type: string maxLength: 255 description: Nome. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o cargo está ativo ou não. code: type: string description: Código externo. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelInvitationLayout: description: Entidade que permitirá a customização da tela de envio de convites. type: object required: – inviteModel – description – mandatory properties: id: type: string format: uuid description: Identificador único do registro. inviteModel: type: object allOf: – #/definitions/inviteModel description: Modelo de convite. description: type: string maxLength: 255 description: Descrição do campo. field: type: string allOf: – #/definitions/enumInvitationFieldsType description: Campo que permitirá configuração. mandatory: type: boolean description: Indica se o campo será obrigatório. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: professionalAdvice: description: Conselho profissional type: object required: – name properties: id: type: string format: uuid description: Identificador único do registro name: type: string description: Nome do conselho profissional abbreviation: type: string maxLength: 10 description: Sigla do conselho profissional enabled: type: string allOf: – #/definitions/situation description: Indicativo se o conselho profissional está ativo ou não. code: type: string description: Código externo. professionalRecord: type: array items: type: object allOf: – #/definitions/professionalRecord description: Registro profissional. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: professionalRecord: description: Dados do registro profissional type: object properties: id: type: string format: uuid description: Identificador único do registro professionalAdvice: type: object allOf: – #/definitions/professionalAdvice description: Conselho profissional number: type: string description: Número de registro no conselho profissional isTemporary: type: string allOf: – #/definitions/enumYesNo description: É temporário? mteNumber: type: string description: Número do registro profissional no ministério do trabalho (MTE) shippingDate: type: string format: date description: Data de expedição do registro dueDate: type: string format: date description: Data de vencimento do registro doesntHave: type: boolean description: Se a pessoa não possui registro profissional default: false firstFile: type: string maxLength: 300 description: Primeira imagem. secondFile: type: string maxLength: 300 description: Segunda imagem. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentBRA: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentBRA description: Relacionamento da preAdmissionDocumentBRA createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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 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