onboarding

2.0info: 2.7.4 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: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /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/contractInviteModelFieldQuery: 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: – inviteModelId properties: inviteModelId: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os campos para montar layout tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/canUpdateSLA: post: description: Retorna se o usuário atual possui permissão para alterar o SLA da pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se o usuário atual possui permissão para alterar o SLA da pré-admissão tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da consulta 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/fileMimeTypeInfo: post: description: Retorna o mimetype de um array de byte em base64 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – base64Content properties: base64Content: type: string description: Conteúdo do arquivo em base64 responses: 200: description: Ok schema: type: object required: – mimeType properties: mimeType: type: string description: MimeType default: description: Error response schema: #/definitions/genericError get: description: Retorna o mimetype de um array de byte em base64 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: base64Content description: Conteúdo do arquivo em base64 in: query required: true type: string responses: 200: description: Ok schema: type: object required: – mimeType properties: mimeType: type: string description: MimeType 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.\nEsta 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.\nCaso 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.\nCaso 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/inviteModelTermQuery: post: description: Retorna os dados do termo vinculado ao modelo de convite 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/inviteModelTermData description: termo vinculado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados do termo vinculado ao modelo de convite 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/inviteModelTermData description: termo vinculado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionTermQuery: post: description: Verifica e retorna o termo para aceite do candidato 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/preAdmissionTermData description: Campos da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica e retorna o termo para aceite do candidato 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/preAdmissionTermData description: Campos da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionCountByStatus: post: description: API DEPRECIADA: Use a versão 2 | DATA: 2023-10-30 | Retorna a quantidade de registros relacionado aos estados de uma pré-admissão. tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess – statusInSignature – statusSigned 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). statusInSignature: type: string description: Filtros que indicam a quantidade de pré-admissões em assinatura. statusSigned: type: string description: Filtros que indicam a quantidade de pré-admissões assinadas. contractFilter: type: object allOf: – #/definitions/contractFilterData description: Filtros para abrangência. responses: 200: description: Ok schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess – statusInSignature – statusSigned 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). statusInSignature: type: integer format: int64 description: Filtros que indicam a quantidade de pré-admissões em assinatura. statusSigned: type: integer format: int64 description: Filtros que indicam a quantidade de pré-admissões assinadas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionCountByStatus__2: 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 properties: filter: type: object allOf: – #/definitions/preAdmissionFilterData description: Filtro responses: 200: description: Ok schema: type: object required: – statusAll – statusInProgress – statusInValidation – statusComplete – statusInHiringProcess – statusInSignature – statusSigned 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). statusInSignature: type: integer format: int64 description: Filtros que indicam a quantidade de pré-admissões em assinatura. statusSigned: type: integer format: int64 description: Filtros que indicam a quantidade de pré-admissões assinadas. 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.\nCaso 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.\nCaso 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: API DEPRECIADA: Use a versão 2 | DATA: 2023-10-30 | Retorna as informações básicas da pré-admissão. tags: – Queries deprecated : true 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. displayFields: type: array items: type: string description: retorno do displayFields 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/preAdmissionListQuery__2: 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. filter: type: object allOf: – #/definitions/preAdmissionFilterData description: Filtros para abrangência. displayFields: type: array items: type: string description: retorno do displayFields tab: type: string allOf: – #/definitions/listQueryTab description: Aba 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 required: – filter 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 required: true 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/ethnicityListQuery: post: description: Retorna as informações básicas da etnia. 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/ethnicity description: Relação das etnias. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da etnia. 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/ethnicity description: Relação das etnias. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/termOfPrivacyListQuery: 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/termOfPrivacy 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/termOfPrivacy description: Relação das empresas. 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/costCenterListQuery: post: description: Retorna as informações do cadastro de centro de custo. 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/costCenter description: Relação das centros de custos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de centro de custo. 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/costCenter description: Relação das centros de custos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/workstationGroupListQuery: post: description: Retorna as informações do cadastro de postos de trabalho. 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/workstationGroup description: Relação dos postos de trabalho. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de postos de trabalho. 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/workstationGroup description: Relação dos postos de trabalho. 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 filiais. 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 filiais. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/areaListQuery: 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. companyId: type: string description: Id da empresa 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/area description: Relação das áreas. 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 – name: companyId description: Id da empresa 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/area description: Relação das áreas. 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: Resultado 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: Resultado 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/disabilitiesListQuery: post: description: Retorna as informações do cadastro de deficiências do candidato. 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/disabilities description: Relação das deficiências. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de deficiências do candidato. 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/disabilities description: Relação das deficiências. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/epsAffiliationListQuery: post: description: Retorna as informações básicas da epsAffiliation. 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/eps description: Relação da epsAffiliation. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da epsAffiliation. 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/eps description: Relação da epsAffiliation. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/afpAffiliationListQuery: post: description: Retorna as informações básicas da afpAffilition. 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/eps description: Relação da afpAffilition. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da afpAffilition. 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/eps description: Relação da afpAffilition. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/severanceAffiliationListQuery: post: description: Retorna as informações básicas da severanceAffilition. 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/eps description: Relação da severanceAffilition. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da severanceAffilition. 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/eps description: Relação da severanceAffilition. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionContractModelQuery: post: description: Retorna os modelos de documento que possuam o campo type com o valor SEND_PRE_ADMISSION. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/contractModelData description: Lista com os modelos de documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os modelos de documento que possuam o campo type com o valor SEND_PRE_ADMISSION. tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/contractModelData description: Lista com os modelos de documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/preAdmissionContractModelSendListQuery: post: description: Retorna os dados dos modelos de documentos enviados ao candidato no envio ou reenvio da 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 properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionContractModelSendData description: Lista de contratos enviados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados dos modelos de documentos enviados ao candidato no envio ou reenvio da 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 properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionContractModelSendData description: Lista de contratos enviados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeQuery: post: description: Retorna todos os dados 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 – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. token: type: string description: Token de Acesso 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 dados 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 – name: token description: Token de Acesso 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/employeeGetTranslations: post: description: Retorna as traduções do employee tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do serviço serviceName: type: string description: Nome do produto responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/bundleFile minimum: 1 description: Informações de teste compra do produto. default: description: Error response schema: #/definitions/genericError get: description: Retorna as traduções do employee tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do serviço in: query required: true type: string – name: serviceName description: Nome do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/bundleFile minimum: 1 description: Informações de teste compra do produto. 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/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 required: – token 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. token: type: string description: Token de Acesso linkId: type: string description: linkId 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 – name: token description: Token de Acesso in: query required: true type: string – name: linkId description: linkId 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/employeeDependentTemplateQuery: post: description: Retorna o template do payload do dependente para ser usado no gerador dinâmoco do frontend. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token properties: token: type: string description: Token de Acesso 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 o template do payload do dependente para ser usado no gerador dinâmoco do frontend. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: token description: Token de Acesso 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/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 – token properties: dependentId: type: string description: Identificador único do dependente. token: type: string description: Token de Acesso 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 – name: token description: Token de Acesso 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/employeeTermQuery: post: description: Verifica e retorna o termo para aceite do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeeModelTermData description: Campos da pré-admissão default: description: Error response schema: #/definitions/genericError get: description: Verifica e retorna o termo para aceite do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão in: query required: true type: string – name: token description: Token de Acesso in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeeModelTermData description: Campos da pré-admissão 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/employeeEthnicityListQuery: post: description: Retorna as informações básicas da etnia. 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/ethnicity description: Relação das etnias. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da etnia. 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/ethnicity description: Relação das etnias. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCompanyListQuery: post: description: Retorna as informações básicas do cadastro de empresas do Payroll.\nEste 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.\nEste 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/employeeDisabilitiesListQuery: post: description: Retorna as informações do cadastro de deficiências do candidato. 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/disabilities description: Relação das deficiências. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do cadastro de deficiências do candidato. 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/disabilities description: Relação das deficiências. 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/employeeCheckUnreadMessages: post: description: Retorna se contem mensagens não lidas para o Colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – linkId properties: linkId: 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: boolean description: Retorno se contem ou não mensagens default: description: Error response schema: #/definitions/genericError get: description: Retorna se contem mensagens não lidas para o Colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: linkId 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: boolean description: Retorno se contem ou não mensagens default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeCaptchaForSocialQualificationQuery: post: description: API DEPRECIADA: Deprecado devido a não existir mais a necessidade de captcha na qualificação cadastral | DATA: 2024-07-11 | Retorna o captcha para o usuário preencher tags: – Queries deprecated : true 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: API DEPRECIADA: Deprecado devido a não existir mais a necessidade de captcha na qualificação cadastral | DATA: 2024-07-11 | Retorna o captcha para o usuário preencher tags: – Queries deprecated : true 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 – token 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\npermitirá a finalização do processo. default: false token: type: string description: Token de Acesso 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 type: string – name: captcha description: Captcha do desafio in: query 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\npermitirá a finalização do processo. in: query type: boolean – name: token description: Token de Acesso in: query required: true type: string 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 – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. token: type: string description: Token de Acesso 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 – name: token description: Token de Acesso 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/getExternalModulesAndPurchaseHistoryQuery: post: description: Query para buscar as informações da tabela external_modules e purchaseHistory tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – username – key properties: tenant: type: string description: Tenant que será será feita a busca. username: type: string description: Usuário existente para acesso ao tenant key: type: string description: Senha de acesso a API responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultPurchaseExternal description: Resultado da operação default: description: Error response schema: #/definitions/genericError get: description: Query para buscar as informações da tabela external_modules e purchaseHistory tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant que será será feita a busca. in: query required: true type: string – name: username description: Usuário existente para acesso ao tenant in: query required: true type: string – name: key description: Senha de acesso a API in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultPurchaseExternal description: Resultado da operação default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeEpsAffiliationListQuery: post: description: Retorna as informações básicas da EpsAffiliation. 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/eps description: Relação das epsAffiliation. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da EpsAffiliation. 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/eps description: Relação das epsAffiliation. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeAfpAffiliationListQuery: post: description: Retorna as informações básicas da AfpAffiliation. 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/eps description: Relação das AfpAffiliation. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da AfpAffiliation. 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/eps description: Relação das AfpAffiliation. default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeSeveranceAffiliationListQuery: post: description: Retorna as informações básicas da SeveranceAffiliation. 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/eps description: Relação das SeveranceAffiliation. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas da SeveranceAffiliation. 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/eps description: Relação das SeveranceAffiliation. default: description: Error response schema: #/definitions/genericError /onboarding/queries/canSummaryPreAdmission: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se é possível resumir a pré-admissão. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se é possível resumir a pré-admissão. 401: description: Invalid Credentials 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/autocompleteFilterCostCenter: post: description: Retorna os centros de custos 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 os centros de custos 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/employeeContractModelQuery: post: description: Retorna os contratos vinculados ao modelo de convite tags: – Queries 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. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/contractModelData minimum: 1 description: Lista de modelos de contratos a serem assinados pelo colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os contratos vinculados ao modelo de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId description: Código do modelo de convite. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/contractModelData minimum: 1 description: Lista de modelos de contratos a serem assinados pelo colaborador. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeContractQuery: post: description: Retorna os contratos enviados da 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: Código do modelo de convite. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/envelopeTree minimum: 1 description: Lista de contratos enviados na pré admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os contratos enviados da pré admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Código do modelo de convite. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/envelopeTree minimum: 1 description: Lista de contratos enviados na pré admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/requestUpload: post: description: Solicita o upload de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome que irá corresponder ao arquivo. responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Solicita o upload de um documento tags: – Queries x-senior-visibility: PUBLIC parameters: – name: fileName description: Nome que irá corresponder ao arquivo. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fileUrl – uploadUrl properties: fileUrl: type: string description: Url do arquivo do arquivo. uploadUrl: type: string description: Url onde deverá ocorrer o download do arquivo. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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/chatGptGenerateJobDescriptionQuery: post: description: Query no ChatGPT tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – keyword properties: keyword: type: string description: Palavra chave com o cargo. campaign: type: string description: Campanha responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resposta do ChatGPT default: description: Error response schema: #/definitions/genericError get: description: Query no ChatGPT tags: – Queries x-senior-visibility: PRIVATE parameters: – name: keyword description: Palavra chave com o cargo. in: query required: true type: string – name: campaign description: Campanha in: query type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resposta do ChatGPT default: description: Error response schema: #/definitions/genericError /onboarding/queries/getPreAdmissionHistory: post: description: Busca os registros de histórico de movimentações da 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 maxLength: 36 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/preAdmissionHistoryData minimum: 1 description: Resultado da busca de histórico de movimentações da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os registros de histórico de movimentações da 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 maxLength: 36 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/preAdmissionHistoryData minimum: 1 description: Resultado da busca de histórico de movimentações da pré-admissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/getEnabledFeatures: post: description: Retorna uma lista de feature-toggle habilitadas para o tenant atual tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – features properties: features: type: array items: type: string minimum: 1 description: lista de features habilitadas default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de feature-toggle habilitadas para o tenant atual tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – features properties: features: type: array items: type: string minimum: 1 description: lista de features habilitadas default: description: Error response schema: #/definitions/genericError /onboarding/queries/componentEntityConfigurationQuery: post: description: Retorna a lista de entidades configuradas de acordo com o país do modelo de convite tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – country properties: country: type: string allOf: – #/definitions/inviteModelCountry description: País do modelo de convite responses: 200: description: Ok schema: type: object required: – entitiesList properties: entitiesList: type: array items: type: object allOf: – #/definitions/componentEntityConfigurationData minimum: 1 description: Lista de configuração das entidades default: description: Error response schema: #/definitions/genericError /onboarding/queries/employeeDocumentTypeListQuery: post: description: Retorna as informações básicas do tipo de documento colombiano. 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/documentTypeCOL description: Relação dos tipos de documento colombiano. default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do tipo de documento colombiano. 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/documentTypeCOL description: Relação dos tipos de documento colombiano. default: description: Error response schema: #/definitions/genericError /onboarding/queries/documentTypeListQuery: post: description: Retorna as informações básicas do tipo de documento colombiano. 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/documentTypeCOL description: Relação dos tipos de documento colombiano. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações básicas do tipo de documento colombiano. 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/documentTypeCOL description: Relação dos tipos de documento colombiano. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/inviteModelIntegrationQuery: post: description: Retorna os dados de integração do modelo de convite 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/inviteModelIntegrationData description: Modelo de convite de integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de integração do modelo de convite 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/inviteModelIntegrationData description: Modelo de convite de integração 401: description: Invalid Credentials 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: PRIVATE 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: PRIVATE 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/exportContractModel: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportEnvelope: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportContract: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportSigner: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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/exportCostCenter: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportWorkstationGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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/exportEmployeeToken: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportCustomEntityOne: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportCustomEntityTwo: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportCustomEntityThree: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionCustomEntities: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportTermOfPrivacy: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportCandidateTermOfPrivacy: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportInviteModelTerm: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportAuditRecord: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportAuditRecordJson: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportOcrExtractedText: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportOcrExtractedTextFields: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportGeneratedJobDescription: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportOcrTextractResults: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionStatusSummary: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportArea: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportRne: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionRegister: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportEthnicity: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportTypification: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionReasonWithdrawal: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDisabilities: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDisability: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDisabilityItem: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportComponentEntityConfiguration: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportInviteModelLayoutAttachment: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionMissingInformation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionPersonalCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPersonalBasicCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPersonalComplementaryCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPersonalAddressCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPersonalEmergencyContact: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionDocumentCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportIdentityDocumentCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportProfessionalRecordCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportMilitaryServiceBookCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDriverLicenseCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportEps: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDocumentTypeCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportEpsAffiliation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportAfpAffiliation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportSeveranceAffiliation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportWorkCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportWorkCertificateItem: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportStudyCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportStudyCertificateItem: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDocumentReference: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDocumentReferenceItem: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportBackgroundInformation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionDependentCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDependentDocumentCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDependentBasicCOL: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDependentSpouse: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDependentChild: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportDependentParent: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportPreAdmissionContractModelSend: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportInviteModelLayoutContract: post: description: tags: – Queries x-senior-visibility: PRIVATE 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/exportInviteModelIntegration: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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/alterDocumentModelEnabledStatus: post: description: Altera o status do modelo de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – enabled – contractModelId properties: enabled: type: boolean description: Novo status do modelo de contrato contractModelId: type: string description: Id do modelo de documento a ser alterado o status 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) emailsWithError: type: array items: type: string description: Lista de emails com erro no envio preAdmissionData: type: string description: Dados da pré-admissão 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/preAdmissionEdit: post: description: Edita um convite de um colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificação da pré-admissão. employeeName: type: string maxLength: 255 description: Nome do novo colaborador admissionDate: type: string format: date description: Data prevista de admissão do novo colaborador contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Dados do contrato. 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/preAdmissionEmployeeToken: post: description: Gera / Reseta token do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão do colaborador sendTokenOption: type: string allOf: – #/definitions/enumSendToken description: enumeration com opção de envio 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/preAdmissionEmployeeTokenResend: post: description: Gera / Reseta token do colaborador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: preAdmissionId: type: string description: Id da pré-admissão do colaborador sendTokenOption: type: string allOf: – #/definitions/enumSendToken description: enumeration com opção de envio 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/verifyPreAdmissionToken: post: description: Verifica a autenticidade do token tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – linkId – token properties: linkId: type: string description: linkID da preAdmissão token: type: string description: Token da pre-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/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 ignoreNotFound: type: boolean description: Ignorado se não encontrado 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 allOf: – #/definitions/preAdmissionSaveDTO 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 allOf: – #/definitions/preAdmissionSaveDTO 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/preAdmissionSaveAndValidate: post: description: Ação para salvar e validar uma pré-admissão pela mesa validadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/preAdmissionSaveDTO 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/preAdmissionSaveAndSendToValidatorDesk: post: description: Ação para salvar e enviar para Mesa de validação uma pré-admissão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/preAdmissionSaveDTO 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/preAdmissionBackToValidation: post: description: Ação para trocar status de uma pré-admissão para IN_VALIDATION. 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 alteração para em validação. message: type: string description: Mensagem detalhando a alteração para em validaçã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 – 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. basicCOL: type: object allOf: – #/definitions/dependentBasicCOLData description: Dados básicos Col. document: type: object allOf: – #/definitions/dependentDocumentData description: Dados dos documentos. documentCOL: type: object allOf: – #/definitions/dependentDocumentCOLData description: Dados dos documentos Col. validation: type: object allOf: – #/definitions/validationDataData description: Dados de validação. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. responses: 200: description: Ok schema: type: object required: – dependentId properties: dependentId: type: string 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/changeAreaStatus: post: description: Ativa ou inativa a área tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – areaId properties: areaId: 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/workStationGroupDelete: post: description: Exclui o posto de trabalho. 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 posto de trabalho 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/changeCostCenterStatus: post: description: Ativa ou inativa o centro de custo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – costCenterId properties: costCenterId: type: string description: Id do centro de custo 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/changeWorkstationGroupStatus: post: description: Ativa ou inativa o posto de trabalho tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workstationGroupId properties: workstationGroupId: type: string description: Id do posto de trabalho 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/preAdmissionCancel: post: description: API DEPRECIADA: Deprecated | DATA: 2024-10-25 | Cancelar uma pré-admissão tags: – Actions deprecated : true 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 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionInactive: post: description: Inativa uma pré-admissão tags: – Actions 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 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/preAdmissionActive: post: description: Ativa uma pré-admissão tags: – Actions 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 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da action 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/saveMultipleCompanies: post: description: Inserir empresas em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – company properties: company: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: Id 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/saveMultipleProfessionalAdvices: post: description: Inserir conselhos profissionais em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – professionalAdvice properties: professionalAdvice: type: array items: type: object allOf: – #/definitions/professionalAdvice minimum: 1 description: lista de professionalAdvice 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/saveMultipleJobPositions: post: description: Inserir cargos em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – jobPosition properties: jobPosition: type: array items: type: object allOf: – #/definitions/jobPosition minimum: 1 description: lista de jobPosition 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/saveMultipleReligions: post: description: Inserir religiões em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – religion properties: religion: type: array items: type: object allOf: – #/definitions/religion minimum: 1 description: lista de religion 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/saveMultipleEthnicity: post: description: Inserir etnias em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ethnicity properties: ethnicity: type: array items: type: object allOf: – #/definitions/ethnicity minimum: 1 description: lista de etnias 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/saveMultipleNationalities: post: description: Inserir nacionalidades em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nationality properties: nationality: type: array items: type: object allOf: – #/definitions/nationality minimum: 1 description: lista de nationality 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/saveMultipleDegreeOfEducation: post: description: Inserir graus de instrução em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – degreeOfEducation properties: degreeOfEducation: type: array items: type: object allOf: – #/definitions/degreeOfEducation minimum: 1 description: lista de degreeOfEducation 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/saveMultipleBanks: post: description: Inserir banco em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bank properties: bank: type: array items: type: object allOf: – #/definitions/bank minimum: 1 description: lista de bank 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/saveMultipleBranchOffice: post: description: Inserir filiais em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchOffice properties: branchOffice: type: array items: type: object allOf: – #/definitions/branchOffice minimum: 1 description: Id da branchOffice 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/saveMultipleArea: post: description: Inserir filiais em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – area properties: area: type: array items: type: object allOf: – #/definitions/area minimum: 1 description: Id da area 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/preAdmissionUpdateSLA: post: description: Altera o tipo de SLA de uma pré-admissão tags: – Actions 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/inviteModelUpdateTypification: post: description: Altera o status da tipificação no modelo de convite. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inviteModelId – typification properties: inviteModelId: type: string description: id do modelo de convite typification: type: boolean description: tipificação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/saveMultipleCostCenter: post: description: Inserir centros de custo em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – costCenter properties: costCenter: type: array items: type: object allOf: – #/definitions/costCenter minimum: 1 description: Registro de centro de custo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/saveMultipleWorkstationGroup: post: description: Inserir postos de trabalho em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workstationGroup properties: workstationGroup: type: array items: type: object allOf: – #/definitions/workstationGroup minimum: 1 description: Registro de posto de trabalho responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/createTaskIdToBreakCaptcha: post: description: Ação para criar o taskId para quebrar o captcha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – name – birthDate – cpf – pis – token properties: preAdmissionId: type: string description: Id da pré-admissão do colaborador 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 token: type: string description: Token da pre-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/disabilitiesDelete: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – disabilitiesId properties: disabilitiesId: type: string description: Id da deficiência responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/changeDisabilitiesStatus: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – disabilitiesId properties: disabilitiesId: type: string description: Id da deficiência responses: 200: description: Ok schema: type: object required: – result properties: result: type: string allOf: – #/definitions/situation description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/processTypificationResult: post: description: Ação para processar o resultado da tipificação de um documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – hash – result properties: id: type: string description: Id da pré-admissão do colaborador hash: type: string description: Hash da imagem que foi tipificada result: type: object allOf: – #/definitions/resultTypification description: Resultado da tipificação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /onboarding/actions/employeeTermAccepted: post: description: Ação para aceitar um termo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – data – token properties: preAdmissionId: type: string description: Identificador único da pré-admissão. actionUser: type: string allOf: – #/definitions/enumTermOfPrivacyCandidateAction description: Situação de aceite colaborador data: type: string format: date-time description: data e hora do aceite token: type: string description: Token de Acesso 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/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 – token – hash properties: preAdmissionId: type: string description: Identificador único da pré-admissão. hasDependent: type: boolean description: Identifica se existem dependentes. token: type: string description: Token de Acesso hash: type: string description: Hah de modificação 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: API DEPRECIADA: Use a versão 2 | DATA: 2024-09-19 | Ação para salvar as informações pessoais e documentos de uma pré-admissão na jornada do colaborador. tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personalData – personalColData – documentData – documentColData – customEntityData – hasDependent – saveAsDraft – token – hash properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. personalColData: type: object allOf: – #/definitions/preAdmissionPersonalCOLData description: Dados de informações pessoais COl. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. documentColData: type: object allOf: – #/definitions/preAdmissionDocumentCOLData description: Dados de documentos Col. customEntityData: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Dados de informações das entidades customizadas. hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso hash: type: string description: Hash de modificação 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__2: 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 allOf: – #/definitions/employeeSaveDTO 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 – saveAsDraft – token 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. basicCOL: type: object allOf: – #/definitions/dependentBasicCOLData description: Dados básicos Col. document: type: object allOf: – #/definitions/dependentDocumentData description: Dados dos documentos. documentCOL: type: object allOf: – #/definitions/dependentDocumentCOLData description: Dados dos documentos Col. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. token: type: string description: Token de Acesso responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/employeePreAdmissionDependentSaveData 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: API DEPRECIADA: Use a versão 2 | DATA: 2024-09-19 | 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 deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – personalData – personalColData – documentData – documentColData – saveAsDraft – hasDependent – token – hash properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. personalColData: type: object allOf: – #/definitions/preAdmissionPersonalCOLData description: Dados de informações pessoais Col. documentData: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. documentColData: type: object allOf: – #/definitions/preAdmissionDocumentCOLData description: Dados de documentos Col. customEntityData: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Entidades Customizadas saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. hasDependent: type: boolean description: Identifica se possui dependente token: type: string description: Token de Acesso hash: type: string description: Hash de modificação 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__2: 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 allOf: – #/definitions/employeeSaveDTO 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 – token properties: dependentId: type: string description: Identificador único do dependente. preAdmissionId: type: string description: Identificador único da pre-admissão token: type: string description: Token de Acesso 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 – clientCode – clientName – billingDate – preAdmissionAmount 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. clientCode: type: integer format: int64 description: Código do cliente do ERP. clientName: type: string maxLength: 255 description: Nome do cliente no ERP billingDate: type: string format: date-time description: Data de início do faturamento preAdmissionAmount: type: integer format: int64 description: Quantidade de admissões 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 – token properties: preAdmissionId: type: string description: Código da pré admissão. token: type: string description: Token de Acesso 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 – token 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 token: type: string description: Token de acesso ignoreNotFound: type: boolean description: Ignorado se não encontrado 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 – token properties: objects: type: array items: type: object allOf: – #/definitions/commitObjectDef minimum: 1 description: Lista de objetos para fazer o commit token: type: string description: Token de acesso linkId: type: string description: Id do link da pré-admissão hash: type: string description: Hash de alteração da pré-admissão 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 – token 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 token: type: string description: Token de acesso linkId: type: string description: Id do link da pré-admissão hash: type: string description: Hash de alteração da pré-admissão responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /onboarding/actions/documentsSend: post: description: Envia documentos para assinatura. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contracts – signer – instructionsToSigner – preAdmissionId properties: contracts: type: array items: type: object allOf: – #/definitions/contractData minimum: 1 description: Lista de documentos selecionados. signer: type: array items: type: object allOf: – #/definitions/signer minimum: 1 description: dados do assinante do contrato. instructionsToSigner: type: string description: Um texto com instruções para o assinante preAdmissionId: type: string description: ID da Pre Admissão demandGeolocation: type: boolean description: Obrigar geolocalização default: false sendSms: type: boolean description: Obrigar enviar por SMS default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/documentCancel: post: description: Cancela documento enviado para assinatura. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: ID de referencia do envelope na base responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/resendRequestSignMail: post: description: Reenvia o email de solicitação de assinatura. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – envelopeId properties: envelopeId: type: string description: Id do envelope signers: type: array items: type: string description: Lista com os emails dos assinantes, ou vazio para reenviar para todos que ainda não assinaram responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/documentConvert: post: description: Converte o documento de string HTML para PDF para envio ao GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – document properties: document: type: string description: HTML do documento a ser convertido responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação. default: description: Error response schema: #/definitions/genericError /onboarding/actions/reasonWithdrawalSend: post: description: Insere um registro de desistência de pré-admissão na base tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – enumWithdrawal properties: preAdmissionId: type: string description: Id da pré-admission enumWithdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Status da desistência/reabilitação reason: type: string description: Razão da desistência/reabilitação responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/resultBaseData description: Resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/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 – clientCode – clientName – billingDate – preAdmissionAmount 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 clientCode: type: integer format: int64 description: Código do cliente do ERP. clientName: type: string maxLength: 255 description: Nome do cliente no ERP billingDate: type: string format: date-time description: Data de início do faturamento preAdmissionAmount: type: integer format: int64 description: Quantidade de admissões 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/setUpPurchaseHistory: post: description: Realiza as configurações do purchase de um tenant existente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – username – clientCode – clientName – billingDate – preAdmissionAmount properties: tenant: type: string description: Tenant que será configurado. username: type: string description: Usuário existente que terá o papel do Onboarding vinculado. clientCode: type: integer format: int64 description: Código do cliente do ERP. clientName: type: string maxLength: 255 description: Nome do cliente no ERP billingDate: type: string format: date-time description: Data de início do faturamento preAdmissionAmount: type: integer format: int64 description: Quantidade de admissões 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/generateContentIA: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – promptKey properties: promptKey: type: string description: Prompt customizado que guiara a inteligência artificial. contextVariables: type: array items: type: object allOf: – #/definitions/rKeyValueData description: Variáveis que serão utilizadas na geração do conteúdo. responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação. 401: description: Invalid Credentials 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: PRIVATE 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: PRIVATE 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/importContractModel: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importEnvelope: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importContract: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importSigner: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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/importCostCenter: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importWorkstationGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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: PRIVATE 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/importEmployeeToken: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importCustomEntityOne: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importCustomEntityTwo: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importCustomEntityThree: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionCustomEntities: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importTermOfPrivacy: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importCandidateTermOfPrivacy: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importInviteModelTerm: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importAuditRecord: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importAuditRecordJson: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importOcrExtractedText: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importOcrExtractedTextFields: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importGeneratedJobDescription: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importOcrTextractResults: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionStatusSummary: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importArea: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importRne: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionRegister: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importEthnicity: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importTypification: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionReasonWithdrawal: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDisabilities: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDisability: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDisabilityItem: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importComponentEntityConfiguration: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importInviteModelLayoutAttachment: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionMissingInformation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionPersonalCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPersonalBasicCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPersonalComplementaryCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPersonalAddressCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPersonalEmergencyContact: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionDocumentCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importIdentityDocumentCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importProfessionalRecordCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importMilitaryServiceBookCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDriverLicenseCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importEps: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDocumentTypeCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importEpsAffiliation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importAfpAffiliation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importSeveranceAffiliation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importWorkCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importWorkCertificateItem: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importStudyCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importStudyCertificateItem: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDocumentReference: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDocumentReferenceItem: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importBackgroundInformation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionDependentCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDependentDocumentCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDependentBasicCOL: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDependentSpouse: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDependentChild: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importDependentParent: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importPreAdmissionContractModelSend: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importInviteModelLayoutContract: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/importInviteModelIntegration: post: description: tags: – Actions x-senior-visibility: PRIVATE 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/signals/verifyExpiredAuditRecord: post: description: Expira os registro de auditoria com mais de 3 meses 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/notifyInProgressPreAdmissions: post: description: Expira os registro de auditoria com mais de 3 meses 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/extractedDataFromFile: post: description: Primitiva que irá extrair textos dos arquivos tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/extractDataFromFile responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/typifyDocument: post: description: Primitiva que irá tipificar o documento tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/extractDataFromFile responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/getAllFilesFromPreAdmissionId: post: description: Busca todos os arquivos de uma pré admissão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/events/payrollPreAdmissionSaved: post: description: Notifica que um salvamento de Pré-admissão integrada com o Payroll\nfoi bem sucedida e envia no payload o ID do rascunho da pré-admissão\n x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – payrollDraftId properties: warning: type: boolean description: Indica sucesso com alerta default: false message: type: string description: Mensagem de retorno default: preAdmissionId: type: string description: ID da Pré-admissão do Colabbe payrollDraftId: type: string description: ID do admissionDraft do Payroll responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/externalPreAdmissionUpdated: post: description: Notifica quando uma admissão externa teve alguma informação relevante alterada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId – externalId properties: preAdmissionId: type: string description: ID da pré-admissão externalId: type: string description: ID externo da pré-admissão admissionDate: type: string format: date description: Data da admissão cpfNumber: type: string maxLength: 11 description: Número do CPF systemClientId: type: string maxLength: 40 description: ID do módulo externo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCountryFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCountryFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importContractModelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportContractModelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportEnvelopeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importSignerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportSignerEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelLayoutEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelLayoutEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionMessageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionMessageEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionDocumentBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionDocumentBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCtpsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCtpsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCpfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCpfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importRgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportRgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importVoterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportVoterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCnhEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCnhEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importReservistEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportReservistEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDnvEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDnvEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCnsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCnsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCivilCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCivilCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPassportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPassportEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importRicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportRicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importHiringMedicalExamEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportHiringMedicalExamEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importBankAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportBankAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importValidationDataEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportValidationDataEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importBankEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportBankEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importStateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportStateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importReligionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportReligionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importNationalityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportNationalityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDegreeOfEducationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDegreeOfEducationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionPersonalBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionPersonalBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalBasicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalBasicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalComplementaryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalComplementaryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalBirthPlaceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalBirthPlaceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalAddressBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalAddressBRAEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalTelephoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalTelephoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalEmailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalEmailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importSocialQualificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportSocialQualificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importSusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportSusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importVaccinationBookletEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportVaccinationBookletEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importProofOfEnrollmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportProofOfEnrollmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentBasicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentBasicEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentDocumentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionDependentBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionDependentBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPurchaseHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPurchaseHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAddressBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAddressBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importExternalModulesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportExternalModulesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionContractBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionContractBraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCostCenterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCostCenterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importWorkstationGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportWorkstationGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importBranchOfficeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportBranchOfficeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelInvitationLayoutEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelInvitationLayoutEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importProfessionalAdviceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportProfessionalAdviceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importProfessionalRecordEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportProfessionalRecordEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importEmployeeTokenEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportEmployeeTokenEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCustomEntityOneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCustomEntityOneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCustomEntityTwoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCustomEntityTwoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCustomEntityThreeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCustomEntityThreeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionCustomEntitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionCustomEntitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importTermOfPrivacyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportTermOfPrivacyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importCandidateTermOfPrivacyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportCandidateTermOfPrivacyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelTermEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelTermEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAuditRecordEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAuditRecordEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAuditRecordJsonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAuditRecordJsonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importOcrExtractedTextEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportOcrExtractedTextEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importOcrExtractedTextFieldsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportOcrExtractedTextFieldsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importGeneratedJobDescriptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportGeneratedJobDescriptionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importOcrTextractResultsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportOcrTextractResultsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionStatusSummaryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionStatusSummaryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAreaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAreaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importRneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportRneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionRegisterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionRegisterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importEthnicityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportEthnicityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importTypificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportTypificationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionReasonWithdrawalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionReasonWithdrawalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDisabilitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDisabilitiesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDisabilityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDisabilityEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDisabilityItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDisabilityItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importComponentEntityConfigurationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportComponentEntityConfigurationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelLayoutAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelLayoutAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionMissingInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionMissingInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionPersonalCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionPersonalCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalBasicCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalBasicCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalComplementaryCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalComplementaryCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalAddressCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalAddressCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPersonalEmergencyContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPersonalEmergencyContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importIdentityDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportIdentityDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importProfessionalRecordCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportProfessionalRecordCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importMilitaryServiceBookCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportMilitaryServiceBookCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDriverLicenseCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDriverLicenseCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importEpsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportEpsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDocumentTypeCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDocumentTypeCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importEpsAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportEpsAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAfpAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAfpAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importSeveranceAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportSeveranceAffiliationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importWorkCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportWorkCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importWorkCertificateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportWorkCertificateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importStudyCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportStudyCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importStudyCertificateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportStudyCertificateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDocumentReferenceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDocumentReferenceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDocumentReferenceItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDocumentReferenceItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importBackgroundInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportBackgroundInformationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionDependentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionDependentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentDocumentCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentBasicCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentBasicCOLEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentSpouseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentSpouseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentChildEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentChildEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importDependentParentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportDependentParentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importPreAdmissionContractModelSendEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportPreAdmissionContractModelSendEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelLayoutContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelLayoutContractEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importInviteModelIntegrationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportInviteModelIntegrationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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/contractModel: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractModel responses: 200: description: The created resource schema: #/definitions/contractModel 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/contractModel responses: 200: description: The created resource schema: #/definitions/contractModel 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contractModel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/contractModel/{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/contractModel responses: 200: description: Ok schema: #/definitions/contractModel 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/contractModel responses: 200: description: Ok schema: #/definitions/contractModel 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/contractModel 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/contractModel/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractModel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/envelope: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/envelope/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/envelope/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelope responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/contract: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contract responses: 200: description: The created resource schema: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contract responses: 200: description: The created resource schema: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/contract/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: Ok schema: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contract responses: 200: description: Ok schema: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/contract/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/signer: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signer responses: 200: description: The created resource schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/signer responses: 200: description: The created resource schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/signer/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: Ok schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/signer responses: 200: description: Ok schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/signer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/signer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/signer 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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/costCenter: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/costCenter/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/costCenter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/costCenter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workstationGroup: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstationGroup responses: 200: description: The created resource schema: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workstationGroup responses: 200: description: The created resource schema: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workstationGroup/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstationGroup responses: 200: description: Ok schema: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workstationGroup responses: 200: description: Ok schema: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/workstationGroup/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workstationGroup 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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: Esta entidade pode ser customizada. 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 /onboarding/entities/employeeToken: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeToken responses: 200: description: The created resource schema: #/definitions/employeeToken 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/employeeToken responses: 200: description: The created resource schema: #/definitions/employeeToken 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/employeeToken 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/employeeToken/{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/employeeToken responses: 200: description: Ok schema: #/definitions/employeeToken 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/employeeToken responses: 200: description: Ok schema: #/definitions/employeeToken 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/employeeToken 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/employeeToken/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeToken responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityOne: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityOne responses: 200: description: The created resource schema: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityOne responses: 200: description: The created resource schema: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityOne/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityOne responses: 200: description: Ok schema: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityOne responses: 200: description: Ok schema: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customEntityOne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/customEntityOne/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customEntityOne responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityTwo: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityTwo responses: 200: description: The created resource schema: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityTwo responses: 200: description: The created resource schema: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityTwo/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityTwo responses: 200: description: Ok schema: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityTwo responses: 200: description: Ok schema: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customEntityTwo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/customEntityTwo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customEntityTwo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityThree: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityThree responses: 200: description: The created resource schema: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customEntityThree responses: 200: description: The created resource schema: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/customEntityThree/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityThree responses: 200: description: Ok schema: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customEntityThree responses: 200: description: Ok schema: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customEntityThree 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/customEntityThree/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customEntityThree responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionCustomEntities: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionCustomEntities responses: 200: description: The created resource schema: #/definitions/preAdmissionCustomEntities 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/preAdmissionCustomEntities responses: 200: description: The created resource schema: #/definitions/preAdmissionCustomEntities 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionCustomEntities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionCustomEntities/{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/preAdmissionCustomEntities responses: 200: description: Ok schema: #/definitions/preAdmissionCustomEntities 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/preAdmissionCustomEntities responses: 200: description: Ok schema: #/definitions/preAdmissionCustomEntities 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/preAdmissionCustomEntities 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/preAdmissionCustomEntities/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionCustomEntities responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/termOfPrivacy: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/termOfPrivacy responses: 200: description: The created resource schema: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/termOfPrivacy responses: 200: description: The created resource schema: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/termOfPrivacy/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termOfPrivacy responses: 200: description: Ok schema: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/termOfPrivacy responses: 200: description: Ok schema: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/termOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/termOfPrivacy/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/termOfPrivacy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/candidateTermOfPrivacy: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/candidateTermOfPrivacy responses: 200: description: The created resource schema: #/definitions/candidateTermOfPrivacy 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/candidateTermOfPrivacy responses: 200: description: The created resource schema: #/definitions/candidateTermOfPrivacy 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/candidateTermOfPrivacy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/candidateTermOfPrivacy/{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/candidateTermOfPrivacy responses: 200: description: Ok schema: #/definitions/candidateTermOfPrivacy 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/candidateTermOfPrivacy responses: 200: description: Ok schema: #/definitions/candidateTermOfPrivacy 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/candidateTermOfPrivacy 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/candidateTermOfPrivacy/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/candidateTermOfPrivacy responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelTerm: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelTerm responses: 200: description: The created resource schema: #/definitions/inviteModelTerm 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/inviteModelTerm responses: 200: description: The created resource schema: #/definitions/inviteModelTerm 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelTerm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelTerm/{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/inviteModelTerm responses: 200: description: Ok schema: #/definitions/inviteModelTerm 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/inviteModelTerm responses: 200: description: Ok schema: #/definitions/inviteModelTerm 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/inviteModelTerm 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/inviteModelTerm/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelTerm responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/auditRecord: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/auditRecord responses: 200: description: The created resource schema: #/definitions/auditRecord 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/auditRecord responses: 200: description: The created resource schema: #/definitions/auditRecord 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/auditRecord 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/auditRecord/{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/auditRecord responses: 200: description: Ok schema: #/definitions/auditRecord 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/auditRecord responses: 200: description: Ok schema: #/definitions/auditRecord 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/auditRecord 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/auditRecord/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/auditRecord responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/auditRecordJson: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/auditRecordJson responses: 200: description: The created resource schema: #/definitions/auditRecordJson 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/auditRecordJson responses: 200: description: The created resource schema: #/definitions/auditRecordJson 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/auditRecordJson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/auditRecordJson/{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/auditRecordJson responses: 200: description: Ok schema: #/definitions/auditRecordJson 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/auditRecordJson responses: 200: description: Ok schema: #/definitions/auditRecordJson 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/auditRecordJson 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/auditRecordJson/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/auditRecordJson responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrExtractedText: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ocrExtractedText responses: 200: description: The created resource schema: #/definitions/ocrExtractedText 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/ocrExtractedText responses: 200: description: The created resource schema: #/definitions/ocrExtractedText 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ocrExtractedText 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrExtractedText/{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/ocrExtractedText responses: 200: description: Ok schema: #/definitions/ocrExtractedText 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/ocrExtractedText responses: 200: description: Ok schema: #/definitions/ocrExtractedText 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/ocrExtractedText 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/ocrExtractedText/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocrExtractedText responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrExtractedTextFields: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ocrExtractedTextFields responses: 200: description: The created resource schema: #/definitions/ocrExtractedTextFields 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/ocrExtractedTextFields responses: 200: description: The created resource schema: #/definitions/ocrExtractedTextFields 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ocrExtractedTextFields 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrExtractedTextFields/{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/ocrExtractedTextFields responses: 200: description: Ok schema: #/definitions/ocrExtractedTextFields 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/ocrExtractedTextFields responses: 200: description: Ok schema: #/definitions/ocrExtractedTextFields 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/ocrExtractedTextFields 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/ocrExtractedTextFields/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocrExtractedTextFields responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/generatedJobDescription: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generatedJobDescription responses: 200: description: The created resource schema: #/definitions/generatedJobDescription 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/generatedJobDescription responses: 200: description: The created resource schema: #/definitions/generatedJobDescription 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/generatedJobDescription 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/generatedJobDescription/{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/generatedJobDescription responses: 200: description: Ok schema: #/definitions/generatedJobDescription 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/generatedJobDescription responses: 200: description: Ok schema: #/definitions/generatedJobDescription 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/generatedJobDescription 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/generatedJobDescription/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generatedJobDescription responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrTextractResults: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ocrTextractResults responses: 200: description: The created resource schema: #/definitions/ocrTextractResults 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/ocrTextractResults responses: 200: description: The created resource schema: #/definitions/ocrTextractResults 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ocrTextractResults 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ocrTextractResults/{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/ocrTextractResults responses: 200: description: Ok schema: #/definitions/ocrTextractResults 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/ocrTextractResults responses: 200: description: Ok schema: #/definitions/ocrTextractResults 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/ocrTextractResults 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/ocrTextractResults/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocrTextractResults responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionStatusSummary: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionStatusSummary responses: 200: description: The created resource schema: #/definitions/preAdmissionStatusSummary 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/preAdmissionStatusSummary responses: 200: description: The created resource schema: #/definitions/preAdmissionStatusSummary 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionStatusSummary 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionStatusSummary/{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/preAdmissionStatusSummary responses: 200: description: Ok schema: #/definitions/preAdmissionStatusSummary 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/preAdmissionStatusSummary responses: 200: description: Ok schema: #/definitions/preAdmissionStatusSummary 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/preAdmissionStatusSummary 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/preAdmissionStatusSummary/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionStatusSummary responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/area: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/area responses: 200: description: The created resource schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/area responses: 200: description: The created resource schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/area/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/area responses: 200: description: Ok schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/area responses: 200: description: Ok schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/area/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/area responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/rne: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rne responses: 200: description: The created resource schema: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rne responses: 200: description: The created resource schema: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/rne/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rne responses: 200: description: Ok schema: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rne responses: 200: description: Ok schema: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rne 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/rne/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rne responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionRegister: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionRegister responses: 200: description: The created resource schema: #/definitions/preAdmissionRegister 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/preAdmissionRegister responses: 200: description: The created resource schema: #/definitions/preAdmissionRegister 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionRegister/{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/preAdmissionRegister responses: 200: description: Ok schema: #/definitions/preAdmissionRegister 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/preAdmissionRegister responses: 200: description: Ok schema: #/definitions/preAdmissionRegister 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/preAdmissionRegister 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/preAdmissionRegister/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionRegister responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ethnicity: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ethnicity responses: 200: description: The created resource schema: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ethnicity responses: 200: description: The created resource schema: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/ethnicity/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ethnicity responses: 200: description: Ok schema: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ethnicity responses: 200: description: Ok schema: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ethnicity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/ethnicity/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ethnicity responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionHistory responses: 200: description: The created resource schema: #/definitions/preAdmissionHistory 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/preAdmissionHistory responses: 200: description: The created resource schema: #/definitions/preAdmissionHistory 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionHistory/{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/preAdmissionHistory responses: 200: description: Ok schema: #/definitions/preAdmissionHistory 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/preAdmissionHistory responses: 200: description: Ok schema: #/definitions/preAdmissionHistory 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/preAdmissionHistory 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/preAdmissionHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/typification: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/typification responses: 200: description: The created resource schema: #/definitions/typification 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/typification responses: 200: description: The created resource schema: #/definitions/typification 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/typification 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/typification/{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/typification responses: 200: description: Ok schema: #/definitions/typification 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/typification responses: 200: description: Ok schema: #/definitions/typification 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/typification 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/typification/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/typification responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionReasonWithdrawal: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionReasonWithdrawal responses: 200: description: The created resource schema: #/definitions/preAdmissionReasonWithdrawal 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/preAdmissionReasonWithdrawal responses: 200: description: The created resource schema: #/definitions/preAdmissionReasonWithdrawal 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionReasonWithdrawal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionReasonWithdrawal/{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/preAdmissionReasonWithdrawal responses: 200: description: Ok schema: #/definitions/preAdmissionReasonWithdrawal 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/preAdmissionReasonWithdrawal responses: 200: description: Ok schema: #/definitions/preAdmissionReasonWithdrawal 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/preAdmissionReasonWithdrawal 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/preAdmissionReasonWithdrawal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionReasonWithdrawal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disabilities: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/disabilities responses: 200: description: The created resource schema: #/definitions/disabilities 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/disabilities responses: 200: description: The created resource schema: #/definitions/disabilities 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/disabilities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disabilities/{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/disabilities responses: 200: description: Ok schema: #/definitions/disabilities 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/disabilities responses: 200: description: Ok schema: #/definitions/disabilities 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/disabilities 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/disabilities/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/disabilities responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disability: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/disability responses: 200: description: The created resource schema: #/definitions/disability 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/disability responses: 200: description: The created resource schema: #/definitions/disability 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/disability 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disability/{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/disability responses: 200: description: Ok schema: #/definitions/disability 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/disability responses: 200: description: Ok schema: #/definitions/disability 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/disability 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/disability/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/disability responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disabilityItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/disabilityItem responses: 200: description: The created resource schema: #/definitions/disabilityItem 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/disabilityItem responses: 200: description: The created resource schema: #/definitions/disabilityItem 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/disabilityItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/disabilityItem/{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/disabilityItem responses: 200: description: Ok schema: #/definitions/disabilityItem 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/disabilityItem responses: 200: description: Ok schema: #/definitions/disabilityItem 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/disabilityItem 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/disabilityItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/disabilityItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/componentEntityConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/componentEntityConfiguration responses: 200: description: The created resource schema: #/definitions/componentEntityConfiguration 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/componentEntityConfiguration responses: 200: description: The created resource schema: #/definitions/componentEntityConfiguration 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/componentEntityConfiguration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/componentEntityConfiguration/{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/componentEntityConfiguration responses: 200: description: Ok schema: #/definitions/componentEntityConfiguration 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/componentEntityConfiguration responses: 200: description: Ok schema: #/definitions/componentEntityConfiguration 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/componentEntityConfiguration 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/componentEntityConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/componentEntityConfiguration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayoutAttachment: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelLayoutAttachment responses: 200: description: The created resource schema: #/definitions/inviteModelLayoutAttachment 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/inviteModelLayoutAttachment responses: 200: description: The created resource schema: #/definitions/inviteModelLayoutAttachment 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelLayoutAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayoutAttachment/{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/inviteModelLayoutAttachment responses: 200: description: Ok schema: #/definitions/inviteModelLayoutAttachment 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/inviteModelLayoutAttachment responses: 200: description: Ok schema: #/definitions/inviteModelLayoutAttachment 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/inviteModelLayoutAttachment 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/inviteModelLayoutAttachment/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelLayoutAttachment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionMissingInformation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionMissingInformation responses: 200: description: The created resource schema: #/definitions/preAdmissionMissingInformation 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/preAdmissionMissingInformation responses: 200: description: The created resource schema: #/definitions/preAdmissionMissingInformation 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionMissingInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionMissingInformation/{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/preAdmissionMissingInformation responses: 200: description: Ok schema: #/definitions/preAdmissionMissingInformation 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/preAdmissionMissingInformation responses: 200: description: Ok schema: #/definitions/preAdmissionMissingInformation 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/preAdmissionMissingInformation 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/preAdmissionMissingInformation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionMissingInformation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionPersonalCOL: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionPersonalCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalCOL 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/preAdmissionPersonalCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionPersonalCOL 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionPersonalCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionPersonalCOL/{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/preAdmissionPersonalCOL responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalCOL 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/preAdmissionPersonalCOL responses: 200: description: Ok schema: #/definitions/preAdmissionPersonalCOL 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/preAdmissionPersonalCOL 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/preAdmissionPersonalCOL/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionPersonalCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBasicCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBasicCOL responses: 200: description: The created resource schema: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalBasicCOL responses: 200: description: The created resource schema: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalBasicCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasicCOL responses: 200: description: Ok schema: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalBasicCOL responses: 200: description: Ok schema: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/personalBasicCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalBasicCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalComplementaryCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalComplementaryCOL responses: 200: description: The created resource schema: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalComplementaryCOL responses: 200: description: The created resource schema: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalComplementaryCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementaryCOL responses: 200: description: Ok schema: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalComplementaryCOL responses: 200: description: Ok schema: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalComplementaryCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/personalComplementaryCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalComplementaryCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalAddressCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalAddressCOL responses: 200: description: The created resource schema: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalAddressCOL responses: 200: description: The created resource schema: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalAddressCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressCOL responses: 200: description: Ok schema: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalAddressCOL responses: 200: description: Ok schema: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalAddressCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/personalAddressCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalAddressCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalEmergencyContact: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalEmergencyContact responses: 200: description: The created resource schema: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personalEmergencyContact responses: 200: description: The created resource schema: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/personalEmergencyContact/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmergencyContact responses: 200: description: Ok schema: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personalEmergencyContact responses: 200: description: Ok schema: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personalEmergencyContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/personalEmergencyContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personalEmergencyContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDocumentCOL: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDocumentCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentCOL 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/preAdmissionDocumentCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionDocumentCOL 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDocumentCOL/{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/preAdmissionDocumentCOL responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentCOL 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/preAdmissionDocumentCOL responses: 200: description: Ok schema: #/definitions/preAdmissionDocumentCOL 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/preAdmissionDocumentCOL 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/preAdmissionDocumentCOL/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDocumentCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/identityDocumentCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/identityDocumentCOL responses: 200: description: The created resource schema: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/identityDocumentCOL responses: 200: description: The created resource schema: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/identityDocumentCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/identityDocumentCOL responses: 200: description: Ok schema: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/identityDocumentCOL responses: 200: description: Ok schema: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/identityDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/identityDocumentCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/identityDocumentCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalRecordCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalRecordCOL responses: 200: description: The created resource schema: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/professionalRecordCOL responses: 200: description: The created resource schema: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/professionalRecordCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecordCOL responses: 200: description: Ok schema: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/professionalRecordCOL responses: 200: description: Ok schema: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/professionalRecordCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/professionalRecordCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/professionalRecordCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/militaryServiceBookCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/militaryServiceBookCOL responses: 200: description: The created resource schema: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/militaryServiceBookCOL responses: 200: description: The created resource schema: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/militaryServiceBookCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/militaryServiceBookCOL responses: 200: description: Ok schema: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/militaryServiceBookCOL responses: 200: description: Ok schema: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/militaryServiceBookCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/militaryServiceBookCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/militaryServiceBookCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/driverLicenseCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/driverLicenseCOL responses: 200: description: The created resource schema: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/driverLicenseCOL responses: 200: description: The created resource schema: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/driverLicenseCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/driverLicenseCOL responses: 200: description: Ok schema: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/driverLicenseCOL responses: 200: description: Ok schema: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/driverLicenseCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/driverLicenseCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/driverLicenseCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/eps: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eps responses: 200: description: The created resource schema: #/definitions/eps 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/eps responses: 200: description: The created resource schema: #/definitions/eps 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/eps 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/eps/{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/eps responses: 200: description: Ok schema: #/definitions/eps 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/eps responses: 200: description: Ok schema: #/definitions/eps 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/eps 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/eps/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eps responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentTypeCOL: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentTypeCOL responses: 200: description: The created resource schema: #/definitions/documentTypeCOL 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/documentTypeCOL responses: 200: description: The created resource schema: #/definitions/documentTypeCOL 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/documentTypeCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentTypeCOL/{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/documentTypeCOL responses: 200: description: Ok schema: #/definitions/documentTypeCOL 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/documentTypeCOL responses: 200: description: Ok schema: #/definitions/documentTypeCOL 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/documentTypeCOL 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/documentTypeCOL/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentTypeCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/epsAffiliation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/epsAffiliation responses: 200: description: The created resource schema: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/epsAffiliation responses: 200: description: The created resource schema: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/epsAffiliation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/epsAffiliation responses: 200: description: Ok schema: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/epsAffiliation responses: 200: description: Ok schema: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/epsAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/epsAffiliation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/epsAffiliation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/afpAffiliation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/afpAffiliation responses: 200: description: The created resource schema: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/afpAffiliation responses: 200: description: The created resource schema: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/afpAffiliation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/afpAffiliation responses: 200: description: Ok schema: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/afpAffiliation responses: 200: description: Ok schema: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/afpAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/afpAffiliation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/afpAffiliation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/severanceAffiliation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/severanceAffiliation responses: 200: description: The created resource schema: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/severanceAffiliation responses: 200: description: The created resource schema: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/severanceAffiliation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/severanceAffiliation responses: 200: description: Ok schema: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/severanceAffiliation responses: 200: description: Ok schema: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/severanceAffiliation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/severanceAffiliation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/severanceAffiliation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workCertificate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workCertificate responses: 200: description: The created resource schema: #/definitions/workCertificate 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/workCertificate responses: 200: description: The created resource schema: #/definitions/workCertificate 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workCertificate/{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/workCertificate responses: 200: description: Ok schema: #/definitions/workCertificate 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/workCertificate responses: 200: description: Ok schema: #/definitions/workCertificate 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/workCertificate 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/workCertificate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workCertificate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workCertificateItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workCertificateItem responses: 200: description: The created resource schema: #/definitions/workCertificateItem 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/workCertificateItem responses: 200: description: The created resource schema: #/definitions/workCertificateItem 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workCertificateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/workCertificateItem/{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/workCertificateItem responses: 200: description: Ok schema: #/definitions/workCertificateItem 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/workCertificateItem responses: 200: description: Ok schema: #/definitions/workCertificateItem 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/workCertificateItem 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/workCertificateItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workCertificateItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/studyCertificate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/studyCertificate responses: 200: description: The created resource schema: #/definitions/studyCertificate 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/studyCertificate responses: 200: description: The created resource schema: #/definitions/studyCertificate 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/studyCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/studyCertificate/{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/studyCertificate responses: 200: description: Ok schema: #/definitions/studyCertificate 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/studyCertificate responses: 200: description: Ok schema: #/definitions/studyCertificate 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/studyCertificate 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/studyCertificate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/studyCertificate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/studyCertificateItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/studyCertificateItem responses: 200: description: The created resource schema: #/definitions/studyCertificateItem 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/studyCertificateItem responses: 200: description: The created resource schema: #/definitions/studyCertificateItem 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/studyCertificateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/studyCertificateItem/{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/studyCertificateItem responses: 200: description: Ok schema: #/definitions/studyCertificateItem 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/studyCertificateItem responses: 200: description: Ok schema: #/definitions/studyCertificateItem 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/studyCertificateItem 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/studyCertificateItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/studyCertificateItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentReference: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentReference responses: 200: description: The created resource schema: #/definitions/documentReference 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/documentReference responses: 200: description: The created resource schema: #/definitions/documentReference 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/documentReference 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentReference/{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/documentReference responses: 200: description: Ok schema: #/definitions/documentReference 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/documentReference responses: 200: description: Ok schema: #/definitions/documentReference 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/documentReference 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/documentReference/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentReference responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentReferenceItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentReferenceItem responses: 200: description: The created resource schema: #/definitions/documentReferenceItem 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/documentReferenceItem responses: 200: description: The created resource schema: #/definitions/documentReferenceItem 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/documentReferenceItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/documentReferenceItem/{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/documentReferenceItem responses: 200: description: Ok schema: #/definitions/documentReferenceItem 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/documentReferenceItem responses: 200: description: Ok schema: #/definitions/documentReferenceItem 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/documentReferenceItem 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/documentReferenceItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentReferenceItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/backgroundInformation: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/backgroundInformation responses: 200: description: The created resource schema: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/backgroundInformation responses: 200: description: The created resource schema: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/backgroundInformation/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/backgroundInformation responses: 200: description: Ok schema: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/backgroundInformation responses: 200: description: Ok schema: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/backgroundInformation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/backgroundInformation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/backgroundInformation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDependentCOL: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionDependentCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentCOL 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/preAdmissionDependentCOL responses: 200: description: The created resource schema: #/definitions/preAdmissionDependentCOL 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionDependentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionDependentCOL/{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/preAdmissionDependentCOL responses: 200: description: Ok schema: #/definitions/preAdmissionDependentCOL 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/preAdmissionDependentCOL responses: 200: description: Ok schema: #/definitions/preAdmissionDependentCOL 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/preAdmissionDependentCOL 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/preAdmissionDependentCOL/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionDependentCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentDocumentCOL: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentDocumentCOL responses: 200: description: The created resource schema: #/definitions/dependentDocumentCOL 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/dependentDocumentCOL responses: 200: description: The created resource schema: #/definitions/dependentDocumentCOL 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/dependentDocumentCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentDocumentCOL/{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/dependentDocumentCOL responses: 200: description: Ok schema: #/definitions/dependentDocumentCOL 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/dependentDocumentCOL responses: 200: description: Ok schema: #/definitions/dependentDocumentCOL 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/dependentDocumentCOL 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/dependentDocumentCOL/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentDocumentCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentBasicCOL: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentBasicCOL responses: 200: description: The created resource schema: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentBasicCOL responses: 200: description: The created resource schema: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentBasicCOL/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasicCOL responses: 200: description: Ok schema: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentBasicCOL responses: 200: description: Ok schema: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentBasicCOL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/dependentBasicCOL/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentBasicCOL responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentSpouse: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentSpouse responses: 200: description: The created resource schema: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentSpouse responses: 200: description: The created resource schema: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentSpouse/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentSpouse responses: 200: description: Ok schema: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentSpouse responses: 200: description: Ok schema: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentSpouse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/dependentSpouse/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentSpouse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentChild: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentChild responses: 200: description: The created resource schema: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentChild responses: 200: description: The created resource schema: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentChild/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentChild responses: 200: description: Ok schema: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentChild responses: 200: description: Ok schema: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentChild 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/dependentChild/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentChild responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentParent: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentParent responses: 200: description: The created resource schema: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dependentParent responses: 200: description: The created resource schema: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/dependentParent/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentParent responses: 200: description: Ok schema: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dependentParent responses: 200: description: Ok schema: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dependentParent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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/dependentParent/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dependentParent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionContractModelSend: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preAdmissionContractModelSend responses: 200: description: The created resource schema: #/definitions/preAdmissionContractModelSend 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/preAdmissionContractModelSend responses: 200: description: The created resource schema: #/definitions/preAdmissionContractModelSend 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/preAdmissionContractModelSend 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/preAdmissionContractModelSend/{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/preAdmissionContractModelSend responses: 200: description: Ok schema: #/definitions/preAdmissionContractModelSend 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/preAdmissionContractModelSend responses: 200: description: Ok schema: #/definitions/preAdmissionContractModelSend 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/preAdmissionContractModelSend 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/preAdmissionContractModelSend/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preAdmissionContractModelSend responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayoutContract: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelLayoutContract responses: 200: description: The created resource schema: #/definitions/inviteModelLayoutContract 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/inviteModelLayoutContract responses: 200: description: The created resource schema: #/definitions/inviteModelLayoutContract 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelLayoutContract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelLayoutContract/{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/inviteModelLayoutContract responses: 200: description: Ok schema: #/definitions/inviteModelLayoutContract 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/inviteModelLayoutContract responses: 200: description: Ok schema: #/definitions/inviteModelLayoutContract 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/inviteModelLayoutContract 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/inviteModelLayoutContract/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelLayoutContract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelIntegration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inviteModelIntegration responses: 200: description: The created resource schema: #/definitions/inviteModelIntegration 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/inviteModelIntegration responses: 200: description: The created resource schema: #/definitions/inviteModelIntegration 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/inviteModelIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/inviteModelIntegration/{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/inviteModelIntegration responses: 200: description: Ok schema: #/definitions/inviteModelIntegration 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/inviteModelIntegration responses: 200: description: Ok schema: #/definitions/inviteModelIntegration 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/inviteModelIntegration 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/inviteModelIntegration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inviteModelIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: inviteModelCountry: description: Países suportados no cadastro de modelos. type: string enum: – BRAZIL – COLOMBIA 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 – CUSTOM_ENTITIES categoryField: description: Categorias relacionadas ao campo. type: string enum: – BASIC – COMPLEMENTARY – PLACE_OF_BIRTH – ADDRESS – PHONES – EMAILS – DOCUMENT – INVITATION_LAYOUT – SOCIAL_QUALIFICATION – PATTERN – BANKINFO – CTPS – CPF – PIS – RG – VOTER_CARD – CNH – RESERVIST – DNV – CNS – CIVIL_CERTIFICATE – PASSPORT – CIVILIAN_IDENTITY_REGISTRY – HIRING_MEDICAL_EXAM – PROFESSIONAL_RECORD – DEPENDENT_CPF – DEPENDENT_RG – DEPENDENT_RIC – DEPENDENT_SUS_CARD – DEPENDENT_VACCINATION_BOOKLET – DEPENDENT_PROOF_OF_ENROLLMENT – DEPENDENT_DEATH_CERTIFICATE – DEPENDENT_BIRTH_CERTIFICATE – RECEIVE_SALARY_ADVANCE – IS_FOREIGN – CUSTOM_ENTITY1 – CUSTOM_ENTITY2 – CUSTOM_ENTITY3 – RNE – DISABILITY – EMERGENCY_CONTACT – IDENTITY_DOCUMENT – MILITARY_SERVICE_BOOK – DRIVER_LICENSE – EPS_AFFILIATION – AFP_AFFILIATION – SEVERANCE_AFFILIATION – WORK_CERTIFICATE – STUDY_CERTIFICATE – DOCUMENT_REFERENCE – BACKGROUND_INFORMATION – DEPENDENT_SPOUSE – DEPENDENT_CHILD – DEPENDENT_PARENTS listQueryTab: description: Tipo de Status de um convite. type: string enum: – ALL – IN_PROGRESS – IN_VALIDATION – FINISHED – IN_HIRING_PROCESS – IN_SIGNATURE – SIGNED 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 – DEPENDENT_FULL_NAME – DEPENDENT_DEGREE_OF_KINSHIP – DEPENDENT_GENDER – DEPENDENT_BIRTH_DATE – DEPENDENT_DECLARE_INCOME_TAX – DEPENDENT_MOTHER_NAME – DEPENDENT_MARITAL_STATUS – SOCIAL_QUALIFICATION – PATTERN_UPPERCASE – PATTERN_SPECIAL_CHARACTER – PATTERN_CAPITALIZE – PATTERN_PASCAL_CASE – CUSTOM_FIELD – PROFESSIONAL_ADVICE – EXEMPTION_DATE – MTE_NUMBER – REGITRY – TERM – DOCUMENT_FIRST_FILE – DOCUMENT_SECOND_FILE – DOCUMENT_THIRD_FILE – RA – DOCUMENT_ISSUE_DATE – DOCUMENT_CITY – IS_TEMPORARY – BOOK – DOCUMENT_NUMBER – SHEET – CATEGORY – DOCUMENT_STATE – DOCUMENT_SERIE – DOCUMENT_COUNTRY_ISSUING – FIRST_DATE_LICENCE – DOCUMENT_ISSUING_AGENT – DOCUMENT_DIGIT – BRANCH – BANK – ACCOUNT_TYPE – ACCOUNT_DIGIT – DISTRICT – SECTION – DOCUMENT_EXPIRATION_DATE – NOTARY_OFFICE – BANK_ACCOUNT – DOCUMENT_DOESNT_HAVE – CERTIFICATE_TYPE – ADDRESS_FILE – POSTAL_CODE – ADDRESS_TYPE – COMPLEMENT – NUMBER – NEIGHBORHOOD – ARRIVAL_DATE – RESIDENCE_TIME – VISA_TYPE – ORDINANCE_NUMBER – MARRIED_WITH_BRAZILIAN – BRAZILIAN_CHILDREN – IS_FOREIGN – RESIDENCY_END_DATE – HAS_DISABILITY – HAS_WORK_CERTIFICATE – HAS_STUDY_CERTIFICATE – HAS_DOCUMENT_REFERENCE – DISABILITY_TYPE – START_DATE – IS_REHABILITATED – IS_MAIN_DISABILITY – FIRST_NAME – MIDDLE_NAME – FIRST_SURNAME – SECOND_SURNAME – BLOOD_TYPE – BLOOD_FACTOR – HEIGHT – WEIGHT – FIRST_EMERGENCY_CONTACT_NAME – FIRST_EMERGENCY_CONTACT_KINSHIP – FIRST_EMERGENCY_CONTACT_PHONE – SECOND_EMERGENCY_CONTACT_NAME – SECOND_EMERGENCY_CONTACT_KINSHIP – SECOND_EMERGENCY_CONTACT_PHONE – DOCUMENT_TYPE – DOCUMENT_STATE_ISSUING – DOCUMENT_CITY_ISSUING – DOCUMENT_CATEGORY – DOCUMENT_CLASS – RESTRICTIONS – ENTITY_NAME – AFFILIATION_CCF – AFFILIATION_ARL – DEPENDENT_FIRST_NAME – DEPENDENT_FIRST_SURNAME – DEPENDENT_SECOND_SURNAME – DOCUMENT_NAME – DOCUMENT_REFERENCE – BENEFICIARY_EPS – COMPENSATION_FUND_BENEFICIARY – LIVES_WITH_COLLAB – DOCUMENT_FOURTH_FILE – DOCUMENT_FIFTH_FILE – HANDLE_ELETRONIC_PAYMENT textractDocumentType: description: Ordinal do documento em que será extraído OCR type: string enum: – FIRST_FILE – SECOND_FILE – THIRD_FILE typificationDocumentType: description: documentos que serão extraidos a tipificação type: string enum: – CNH – CNH_DIGITAL – CPF – CPF_PROOF – CTPS – CTPS_CIVIL_QUALIFICATION_NEW – CTPS_CIVIL_QUALIFICATION_OLD – CIVIL_CERTIFICATE – RG – VOTER_CARD – DIGITAL_VOTER_CARD – OTHER 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 – INACTIVE – IN_VALIDATION – FINISHED – PENDING_ADMISSION – STARTED_ADMISSION – FINISHED_ADMISSION – IN_SIGNATURE – SIGNED – PENDING_EMAIL – EMAIL_ERROR – VALIDATING_DESK – VALIDATED_BY_DESK – WITHDRAWAL 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 – CATEGORY_9995 – CATEGORY_9996 – CATEGORY_9997 – CATEGORY_9999 – CATEGORY_501 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 – THIRDPARTY 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 – MARRIAGE_CERTIFICATE_WITH_DIVORCE_ANNOTATION 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 – POST_DOCTORATE 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 – HAS_OCR – HAS_VALIDATOR_DESK – RECRUITMENT – MANAGEMENT_PANEL – ONBOARDING enumInvitationFieldsType: description: Enumaração dos campos disponíveis para customização das informações utilizadas no envio do convite. type: string enum: – KEY – COMPANY – BRANCH – CONTRACT_TYPE – JOB_POSITION – SPECIAL_CHARACTERS – UPPERCASE – AREA – COST_CENTER – WORKSTATION_GROUP enumMobilePhoneOption: description: Opção de comunicação via celular type: string enum: – SMS – WHATSAPP – ALL enumSendToken: description: Opção de comunicação via celular type: string enum: – SMS – EMAIL – ALL enumDocumentStatus: description: Enumeração de status dos documentos da assinatura eletrônica type: string enum: – PROCESSING – IN_SIGNATURE – PARTIAL_IN_SIGNATURE – CANCELED – SIGNED – FAILURE_PROCESSING_FILE – EXPIRED_GED – SIGNED_PARTIAL – DECLINED enumBloodType: description: Tipo de sangue type: string enum: – A – B – AB – O enumBloodFactor: description: Fator Sanguíneo type: string enum: – POSITIVE – NEGATIVE enumMilitaryServiceBookClassCOL: description: Classe do Livro de Serviço Militar type: string enum: – FIRST_CLASS – SECOND_CLASS enumDriverLicenseCategoryCOL: description: Categoria de Carteira de Motorista Colombia type: string enum: – A1 – A2 – B1 – B2 – B3 – C1 – C2 – C3 enumSocialSecurityTypeCOL: description: Tipo de Segurança Social Colombia type: string enum: – AFP – EPS – ARL – CCF – CESANTIAS enumDocumentReference: description: Referência de Documento type: string enum: – PERSONAL – WORK – FAMILY – FINANCIAL – ACADEMIC enumAddressTypeCOL: description: Tipo de Endereço Colombia type: string enum: – AC – AD – ADL – AER – AG – AGP – AK – AL – ALD – ALM – AP – APTDO – ATR – AUT – AV – AVIAL – BG – BL – BLV – BRR – C – CA – CAS – CC – CD – CEL – CEN – CIR – CL – CLJ – CN – CON – CONJ – CR – CRT – CRV – CS – DG – DP – DPTO – DS – ED – EN – ES – ESQ – ESTE – ET – EX – FCA – GJ – GS – GT – HC – HG – IN – IP – IPD – IPM – KM – LC – LM – LT – MD – MJ – MLL – MN – MZ – NOMBRE_VIA – NORTE – O – OCC – OESTE – OF – P – PA – PAR – PD – PH – PJ – PL – PN – POR – POS – PQ – PRJ – PS – PT – PW – RP – SA – SC – SD – SEC – SL – SM – SS – ST – SUITE – SUR – TER – TERPLN – TO – TV – TZ – UN – UR – URB – VRD – VTE – ZF – ZN contractModelType: description: Enumeração do tipo do Modelo de Documento type: string enum: – ELETRONIC_SIGNATURE – SEND_PRE_ADMISSION 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 enumConditionVisaType: description: Condição do visto do estrangeiro type: string enum: – PERMANENT – TEMPORARY – ASYLUM – REFUGEE – REFUGEE_APPLICANT – BORDER_COUNTRY_TO_BRAZIL – DISABILITY – PROVISIONAL_RESIDENCE_AND_AMNESTY – PERMANENCE_IN_BRAZIL_DUE_TO_CHILDREN_OR_SPOUSE – BENEFITED_BY_MERCOSUR – DEPENDENT_ON_DIPLOMATIC_AGENT – BENEFITED_BY_THE_TREATY_OF_FRIENDSHIP – OTHER_CONDITION enumResidenceTime: description: Tempo de Residência type: string enum: – DETERMINED – UNDETERMINED fieldTypeDef: description: Tipo de campo. type: string enum: – String – Boolean – Integer – Double – Date – DateTime – LocalDateTime – Time – Money – Uuid – Blob – Binary – Any – Enumeration – Record enumTermOfPrivacyCandidateAction: description: Idioma dos termos type: string enum: – ACCEPT – REVOCATION enumLogType: description: Tipos de log type: string enum: – INFO – WARN – ERROR enumWithdrawal: description: Tipo de desistência type: string enum: – WITHDRAWAL – NO_WITHDRAWAL enumOriginIntegration: description: Origem da integração type: string enum: – GRS – EXTERNAL – INTERNAL disabilityType: description: Tipos deficiências aceitas pelo eSocial. type: string enum: – PHYSICAL – INTELLECTUAL – VISUAL – MENTAL – HEARING – OTHER componentFieldsWidget: description: Frontend Dinâmico – Tipo de input type: string enum: – AUTO_COMPLETE – AUTO_COMPLETE_ENUM – CALENDAR – INPUT – INPUT_MASK – SWITCH – INPUT_COUNTRY_PHONE_PICKER – LINK – IMAGE componentCssClass: description: Frontend Dinâmico – Classe de css type: string enum: – COMMON_ONE – COMMON_TWO componentMaxDate: description: Frontend Dinâmico – Data máxima type: string enum: – TODAY componentEvents: description: Frontend Dinâmico – Eventos type: string enum: – VALIDATE_CEP – SAVE_CEP – VALIDATE_CIVIL_CERTIFICATE – VALIDATE_PHONE – VALIDATE_CIVIL_CERTIFICATE_MASK – RELOAD_CUSTOM_FIELDS_ON_CHANGE_ADDRESS componentQueryAutocomplete: description: Frontend Dinâmico – Pesquisa de campos autocomplete type: string enum: – PROFESSIONAL_ADVICE – STATE – CITY – COUNTRY – DEGREE_OF_EDUCATION – NATIONALITY – RELIGION – RACE – BANK – EPS_AFFILIATION – AFP_AFFILIATION – CESANTIAS_AFFILIATION – DOCUMENT_TYPE componentValidators: description: Frontend Dinâmico – Validação de campos type: string enum: – PATTERN – MAX_LENGTH – COLABBE_REQUIRED – COLABBE_VALID_CPF – COLABBE_VALID_NIS – COLABBE_LETTERS_AND_NUMBERS – COLABBE_NUMBERS componentMinDate: description: Frontend Dinâmico – Data mínima type: string enum: – TODAY typificationStatus: description: Status dos registros de tipificação de documentos type: string enum: – UNPROCESSED – PROCESSED – ERROR 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 – LOCALDATETIME – 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 validationDataData: description: Dados para validação type: object properties: id: type: string 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. validationUserName: type: string maxLength: 255 description: Nome do usuário textractResultsText: description: Resultados Textract type: object required: – text – confidence properties: text: type: string description: Texto extraído confidence: type: number format: double description: Nivel de confiança do texto extraído bundleFile: description: Bundle file information. type: object required: – language – url – overridden properties: language: type: string description: File language. url: type: string description: File URL. overridden: type: boolean description: Tenant overridden bundle. tenantUrl: type: string description: Custom translations file url 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 envelopeTree: description: Árvore de envelopes da pré admissão type: object required: – id – envelopeName – instructions – demandGeolocation – gedEnvelopeId – status – createdDate – contracts properties: id: type: string description: Identificador do envelope. envelopeName: type: string maxLength: 255 description: Nome do envelope instructions: type: string description: Instruções para o assinante. demandGeolocation: type: boolean description: Indicativo se o modelo de contrato está ativo ou não. gedEnvelopeId: type: string maxLength: 50 description: ID de referencia do envelope no GED signed: type: boolean description: Valida a resposta do colaborador default: false status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do envelope createdDate: type: string format: date-time description: Data de criação contracts: type: array items: type: object allOf: – #/definitions/contract minimum: 1 description: contratos do envelope 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 enabledPatterns: description: Retorno dos padrões usados type: object properties: uppercase: type: boolean description: Padrão – Letra Maiúscula specialCharacter: type: boolean description: Padrão – Caracteres Especiais capitalize: type: boolean description: Padrão – Primeira letra maiúscula pascalCase: type: boolean description: Padrão – Primeira letra de cada palavra maiúscula 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. entityName: type: string description: Nome da entidade 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. contractModelList: type: array items: type: object allOf: – #/definitions/contractModel description: Lista de modelos de contratos a serem assinados pelo colaborador inviteModelTerm: type: object allOf: – #/definitions/inviteModelTermData description: Termo do modelo de convite typification: type: boolean description: Informações tipificação inviteModelIntegration: type: object allOf: – #/definitions/inviteModelIntegrationData description: Informações do modelo de convite de integração 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 entityName: type: string maxLength: 255 description: Nome da Entidade do Campo customFieldKey: type: string maxLength: 255 description: Chave do campo customizado customLabel: type: string maxLength: 255 description: Label do Campo Customizado multiItemPropertyName: type: string maxLength: 255 description: Propriedade de cadastros múltiplos maxLength: type: integer format: int64 description: Frontend dinâmico – Tamanho máximo inputType: type: string allOf: – #/definitions/componentFieldsWidget description: Frontend dinâmico – Tipo de campo cssClass: type: string allOf: – #/definitions/componentCssClass description: Frontend dinâmico – CSS enumerationName: type: string description: Frontend dinâmico – Nome da enumeração mask: type: string description: Frontend dinâmico – Máscara maxDate: type: string allOf: – #/definitions/componentMaxDate description: Frontend dinâmico – Data máxima onBlur: type: array items: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onBlur onFocus: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onFocus onSelect: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onSelect onClear: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onClear enumQueryAutocomplete: type: string allOf: – #/definitions/componentQueryAutocomplete description: Frontend dinâmico – Query de autocomplete propertyName: type: string description: Frontend dinâmico – Nome da propriedade ignorePattern: type: boolean description: Frontend dinâmico – Ignorar pattern default: false autoCompleteCountry: type: boolean description: Frontend dinâmico – País no autocomplete default: false disableDropdown: type: boolean description: Frontend dinâmico – Desabilitar dropdown default: false componentValidators: type: array items: type: string allOf: – #/definitions/componentValidators description: Frontend dinâmico – Validações componentValidatorPattern: type: string description: Frontend dinâmico – Padrão de validação propertyNamesLink: type: array items: type: string description: Frontend dinâmico – Nome das propriedades do Widget.LINK separatorLink: type: string description: Frontend dinâmico – separador para o Widget.LINK multiItem: type: boolean description: Frontend dinâmico – campo pertence a um cadastro multiplo default: false minDate: type: string allOf: – #/definitions/componentMinDate description: Frontend dinâmico – Data mínima 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 costCenter: type: object allOf: – #/definitions/costCenter description: Centro de Custo workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Posto de Trabalho area: type: object allOf: – #/definitions/area description: Área 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. attachments: type: array items: type: object allOf: – #/definitions/inviteModelLayoutAttachmentData description: Dados dos anexos do layout do modelo de convite inviteModelLayoutContractData: type: array items: type: object allOf: – #/definitions/inviteModelLayoutContractData description: Dados dos contratos associados ao layout do modelo de convite. hash: type: string description: Hash de alteração 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: 255 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 employeeMobilePhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone celular 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 area: type: string description: Área workstationId: type: string description: ID Posto de trabalho costCenterId: type: string description: ID Centro de custo employeeMobilePhoneOption: type: string allOf: – #/definitions/enumMobilePhoneOption description: Opção de comunicação via celular fromIntegration: type: boolean description: flag se a chamada veio de integração default: false vacancyCode: type: integer format: int64 description: Código da vaga quando tem integração com GRS origin: type: string allOf: – #/definitions/enumOriginIntegration description: Origem do registro de integração externalId: type: string description: ID externo 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 inviteModelCountry: type: string allOf: – #/definitions/inviteModelCountry description: País do modelo de convite inviteModelTypification: type: boolean description: Tipificação no 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 personalColData: type: object allOf: – #/definitions/preAdmissionPersonalCOLData description: Dados pessoais document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Documentos documentCol: type: object allOf: – #/definitions/preAdmissionDocumentCOLData description: Documentos contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Contrato customEntityData: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Entidades Customizadas hasTerm: type: boolean description: Identifica se contem um termo default: false vacancyCode: type: integer format: int64 description: Código da vaga quando tem integração com GRS dependentInfoList: type: array items: type: object allOf: – #/definitions/dependentInfoList description: Validação dependentes withdrawal: type: object allOf: – #/definitions/enumInformationItemData description: Flag sinalizando se o candidato desistiu da pré-admissão withdrawalData: type: array items: type: object allOf: – #/definitions/preAdmissionReasonWithdrawalData description: Retorna todas os registros de desistência da pré-admissão hash: type: string description: Hash da pré-admissão 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. externalId: type: string description: ID externo da empresa 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: 11 description: Número. serie: type: string maxLength: 5 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsCtps: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação doesntHave: type: boolean description: Se a pessoa não possui CTPS isDigital: type: boolean description: Referencia do CTPS Digital cpfData: description: DTO com as informações do CPF. type: object properties: id: type: string description: Identificador único do CPF. number: type: string maxLength: 11 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsCpf: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação pisData: description: DTO com as informações do PIS. type: object properties: id: type: string description: Identificador único do PIS. number: type: string maxLength: 11 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsPis: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui PIS rgData: description: DTO com as informações do RG. type: object properties: id: type: string description: Identificador único do RG. number: type: string maxLength: 16 description: Número. issuer: type: string maxLength: 255 description: Órgão emissor. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issueDate: type: string format: date description: Data de emissão. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsRg: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui certificado de RG default: false typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação 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: 13 description: Número. votingDistrict: type: string maxLength: 3 description: Zona. votingSection: type: string maxLength: 4 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsVoter: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação doesntHave: type: boolean description: Se a pessoa não possui Título de eleitor cnhData: description: DTO com as informações da CNH. type: object properties: id: type: string description: Identificador único da CNH. number: type: string maxLength: 20 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsCnh: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação doesntHave: type: boolean description: Se a pessoa não possui CNH 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: 13 description: Número. serie: type: string maxLength: 1 description: Série. ra: type: string maxLength: 12 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsReservist: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsDnv: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui DNV 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: 15 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsCns: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui CNS 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: 32 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsCivilCertificate: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR typificationData: type: object allOf: – #/definitions/typificationData description: Tipificação doesntHave: type: boolean description: Se a pessoa não possui Certidão civil passportData: description: DTO com as informações do passaporte. type: object properties: id: type: string description: Identificador único do passaporte. number: type: string maxLength: 20 description: Número. issuer: type: string maxLength: 6 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsPassport: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui Passaporte ricData: description: DTO com as informações do RIC. type: object properties: id: type: string description: Identificador único do RIC. number: type: string maxLength: 11 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsRic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui RIC 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. fileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsHiringMedicalExam: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. examDate: type: string format: date description: Data do exame. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui Exame admissional 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. bankAccount: type: string maxLength: 12 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsBankAccount: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui Conta bancária handleElectronicPayment: type: object allOf: – #/definitions/enumInformationItemData description: Pagamento eletrônico? 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 maxLength: 20 description: Número de registro no conselho profissional isTemporary: type: object allOf: – #/definitions/enumInformationItemData description: É temporário? mteNumber: type: string maxLength: 255 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsProfessionalRecord: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR 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 rne: type: object allOf: – #/definitions/rneData description: Registro Nacional de Estrangeiro 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 – hasTerm properties: preAdmission: type: object allOf: – #/definitions/preAdmission description: Pre admissão inviteInfoLayout: type: object allOf: – #/definitions/inviteInfoLayoutData description: Layout do modelo do convite hasTerm: type: boolean description: verifica se conté um termo vinculado ao modelo de 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. disability: type: object allOf: – #/definitions/disabilityData description: Informações da disability 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 badgeFilePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do crachá. badgeFileUploadDate: type: string format: date-time description: Data do upload da imagem do crachá. gender: type: object allOf: – #/definitions/enumInformationItemData description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsPersonalBasic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR 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 degreeOfEducationFilePermanentUrl: type: string description: Caminho permanente do arquivo do arquivo que comprova o grau de instrução. degreeOfEducationFileUploadDate: type: string format: date-time description: Data do upload do arquivo do 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/validationDataData description: Indicação de validação do documento. customFieldsPersonalComplementary: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR ethnicity: type: object allOf: – #/definitions/ethnicity description: Etnia preAdmissionCustomEntitiesData: description: DTO com Dados das entidades Customizadas type: object properties: customEntityOne: type: object allOf: – #/definitions/customEntityOneData description: Relacionamento com a entidade customizada 1 customEntityTwo: type: object allOf: – #/definitions/customEntityTwoData description: Relacionamento com a entidade customizada 2 customEntityThree: type: object allOf: – #/definitions/customEntityThreeData description: Relacionamento com a entidade customizada 3 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/validationDataData 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 firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. additional: type: string maxLength: 255 description: Informação adicional referente ao endereço. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsPersonalAddressBRA: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR 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: 20 description: Número do telefone principal. firstType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do contato do telefone principal. firstPhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone principal. secondPhone: type: string maxLength: 20 description: Número do telefone secundário. secondType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do contato do telefone principal. secondPhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone secundário. validation: type: object allOf: – #/definitions/validationDataData 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/validationDataData 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 conclusionCustomEntityPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento da aba customizável default: 0 status: type: object allOf: – #/definitions/enumInformationItemData description: Status da pré-admissão. requestStatus: type: boolean description: Status da ação de salvar. employeePreAdmissionDependentSaveData: description: DTO com o retorno da ação de salvar o dependente da jornada do colaborador. type: object required: – conclusionPercentage – status – requestStatus – dependentId 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 conclusionCustomEntityPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento da aba customizável default: 0 status: type: object allOf: – #/definitions/enumInformationItemData description: Status da pré-admissão. requestStatus: type: boolean description: Status da ação de salvar. dependentId: type: string description: Id do dependente salvo preAdmissionListData: description: Pré-admissões. type: object required: – key – employeeName – sendDate – admissionDate – status – deadlineDate – inviteESocialStatus – hasDependent – canceled – createdDate – lastModifieldDate 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: 255 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 employeeMobilePhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone celular 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 conclusionCustomEntityPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento da aba customizável 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. canceled: type: boolean description: Cancelado conclusionOCRPercentage: type: integer format: int64 description: Percentual de conclusão dos campos com OCR default: 0 createdDate: type: string format: date description: retorno da Data inicial do envio do convite lastModifieldDate: type: string format: date description: retorno da Data final do envio do convite company: type: string description: Empresa branchOffice: type: string description: Filial jobPosition: type: string description: Cargo costCenter: type: string description: Centro de custo workstationGroup: type: string description: Posto de trabalho area: type: string description: Área contractType: type: string description: Tipo de contrato. validatorDeskInfo: type: object allOf: – #/definitions/validatorDeskInfoData description: Informações sobre o SLA da mesa validadora withdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Tipo de desistente endSLADate: type: string format: date-time description: Data/hora de término do SLA missingInformation: type: array items: type: string allOf: – #/definitions/categoryField description: Lista de categorias que não estão complemtamente preenchidas 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/validationDataData description: Indicação de validação do dependente. basicCOL: type: object allOf: – #/definitions/dependentBasicCOLData description: Dados básicos colombia documentCOL: type: object allOf: – #/definitions/dependentDocumentCOLData description: Documentos colombia 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 Civil. 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: 15 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. customFieldsSus: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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. secondFileUploadDate: type: string format: date-time description: Data do upload do 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. thirdFileUploadDate: type: string format: date-time description: Data do upload do primeiro 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 – isOcrEnabled – hasValidationDesk – hasAccessToHCMDatabase 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). isOcrEnabled: type: boolean description: Indica se utiliza OCR hasValidationDesk: type: boolean description: Indica se utiliza mesa de validação hasAccessToHCMDatabase: type: boolean description: Indica se tem acesso a base compartilhada 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. branchOfficeData: type: object allOf: – #/definitions/branchOfficeData description: 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 area: type: object allOf: – #/definitions/area description: Área do contrato jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo. workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Posto de trabalho. 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. dependentInfoList: description: informação dos dependentes type: object required: – dependentName – percentage properties: dependentName: type: string description: Nome do dependente percentage: type: integer format: int64 description: percentual de documentos validados OCR inviteModelLayoutAttachmentData: description: Dados do anexo do layout do modelo de convite type: object required: – size properties: id: type: string description: Identificador unico do registro fileId: type: string maxLength: 300 description: Identificador do arquivo fileName: type: string description: nome do arquivo fileVersion: type: string description: Identificador para fazer o commit do arquivo filePermanentUrl: type: string description: URL de acesso do arquivo fileUploadDate: type: string format: date-time description: Data/hora de upload do arquivo size: type: integer format: int64 description: Tamanho do arquivo em bytes branchOfficeData: description: DTO com as informações da filial. type: object properties: id: type: string description: Identificador único da filial. company: type: object allOf: – #/definitions/company description: Estabelecimento matriz. branchOfficeName: type: string maxLength: 255 description: Razão social. tradingName: type: string maxLength: 255 description: Nome fantasia. enabled: type: string allOf: – #/definitions/situation description: Indicativo se a filial está ativa ou não. code: type: string maxLength: 255 description: Código do sistema externo. country: type: object allOf: – #/definitions/country description: País de localização da filial. cep: type: string maxLength: 10 description: CEP do endereço da filial. state: type: object allOf: – #/definitions/state description: Estado de localização da filial city: type: object allOf: – #/definitions/city description: Cidade de localização da filial neighborhood: type: string maxLength: 255 description: Bairro do endereço da filial addressType: type: object allOf: – #/definitions/enumInformationItemData description: Logradouro endereço da filial address: type: string maxLength: 255 description: Endereço da filial number: type: string maxLength: 10 description: Número do endereço da filial additional: type: string maxLength: 255 description: Informações adicionais do endereço da filial cnpj: type: string maxLength: 14 description: CNPJ da filial inviteModelLayoutContractData: description: DTO com as informações do contrato. type: object properties: id: type: string description: Identificador unico do registro inviteModelLayoutId: type: string description: Identificador do layout do modelo de convite associado a esse registro contractModelId: type: string description: Identificador do modelo de documento associado a esse registro 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 roleFilterData: description: type: object properties: company: type: string description: ID Empresa. branchOffice: type: string description: ID Filial. costCenter: type: string description: ID Centro de custo preAdmissionFilterData: description: type: object properties: employeeName: type: string description: Nome do colaborador employeeEmail: type: string description: E-mail do colaborador employeeMobilePhone: type: string description: Telefone do colaborador key: type: string description: Número do documento admissionDate: type: string format: date description: Data de admissão inviteESocialStatus: type: string allOf: – #/definitions/eSocialStatus description: Status do eSocial modelId: type: string description: Modelo de convite deadline: type: integer format: int64 description: Prazo status: type: string allOf: – #/definitions/invitationStatus description: Status da pré-admissão statusNotIn: type: array items: type: string allOf: – #/definitions/invitationStatus description: Status da pré-admissão que devem ser ignorados conclusionPercentage: type: array items: type: integer format: int64 description: Porcentagem de conclusão conclusionOCRPercentage: type: array items: type: integer format: int64 description: Porcentagem de conclusão OCR createdDate: type: string format: date-time description: Data inicial do envio do convite deadlineDate: type: string format: date description: Data final do envio do convite company: type: string description: ID Empresa. branchOffice: type: string description: ID Filial. costCenter: type: string description: ID Centro de custo. jobPosition: type: string description: ID Cargo area: type: string description: ID Área employeeContractType: type: string allOf: – #/definitions/employeeContractType description: Enumeration do tipo de contrato noWithdrawal: type: boolean description: traz admissões não desistidas 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 area: type: string description: ID Área costCenter: type: string description: ID Centro de custo employeeContractType: type: string allOf: – #/definitions/employeeContractType description: Enumeration do tipo de contrato rKeyValueData: description: DTO Key e value type: object required: – key – value properties: key: type: string description: Chave value: type: string description: Valor name: type: string description: Nome 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 ocrExtractedTextData: description: DTO OCR type: object required: – category – accuracyText – valid properties: category: type: string allOf: – #/definitions/categoryField description: categoria da entidade, seguindo o padrão da categoria da tabela accuracyText: type: number format: double description: acurácia retornada pela api de extração ocrExtractedTextFields: type: array items: type: object allOf: – #/definitions/ocrExtractedTextFieldsData description: lista dos campos verificados valid: type: boolean description: indicador se todos os fields do ocr estão validados ocrExtractedTextFieldsData: description: DTO OCR Fields type: object required: – valueType – valid – similarity – text properties: valueType: type: string allOf: – #/definitions/valueType description: Tipos de valores aceitos pelo campo. valid: type: boolean description: valor que verifica se está válido ou não similarity: type: integer format: int64 description: similaridade dos textos text: type: string description: texto encontrado areaData: description: DTO Área type: object required: – id – name properties: id: type: string description: Identificador da área name: type: string description: Nome da área customFieldsArea: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. attachmentDTO: description: type: object required: – fileId – fileName – fileUrl properties: fileId: type: string description: Identificador do arquivo anexado fileName: type: string description: Nome do arquivo fileUrl: type: string description: Url/Localização do arquivo 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 – mandatory 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 opções do enumeration, utilizado quando o fieldTypeDef for Enumeration mandatory: type: boolean description: Verificador de campo obrigatório customEnumerationDef: description: Enum customizado multiplo 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: Enum customizado 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 contractModelData: description: Record de modelo de contrato. type: object required: – id – contractModelName – contract – checked – type properties: id: type: string description: Identificador do modelo de contrato. contractModelName: type: string maxLength: 255 description: Nome do modelo de contrato. contract: type: string description: Texto base do contrato. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o modelo de contrato está ativo ou não. checked: type: boolean description: Contrato padrão type: type: object allOf: – #/definitions/enumInformationItemData description: Tipo do documento contractData: description: Record de modelo de contrato. type: object required: – contractModelName – contractFileName – contract properties: contractModelName: type: string maxLength: 255 description: Nome do modelo de contrato. contractFileName: type: string maxLength: 255 description: Nome do documento do contrato contract: type: string description: Texto base do contrato. gedDocumentId: type: string description: ID de referencia do documento no GED gedDocumentURI: type: string description: URI do documento no GED gedDocumentVersionId: type: string description: ID de referencia da versão do documento no GED status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do documento resultPurchaseExternal: description: Retorno da API getExternalModulesAndPurchaseHistoryQuery type: object required: – resultMessage – purchaseHistory – externalModules properties: resultMessage: type: string description: Mensagem de resultado purchaseHistory: type: array items: type: object allOf: – #/definitions/purchaseHistory minimum: 1 description: Entidade purchaseHistory externalModules: type: array items: type: object allOf: – #/definitions/externalModules minimum: 1 description: Entidade externalModules tokenEmployeeData: description: DTO da entidade de token da pre-admissão colaborador type: object required: – token properties: token: type: string maxLength: 6 description: Token customEntityOneData: description: Entidade Customizada 1 type: object properties: id: type: string description: Identificador único do registro. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customEntityTwoData: description: Entidade Customizada 2 type: object properties: id: type: string description: Identificador único do registro. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. customEntityThreeData: description: Entidade Customizada 3 type: object properties: id: type: string description: Identificador único do registro. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFields: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. inviteModelTermData: description: Seção do termo de uso do modelo de convite. type: object properties: id: type: string description: Identificador da entidade. termOfPrivacy: type: object allOf: – #/definitions/termOfPrivacy description: Relacionamento com os termos de privacidade email: type: string maxLength: 100 description: Email do termo termOfPrivacyData: description: Seção do termo de uso para a pré-admissão. type: object required: – title – content properties: type: string description: Titulo do termo enabled: type: string allOf: – #/definitions/situation description: Indicativo se o termo está ativa ou não. content: type: string description: Conteúdo do termo de uso que deve ser fornecido nos idiomas employeeModelTermData: description: Seção do termo de uso para a pré-admissão. type: object required: – termOfPrivacy – email – termAccepted properties: termOfPrivacy: type: object allOf: – #/definitions/termOfPrivacyData description: Relacionamento com os termos de privacidade email: type: string maxLength: 100 description: Email do termo termAccepted: type: boolean description: Flag que retorna se o termo ja foi aceito dateAccepted: type: string format: date-time description: Data do aceite preAdmissionTermData: description: Seção do termo de uso para a pré-admissão. type: object required: – actionDate – termOfPrivacy – actionUser – email properties: actionDate: type: string format: date-time description: Data do aceite termOfPrivacy: type: object allOf: – #/definitions/termOfPrivacyData description: Relacionamento com os termos de privacidade actionUser: type: string allOf: – #/definitions/enumTermOfPrivacyCandidateAction description: Status da ação email: type: string maxLength: 100 description: Email do termo preAdmissionPercentageData: description: Record para valores de percentual e quantidade de obrigatórios type: object required: – documentMandatoryCount – personalDataMandatoryCount – dependentTotalMandatory – customEntitiesMandatoryCount – totalFields – documentPercentage – personalDataPercentage – dependentsPercentage – customEntityPercentage – eSocialPercentage properties: documentMandatoryCount: type: number format: double description: Quantidade de documentos obrigatórios personalDataMandatoryCount: type: number format: double description: Quantidade de dados pessoais obrigatórios dependentTotalMandatory: type: number format: double description: Quantidade de dependentes obrigatórios customEntitiesMandatoryCount: type: number format: double description: Quantidade de campos customizados obrigatórios totalFields: type: number format: double description: Total de campos obrigatórios documentPercentage: type: integer format: int64 description: percentual de documentos personalDataPercentage: type: integer format: int64 description: percentual de dados pessoais dependentsPercentage: type: integer format: int64 description: percentual de dependentes customEntityPercentage: type: integer format: int64 description: percentual de campos customizados eSocialPercentage: type: integer format: int64 description: percentual de e-social ocrPercentage: type: integer format: int64 description: Percentual de OCR default: 0 rneData: description: Dados do Registro Nacional de Estrangeiro type: object properties: id: type: string description: Identificador único do registro. arrivalDate: type: string format: date description: Data de chegada. residenceTime: type: object allOf: – #/definitions/enumInformationItemData description: Tempo de residência conditionVisaType: type: object allOf: – #/definitions/enumInformationItemData description: Condição de estrangeiro number: type: string maxLength: 255 description: Número issuer: type: string maxLength: 255 description: Emissor issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade ordinanceNumber: type: string maxLength: 255 description: Número da portaria marriedWithBrazilian: type: object allOf: – #/definitions/enumInformationItemData description: Casado com brasileiro brazilianChildren: type: object allOf: – #/definitions/enumInformationItemData description: Filhos brasileiros fathersName: type: string maxLength: 255 description: Nome do pai mothersName: type: string maxLength: 255 description: Nome da mãe birthDate: type: string format: date description: Data de nascimento 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. firstFileUploadDate: type: string format: date-time description: Data do upload do 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 segundo arquivo. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsRne: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR doesntHave: type: boolean description: Se a pessoa não possui RNE default: false residencyEndDate: type: string format: date description: Data de Término da Residência preAdmissionHistoryData: description: Dados do histórico de pré-admissão type: object required: – id – preAdmissionId – logDate – title – createdBy properties: id: type: string maxLength: 36 description: Identificador único do registro preAdmissionId: type: string description: Id da pré-admissão logDate: type: string format: date-time description: Data/hora que foi gerado o registro da pré-admissão type: string maxLength: 255 description: Título do registro de histórico description: type: string description: Descrição do registro de histórico createdBy: type: string description: Usuário que criou o registro typificationData: description: DTO da Tipificação type: object required: – averageAccuracy properties: type: type: string allOf: – #/definitions/categoryField description: Documento identificado averageAccuracy: type: number format: double description: média da acurácia status: type: string allOf: – #/definitions/typificationStatus description: status extractDataFromFile: description: DTO usado para as primitivas de OCR e Tipificação type: object required: – linkId – locationURL – version – categoryField – fileId – token – document properties: linkId: type: string description: Link Id da pre-Admissão locationURL: type: string description: URL da imagem S3 type: string description: Versão da imagem categoryField: type: string allOf: – #/definitions/categoryField description: Categoria da entidade fileId: type: string description: Id do arquivo token: type: string description: token da admissão document: type: string allOf: – #/definitions/textractDocumentType description: Numero do documento que será extraído environment: type: string description: Ambiente que o arquivo foi enviado preAdmissionReasonWithdrawalData: description: DTO com os dados de desistências das pré-admissões type: object properties: id: type: string description: Identificador único do registro preAdmission: type: string description: preAdmission a que se refere a motivação withdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Identificador da situação gerou do registro reason: type: string maxLength: 300 description: Justificativa da desistência componentEntityConfigurationData: description: type: object properties: country: type: string allOf: – #/definitions/inviteModelCountry description: País type: type: string allOf: – #/definitions/inviteFieldType description: Tipo de campo subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo category: type: string allOf: – #/definitions/categoryField description: Categoria do campo categoryName: type: string maxLength: 255 description: Nome da categoria propertyName: type: string maxLength: 255 description: Nome da propriedade da entidade no DTO entityName: type: string maxLength: 255 description: Nome da entidade entityOrder: type: integer format: int64 description: Ordenação description: type: string maxLength: 255 description: Chave de tradução entityNameFieldCustomization: type: string maxLength: 255 description: Nome da entidade no fieldCustomization preAdmissionSaveDTO: description: type: object required: – id – saveAsDraft properties: id: type: string description: Identificador único da pré-admissão. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados do documento. documentCol: type: object allOf: – #/definitions/preAdmissionDocumentCOLData description: Dados do documento Col. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. personalColData: type: object allOf: – #/definitions/preAdmissionPersonalCOLData description: Dados de informações pessoais Col. contract: type: object allOf: – #/definitions/preAdmissionContractBraData description: Dados do contrato. customEntityData: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Dados de informações das entidades customizadas. hasDependent: type: boolean description: Identifica se existem dependentes. saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. employeeSaveDTO: description: type: object required: – id – saveAsDraft – hasDependent – token – hash properties: id: type: string description: Identificador único da pré-admissão. personalData: type: object allOf: – #/definitions/preAdmissionPersonalBRAData description: Dados de informações pessoais. personalColData: type: object allOf: – #/definitions/preAdmissionPersonalCOLData description: Dados de informações pessoais Col. document: type: object allOf: – #/definitions/preAdmissionDocumentBRAData description: Dados de documentos. documentCol: type: object allOf: – #/definitions/preAdmissionDocumentCOLData description: Dados de documentos Col. customEntityData: type: object allOf: – #/definitions/preAdmissionCustomEntitiesData description: Entidades Customizadas saveAsDraft: type: boolean description: Identifica se está salvando como rascunho. hasDependent: type: boolean description: Identifica se possui dependente token: type: string description: Token de Acesso hash: type: string description: Hash de modificação disabilityData: description: DTO com os dados da deficiência do candidato type: object properties: id: type: string description: Identificador único do registro preAdmissionId: type: string description: Pré-admissão a que se refere a deficiência disabilityItem: type: array items: type: object allOf: – #/definitions/disabilityItemData description: Deficiências do candidato hasDisability: type: boolean description: Informa se o candidato tem deficiência validation: type: object allOf: – #/definitions/validationDataData description: Dados de validação customFieldsDisability: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados disabilityItemData: description: Registro de informações de deficiência do candidato. type: object properties: id: type: string description: Identificador único do registro disabilityType: type: object allOf: – #/definitions/disabilitiesData description: Tipo de deficiência startDate: type: string format: date description: Data de início da deficiência isRehabilitated: type: boolean description: É reabilitado isMainDisability: type: boolean description: É a principal deficiência customFieldsDisabilityItem: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados disabilitiesData: description: DTO com as informações do cadastro de deficiências type: object properties: id: type: string description: Identificador único do registro name: type: string maxLength: 255 description: Descrição da deficiência type: type: object allOf: – #/definitions/enumInformationItemData description: Tipo de deficiência validatorDeskInfoData: description: DTO para conter as informações de SLA da mesa validadora type: object required: – severity – message properties: severity: type: string allOf: – #/definitions/enumLogType description: Identifica no front de qual cor vai ser exibida a mensagem message: type: string description: Mensagem do SLA, pode ser a quantidade de horas remanescentes/violadas ou uma mensagem formatada preAdmissionPersonalCOLData: description: DTO dos pessoais da pré-admissão Col. type: object properties: id: type: string description: Identificador único do registro. basic: type: object allOf: – #/definitions/personalBasicCOLData description: Dados básicos da pré-admissão. complementary: type: object allOf: – #/definitions/personalComplementaryCOLData description: Dados complementares da pré-admissão. emergencyContact: type: object allOf: – #/definitions/personalEmergencyContactData description: Contato emergencial da pré-admissão. birthPlace: type: object allOf: – #/definitions/personalBirthPlaceData description: Dados do local de nascimento. address: type: object allOf: – #/definitions/personalAddressCOLData description: Dados do endereço. telephone: type: object allOf: – #/definitions/personalTelephoneData description: Dados do telefones para contato. email: type: object allOf: – #/definitions/personalEmailData description: Dados de emails para contato. personalBasicCOLData: description: DTO dos dados pessoais básicos da pré-admissão Col. type: object properties: id: type: string description: Identificador único do registro. firstName: type: string maxLength: 25 description: Primeiro nome do novo colaborador. middleName: type: string maxLength: 75 description: Nome do meio do novo colaborador. firstSurname: type: string maxLength: 50 description: Primeiro sobrenome do novo colaborador. secondSurname: type: string maxLength: 50 description: Segundo sobrenome 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. badgeFileUploadDate: type: string format: date-time description: Data do upload da imagem do crachá badgeFileVersion: type: string description: Versão para realizar o commit do arquivo badgeFilePermanentUrl: type: string description: Caminho permanente do arquivo da imagem do crachá. gender: type: object allOf: – #/definitions/enumInformationItemData description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 customFieldsPersonalBasic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR personalComplementaryCOLData: description: DTO com Dados complementares da pré-admissão Col. type: object properties: id: type: string description: Identificador da tabela firstFileId: type: string maxLength: 300 description: Primeiro arquivo firstFileUploadDate: type: string format: date-time description: Primeira data de carremento do arquivo firstFilePermanentUrl: type: string description: Caminho permanente do arquivo do arquivo firstFileVersion: type: string description: Versão para realizar o commit do anexo maritalStatus: type: object allOf: – #/definitions/enumInformationItemData description: Estado civil degreeOfEducation: type: object allOf: – #/definitions/degreeOfEducation description: Grau de instrução nationality: type: object allOf: – #/definitions/nationality description: Nacionalidade religion: type: object allOf: – #/definitions/religion description: Religião ethnicity: type: object allOf: – #/definitions/ethnicity description: Etnia socialName: type: string maxLength: 255 description: Nome social bloodType: type: object allOf: – #/definitions/enumInformationItemData description: Tipo sanguineo bloodFactor: type: object allOf: – #/definitions/enumInformationItemData description: fator do sangue height: type: string maxLength: 8 description: Altura weight: type: string maxLength: 8 description: Peso validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 customFieldsPersonalComplementary: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR personalAddressCOLData: description: DTO dos dados do endereço da pré-admissão Col. 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. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFileVersion: type: string description: Versão para realizar o commit do primeiro arquivo firstFilePermanentUrl: type: string description: Url de acesso a 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/validationDataData description: Indicação de validação do documento. customFieldsPersonalAddressCOL: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR personalEmergencyContactData: description: DTO com dados do contato de emergência Col. type: object properties: id: type: string description: Identificador único do registro. firstContactName: type: string maxLength: 255 description: Nome do primeiro contato. firstContactKinship: type: object allOf: – #/definitions/enumInformationItemData description: Parentesco do primeiro contato. firstContactPhone: type: string maxLength: 255 description: Telefone do primeiro contato. firstContactPhoneCountryId: type: string maxLength: 5 description: ID do país do telefone do primeiro contato. secondContactName: type: string maxLength: 255 description: Nome do segundo contato. secondContactKinship: type: object allOf: – #/definitions/enumInformationItemData description: Parentesco do segundo contato. secondContactPhone: type: string maxLength: 255 description: Telefone do segundo contato. secondContactPhoneCountryId: type: string maxLength: 5 description: ID do país do telefone do primeiro contato. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. customFieldsPersonalEmergencyContact: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 preAdmissionDocumentCOLData: description: DTO documentos relacionados a pré-admissão Col. type: object properties: id: type: string description: Identificador único do registro. identityDocument: type: object allOf: – #/definitions/identityDocumentCOLData description: Dados do documento de identidade. professionalRecord: type: object allOf: – #/definitions/professionalRecordCOLData description: Registro profissional. militaryServiceBook: type: object allOf: – #/definitions/militaryServiceBookCOLData description: Certificado de reservista driverLicense: type: object allOf: – #/definitions/driverLicenseCOLData description: Licença de condução epsAffiliation: type: object allOf: – #/definitions/epsAffiliationData description: Afiliação EPS afpAffiliation: type: object allOf: – #/definitions/afpAffiliationData description: Afiliação AFP severanceAffiliation: type: object allOf: – #/definitions/severanceAffiliationData description: Afiliação de indenização bankAccount: type: object allOf: – #/definitions/bankAccountData description: Dados bancários. workCertificate: type: object allOf: – #/definitions/workCertificateData description: Certificado de trabalho studyCertificate: type: object allOf: – #/definitions/studyCertificateData description: Certificado de estudo documentReference: type: object allOf: – #/definitions/documentReferenceData description: Referência de documento backgroundInformation: type: object allOf: – #/definitions/backgroundInformationData description: Informações de fundo passport: type: object allOf: – #/definitions/passportData description: Relacionamento da passport identityDocumentCOLData: description: DTO dados do documento de identidade Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. documentType: type: object allOf: – #/definitions/documentTypeCOL description: Tipo do documento issueDate: type: string format: date description: Data de emissão. issuerCountry: type: object allOf: – #/definitions/country description: País de emissão. issuerState: type: object allOf: – #/definitions/state description: Estado de emissão. issuerCity: type: object allOf: – #/definitions/city description: Cidade de emissão. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. doesntHave: type: boolean description: Se a pessoa não possui documento de identificação? customFieldsIdentityDocument: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. professionalRecordCOLData: description: DTO com dados do registro profissional Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. issueDate: type: string format: date description: Data de emissão. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui registro profissional default: false firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsProfessionalRecord: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR militaryServiceBookCOLData: description: DTO dados do documento de serviço militar Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. issueDate: type: string format: date description: Data de emissão. militaryServiceBookClass: type: object allOf: – #/definitions/enumInformationItemData description: Relacionamento da militaryServiceBookClassCOL district: type: string description: Distrito do documento. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. customFieldsMilitaryServiceBook: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui dados do livro de serviço militar ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR driverLicenseCOLData: description: DTO dados do documento de licença de condução Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. category: type: object allOf: – #/definitions/enumInformationItemData description: Categoria do documento. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. issuer: type: string description: Emissor do documento. restrictions: type: string description: Restrições do documento. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. customFieldsDriverLicense: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui dados de licença de motorista ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR epsData: description: DTO dados do documento de afiliação EPS Col. type: object properties: id: type: string description: Identificador único do registro. code: type: integer format: int64 description: Código do documento name: type: string description: Nome EPS type: type: string allOf: – #/definitions/enumSocialSecurityTypeCOL description: Tipo EPS documentTypeCOLData: description: DTO dados do tipo de documento Col. type: object properties: id: type: string description: Identificador único do registro. code: type: integer format: int64 description: Código do documento name: type: string description: Nome do documento epsAffiliationData: description: DTO dados da afiliação EPS Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: object allOf: – #/definitions/eps description: Nome da EPS validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. customFieldsEpsAffiliation: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui EPS ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR afpAffiliationData: description: DTO dados da afiliação AFP Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: object allOf: – #/definitions/eps description: Nome da AFP validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. customFieldsAfpAffiliation: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui AFP ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR severanceAffiliationData: description: DTO dados da afiliação de indenização Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: object allOf: – #/definitions/eps description: Nome da afiliação de indenização validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. customFieldsSeveranceAffiliation: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui dados de indenização de afiliação ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR workCertificateData: description: DTO dados do certificado de trabalho Col. type: object properties: id: type: string description: Identificador único do registro. refPreAdmissionId: type: string description: Pré-admissão a que se refere o certificado de trabalho workCertificateItem: type: array items: type: object allOf: – #/definitions/workCertificateItemData description: Item do certificado de trabalho hasWorkCertificate: type: boolean description: Informa se o candidato tem certificado trabalho doesntHave: type: boolean description: Não possui default: false validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. workCertificateItemData: description: DTO dados do item certificado de trabalho Col. type: object properties: id: type: string description: Identificador único do registro. workCertificateId: type: object allOf: – #/definitions/workCertificateData description: Certificado de trabalho firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR name: type: string description: Nome do item do certificado de trabalho studyCertificateData: description: DTO dados do certificado de estudo Col. type: object properties: id: type: string description: Identificador único do registro. studyCertificateItem: type: array items: type: object allOf: – #/definitions/studyCertificateItemData description: Item do certificado de estudo refPreAdmissionId: type: string description: Pré-admissão a que se refere o certificado de estudo hasStudyCertificate: type: boolean description: Informa se o candidato tem certificado estudo doesntHave: type: boolean description: Não possui default: false validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. studyCertificateItemData: description: DTO dados do item certificado de estudo Col. type: object properties: id: type: string description: Identificador único do registro. studyCertificateId: type: object allOf: – #/definitions/studyCertificateData description: Certificado de estudo firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR name: type: string description: Nome do item do certificado de estudo documentReferenceData: description: DTO dados do documento de referência Col. type: object properties: id: type: string description: Identificador único do registro. documentReferenceItem: type: array items: type: object allOf: – #/definitions/documentReferenceItemData description: Item do documento de referência refPreAdmissionId: type: string description: Pré-admissão a que se refere o documento de referencia hasDocumentReference: type: boolean description: Informa se o candidato tem certificado estudo doesntHave: type: boolean description: Não possui default: false validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. documentReferenceItemData: description: DTO dados do item documento de referência Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR reference: type: object allOf: – #/definitions/enumInformationItemData description: Nome do item do documento de referência backgroundInformationData: description: DTO dados do documento de fundo Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. thirdFileId: type: string maxLength: 300 description: Terceira imagem. thirdFileUploadDate: type: string format: date-time description: Data do upload do terceiro arquivo. validation: type: object allOf: – #/definitions/validationDataData description: Indicação de validação do documento. validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. thirdFilePermanentUrl: type: string description: URL de acesso ao terceiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. thirdFileVersion: type: string description: Identificador para efetuar o commit do terceiro arquivo. customFieldsBackgroundInformation: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. doesntHave: type: boolean description: Se a pessoa não possui dados de documento de fundo ocrExtractedTextData: type: object allOf: – #/definitions/ocrExtractedTextData description: OCR preAdmissionDependentCOLData: description: DTO dados do dependente Col. type: object properties: id: type: string description: Identificador único do registro. basicCOL: type: object allOf: – #/definitions/dependentBasicCOLData description: Dados básicos do dependente. documentCOL: type: object allOf: – #/definitions/dependentDocumentCOLData description: Dados do documento 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 documento. dependentDocumentCOLData: description: DTO dados do documento do dependente Col. type: object properties: id: type: string description: Identificador único do registro. spouse: type: object allOf: – #/definitions/dependentSpouseData description: Cônjuge dependente. child: type: object allOf: – #/definitions/dependentChildData description: Filho dependente. parent: type: object allOf: – #/definitions/dependentParentData description: Parente dependente dependentBasicCOLData: description: DTO dados basicos do dependente Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFilePermanentUrl: type: string description: URL do arquivo firstFileVersion: type: string description: Versão do arquivo firstName: type: string maxLength: 255 description: Primeiro nome do dependente. firstSurname: type: string description: Primeiro sobrenome secondSurname: type: string description: Segundo sobrenome number: type: string maxLength: 20 description: Número do dependente epsBeneficiary: type: object allOf: – #/definitions/enumInformationItemData description: EPS beneficiario do dependente? compensationFundBeneficiary: type: object allOf: – #/definitions/enumInformationItemData description: Compensação de fundo beneficiario do dependente? livesWithCollab: type: object allOf: – #/definitions/enumInformationItemData description: Vive com o colaborador? degreeOfKinship: type: object allOf: – #/definitions/enumInformationItemData description: Grau de parentesco. gender: type: object allOf: – #/definitions/enumInformationItemData description: Gênero do dependente birthDate: type: string format: date description: Data de nascimento do dependente. declareIncomeTax: type: object allOf: – #/definitions/enumInformationItemData description: Declara imposto de renda? documentType: type: object allOf: – #/definitions/documentTypeCOL description: Tipo do documento maritalStatus: type: object allOf: – #/definitions/enumInformationItemData description: Estado civil customFieldsDependentBasic: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentSpouseData: description: DTO dados do dependente cônjuge Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. customFieldsDependentSpouse: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentChildData: description: DTO dados do dependente filho Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFileId: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. thirdFileId: type: string maxLength: 300 description: Terceira imagem. thirdFileUploadDate: type: string format: date-time description: Data do upload do terceiro arquivo. fourthFileId: type: string maxLength: 300 description: Quarta imagem. fourthFileUploadDate: type: string format: date-time description: Data do upload do quarto arquivo. fifthFileId: type: string maxLength: 300 description: Quinta imagem. fifthFileUploadDate: type: string format: date-time description: Data do upload do quinto arquivo. firstFileVersion: type: string description: Identificador para efetuar o commit do primeiro arquivo. firstFilePermanentUrl: type: string description: URL de acesso ao primeiro arquivo. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. thirdFileVersion: type: string description: Identificador para efetuar o commit do terceiro arquivo. thirdFilePermanentUrl: type: string description: URL de acesso ao terceiro arquivo. fourthFileVersion: type: string description: Identificador para efetuar o commit do quarto arquivo. fourthFilePermanentUrl: type: string description: URL de acesso ao quarto arquivo. fifthFileVersion: type: string description: Identificador para efetuar o commit do quinto arquivo. fifthFilePermanentUrl: type: string description: URL de acesso ao quinto arquivo. customFieldsDependentChild: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. dependentParentData: description: DTO dados do dependente parente Col. type: object properties: id: type: string description: Identificador único do registro. firstFileId: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do 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: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. secondFileVersion: type: string description: Identificador para efetuar o commit do segundo arquivo. secondFilePermanentUrl: type: string description: URL de acesso ao segundo arquivo. customFieldsDependentParent: type: array items: type: object allOf: – #/definitions/customData description: Campos customizados. resultTypification: description: DTO com as informações de tipificação de documentos do candidato type: object required: – className – confidenceScore properties: className: type: string description: Classe que identifica o tipo de documento confidenceScore: type: number format: double description: Acurácia do resultado obtido preAdmissionContractModelSendData: description: DTO com os dados do contrato da pré-admissão para envio type: object properties: id: type: string description: Identificador único do registro preAdmissionId: type: string description: Identificador da pré-admissão que o registro está associado fileId: type: string description: Identificador do arquivo enviado para o candidato (blobservice) filePermanentUrl: type: string description: URL permanente do arquivo (blobservice) inviteModelIntegrationData: description: Modelo de convite de integração type: object properties: id: type: string description: Identificador da entidade. modelId: type: object allOf: – #/definitions/inviteModel description: Relacionamento com o modelo de convite managementTrainingPreOnboardingEnabled: type: boolean description: Treinamento pré-integração habilitado. managementTrainingPreOnboarding: type: object allOf: – #/definitions/managementTrainingPreOnboardingData description: ID do treinamento pré-integração. managementTrainingPreOnboardingData: description: Modelo de convite de integração type: object properties: id: type: string description: ID do treinamento pré-integração. name: type: string description: Nome do treinamento pré-integração. code: type: string description: Código do treinamento pré-integração. 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 customLabel: type: string maxLength: 255 description: Label do Campo Customizado multiItemPropertyName: type: string maxLength: 255 description: Propriedade de cadastros múltiplos maxLength: type: integer format: int64 description: Frontend dinâmico – Tamanho máximo inputType: type: string allOf: – #/definitions/componentFieldsWidget description: Frontend dinâmico – Tipo de campo cssClass: type: string allOf: – #/definitions/componentCssClass description: Frontend dinâmico – CSS enumerationName: type: string description: Frontend dinâmico – Nome da enumeração mask: type: string description: Frontend dinâmico – Máscara maxDate: type: string allOf: – #/definitions/componentMaxDate description: Frontend dinâmico – Data máxima onBlur: type: string maxLength: 255 description: Frontend dinâmico – Evento onBlur onFocus: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onFocus onSelect: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onSelect onClear: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onClear enumQueryAutocomplete: type: string allOf: – #/definitions/componentQueryAutocomplete description: Frontend dinâmico – Query de autocomplete propertyName: type: string description: Frontend dinâmico – Nome da propriedade ignorePattern: type: boolean description: Frontend dinâmico – Ignorar pattern default: false autoCompleteCountry: type: boolean description: Frontend dinâmico – País no autocomplete default: false disableDropdown: type: boolean description: Frontend dinâmico – Desabilitar dropdown default: false componentValidators: type: string maxLength: 500 description: Frontend dinâmico – Validações componentValidatorPattern: type: string description: Frontend dinâmico – Padrão de validação propertyNamesLink: type: string maxLength: 500 description: Frontend dinâmico – Nome das propriedades do Widget.LINK separatorLink: type: string description: Frontend dinâmico – separador para o Widget.LINK multiItem: type: boolean description: Frontend dinâmico – campo pertence a um cadastro multiplo default: false minDate: type: string allOf: – #/definitions/componentMinDate description: Frontend dinâmico – Data mínima 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. area: type: array items: type: object allOf: – #/definitions/area description: Áreas. externalId: type: string maxLength: 36 description: ID externo da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractModel: description: Cadastro de modelo de contrato. type: object required: – contractModelName – contract – enabled – type properties: id: type: string format: uuid description: Identificador do modelo de contrato. contractModelName: type: string maxLength: 255 description: Nome do modelo de contrato. contract: type: string description: Texto base do contrato. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o modelo de contrato está ativo ou não. inviteModelId: type: object allOf: – #/definitions/inviteModel description: ID do modelo de convite type: type: string allOf: – #/definitions/contractModelType description: Tipo do modelo de documento inviteModelLayoutContract: type: array items: type: object allOf: – #/definitions/inviteModelLayoutContract description: Registro para armazenar os modelos de contrato. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: envelope: description: Cadastro de modelo de contrato. type: object required: – envelopeName – instructions – demandGeolocation – status properties: id: type: string format: uuid description: Identificador do envelope. envelopeName: type: string maxLength: 255 description: Nome do envelope instructions: type: string description: Instruções para o assinante. demandGeolocation: type: boolean description: Indicativo se o modelo de contrato está ativo ou não. preAdmission: type: object allOf: – #/definitions/preAdmission description: ID da pré admissão gedTicketId: type: string maxLength: 50 description: ID de referencia do ticket de processamento no GED gedEnvelopeId: type: string maxLength: 50 description: ID de referencia do envelope no GED signed: type: boolean description: Valida a resposta do colaborador default: false status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do envelope sendSms: type: boolean description: deseja enviar por SMS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contract: description: Cadastro de modelo de contrato. type: object required: – contractName – contract – preAdmission – signed – status properties: id: type: string format: uuid description: Identificador do modelo de contrato. contractName: type: string maxLength: 255 description: Nome do arquivo do contrato no GED contract: type: string description: Texto base do contrato. preAdmission: type: object allOf: – #/definitions/preAdmission description: Id da pré admissão signed: type: boolean description: Valida a resposta do colaborador gedDocumentId: type: string format: uuid description: ID de referencia do documento no GED gedDocumentVersionId: type: string format: uuid description: ID de referencia da versão do documento no GED gedTicketId: type: string maxLength: 50 description: ID de referencia do ticket de processamento no GED status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do documento envelope: type: object allOf: – #/definitions/envelope description: Id do Envelope createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: signer: description: Cadastro de modelo de contrato. type: object required: – signerName – signerEmail – signerPhone – signerInstructions properties: id: type: string format: uuid description: Identificador do assinante. signerName: type: string maxLength: 255 description: Nome do assinante. signerEmail: type: string maxLength: 255 description: Texto base do contrato. signerPhone: type: string maxLength: 20 description: Telefone do assinante signerInstructions: type: string description: Instruções para o assinante contract: type: object allOf: – #/definitions/contract description: ID do documento preAdmission: type: object allOf: – #/definitions/preAdmission description: ID da pré admissão envelope: type: object allOf: – #/definitions/envelope description: Id do Envelope status: type: string allOf: – #/definitions/enumDocumentStatus description: Status do envelope 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 inviteModelTerm: type: array items: type: object allOf: – #/definitions/inviteModelTerm description: Relacionamento da inviteModelTerms typification: type: boolean description: Relacionameto da tipificação inviteModelIntegration: type: array items: type: object allOf: – #/definitions/inviteModelIntegration description: Relacionamento da inviteModelIntegration hash: type: string description: Hash de alteração 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. attachments: type: array items: type: object allOf: – #/definitions/inviteModelLayoutAttachment description: Anexos associados ao layout do modelo de convite. inviteModelLayoutContract: type: array items: type: object allOf: – #/definitions/inviteModelLayoutContract description: Contratos associados ao layout do modelo de convite. 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 customFieldKey: type: string maxLength: 255 description: Chave do Campo Customizado customLabel: type: string maxLength: 255 description: Label do Campo Customizado multiItemPropertyName: type: string maxLength: 255 description: Propriedade de cadastros múltiplos maxLength: type: integer format: int64 description: Frontend dinâmico – Tamanho máximo inputType: type: string allOf: – #/definitions/componentFieldsWidget description: Frontend dinâmico – Tipo de campo cssClass: type: string allOf: – #/definitions/componentCssClass description: Frontend dinâmico – CSS enumerationName: type: string description: Frontend dinâmico – Nome da enumeração mask: type: string description: Frontend dinâmico – Máscara maxDate: type: string allOf: – #/definitions/componentMaxDate description: Frontend dinâmico – Data máxima onBlur: type: string maxLength: 255 description: Frontend dinâmico – Evento onBlur onFocus: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onFocus onSelect: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onSelect onClear: type: string allOf: – #/definitions/componentEvents description: Frontend dinâmico – Evento onClear enumQueryAutocomplete: type: string allOf: – #/definitions/componentQueryAutocomplete description: Frontend dinâmico – Query de autocomplete propertyName: type: string description: Frontend dinâmico – Nome da propriedade ignorePattern: type: boolean description: Frontend dinâmico – Ignorar pattern default: false autoCompleteCountry: type: boolean description: Frontend dinâmico – País no autocomplete default: false disableDropdown: type: boolean description: Frontend dinâmico – Desabilitar dropdown default: false componentValidators: type: string maxLength: 500 description: Frontend dinâmico – Validações componentValidatorPattern: type: string description: Frontend dinâmico – Padrão de validação propertyNamesLink: type: string maxLength: 500 description: Frontend dinâmico – Nome das propriedades do Widget.LINK separatorLink: type: string description: Frontend dinâmico – separador para o Widget.LINK multiItem: type: boolean description: Frontend dinâmico – campo pertence a um cadastro multiplo default: false minDate: type: string allOf: – #/definitions/componentMinDate description: Frontend dinâmico – Data mínima 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. costCenter: type: string format: uuid description: Centro de custo do contrato. workstationGroup: type: string format: uuid description: Posto de trabalho do contrato. area: type: string format: uuid description: Área 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: 255 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 employeeMobilePhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone celular 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 conclusionCustomEntityPercentage: type: integer format: int64 description: Percentual de conclusão do preenchimento da aba customizável 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 preAdmissionCustomEntities: type: array items: type: object allOf: – #/definitions/preAdmissionCustomEntities description: Relacionamento da preAdmissionCustomEntities employeeMobilePhoneOption: type: string allOf: – #/definitions/enumMobilePhoneOption description: Opção de recebimento de convite (SMS, WhatsApp) canceled: type: boolean description: Flag para sinalização de uma preAdmission cancelada default: false firstFinishedDate: type: string format: date-time description: Data da primeira finalização. lastFinishedDate: type: string format: date-time description: Data da última finalização. finishedTimes: type: integer format: int64 description: Contador de finalizações vacancyCode: type: integer format: int64 description: Código da vaga quando tem integração com GRS resendDate: type: string format: date-time description: Data do último reenvio da preAdmission emailTicket: type: string format: uuid description: Ticket do envio de email conclusionOCRPercentage: type: integer format: int64 description: Percentual de conclusão dos campos com OCR default: 0 billingDate: type: string format: date-time description: Data de incremento no billing beginSLADate: type: string format: date-time description: Data/hora que a preAdmission passou a contar como SLA da mesa minutesOfSLA: type: integer format: int64 description: Tempo do SLA da mesa validadora (em minutos) withdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Flag sinalizando se o candidato desistiu da pré-admissão origin: type: string allOf: – #/definitions/enumOriginIntegration description: Origem da pré-admissão externalId: type: string description: ID externo de admissões payrollAdmissionDraftId: type: string maxLength: 32 description: Código do rascunho da admissão no Payroll hash: type: string description: Hash de alteração endSLADate: type: string format: date-time description: Data/hora de término do SLA preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL preAdmissionDependentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDependentCOL description: Relacionamento da preAdmissionDependentCOL 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: Registro profissional rne: type: object allOf: – #/definitions/rne description: Registro Nacional de Estrangeiro 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: 11 description: Número. serie: type: string maxLength: 5 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui CTPS default: false isDigital: type: boolean description: Referencia do CTPS Digital 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: 11 description: Número. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 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: 11 description: Número. issueDate: type: string format: date description: Data de emissão. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui PIS default: false 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: 16 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. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui RG default: false 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: 13 description: Número. votingDistrict: type: string maxLength: 3 description: Zona. votingSection: type: string maxLength: 4 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui Título de eleitor default: false 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: 20 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui CNH default: false 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: 13 description: Número. serie: type: string maxLength: 1 description: Série. ra: type: string maxLength: 12 description: RA. exemptionDate: type: string format: date description: Data de dispensa. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão doesntHave: type: boolean description: Se a pessoa não possui DNV default: false 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: 15 description: Número. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui CNS default: false 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: 32 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui Certidão civil default: false 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: 20 description: Número. issuer: type: string maxLength: 6 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui Passaporte default: false preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL 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: 11 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui RIC default: false 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. fileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 examDate: type: string format: date description: Data do exame. refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui Exame admissional default: false 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: 12 description: Conta bancária. digit: type: string maxLength: 10 description: Digito da conta. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui Conta bancária default: false preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL handleElectronicPayment: type: string allOf: – #/definitions/enumYesNo description: Pagamento eletrônico? 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 customEntityOne: type: array items: type: object allOf: – #/definitions/customEntityOne description: Relacionamento da customEntityOne customEntityTwo: type: array items: type: object allOf: – #/definitions/customEntityTwo description: Relacionamento da customEntityTwo customEntityThree: type: array items: type: object allOf: – #/definitions/customEntityThree description: Relacionamento da customEntityThree rne: type: array items: type: object allOf: – #/definitions/rne description: Relacionamento do rne disability: type: array items: type: object allOf: – #/definitions/disability description: Relacionamento da disability personalBasicCOL: type: array items: type: object allOf: – #/definitions/personalBasicCOL description: Relacionamento da personalBasicCOL preAdmissionDependentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDependentCOL description: Relacionamento da preAdmissionDependentCOL personalComplementaryCOL: type: array items: type: object allOf: – #/definitions/personalComplementaryCOL description: Relacionamento da personalComplementaryCOL personalAddressCOL: type: array items: type: object allOf: – #/definitions/personalAddressCOL description: Relacionamento da personalAddressCOL emergencyContact: type: array items: type: object allOf: – #/definitions/personalEmergencyContact description: Relacionamento da emergencyContact identityDocumentCOL: type: array items: type: object allOf: – #/definitions/identityDocumentCOL description: Relacionamento da identityDocumentCOL professionalRecordCOL: type: array items: type: object allOf: – #/definitions/professionalRecordCOL description: Relacionamento da professionalRecordCOL militaryServiceBookCOL: type: array items: type: object allOf: – #/definitions/militaryServiceBookCOL description: Relacionamento da militaryServiceBookCOL driverLicenseCOL: type: array items: type: object allOf: – #/definitions/driverLicenseCOL description: Relacionamento da driverLicenseCOL epsAffiliation: type: array items: type: object allOf: – #/definitions/epsAffiliation description: Relacionamento da epsAffiliation afpAffiliation: type: array items: type: object allOf: – #/definitions/afpAffiliation description: Relacionamento da afpAffiliation severanceAffiliation: type: array items: type: object allOf: – #/definitions/severanceAffiliation description: Relacionamento da severanceAffiliation workCertificate: type: array items: type: object allOf: – #/definitions/workCertificate description: Relacionamento da workCertificate studyCertificate: type: array items: type: object allOf: – #/definitions/studyCertificate description: Relacionamento da studyCertificate documentReference: type: array items: type: object allOf: – #/definitions/documentReference description: Relacionamento da documentReference backgroundInformation: type: array items: type: object allOf: – #/definitions/backgroundInformation description: Relacionamento da backgroundInformation 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. disability: type: object allOf: – #/definitions/disability description: Dados da disability 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. badgeUploadDate: type: string format: date-time description: Data do upload da imagem do crachá gender: type: string allOf: – #/definitions/enumGender description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. mothersName: type: string maxLength: 255 description: Nome da mãe do novo colaborador. fathersName: type: string maxLength: 255 description: Nome do pai do novo colaborador. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 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. degreeOfEducationUploadDate: type: string format: date-time description: Data do upload 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 ethnicity: type: string format: uuid description: Etnia 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 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. firstPhoneCountryId: type: string maxLength: 5 description: Identificador do país 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 secundário. secondPhoneCountryId: type: string maxLength: 5 description: Identificador do país do telefone 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL 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 capSolverTaskId: type: string maxLength: 40 description: Id gerado para resolver o captcha capSolverCreationDate: type: string format: date-time description: Data e hora em que o captcha foi criado 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: 15 description: Número firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segundo arquivo secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. thirdFile: type: string maxLength: 300 description: Terceiro arquivo thirdFileUploadDate: type: string format: date-time description: Data do upload do terceiro arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocument description: Relacionamento da dependentDocument refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão 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 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: 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 – clientCode – clientName – billingDate – preAdmissionAmount 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. clientCode: type: integer format: int64 description: Código do cliente do ERP. clientName: type: string maxLength: 255 description: Nome do cliente no ERP billingDate: type: string format: date-time description: Data de início do faturamento preAdmissionAmount: type: integer format: int64 description: Quantidade de admissões 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 systemClientId: type: string maxLength: 40 description: Identificador externo do modulo 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. area: type: string format: uuid description: Área do contrato. workstation: type: string format: uuid description: posto de trabalho costCenter: type: string format: uuid description: centro de custo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: costCenter: description: Cadastro de Centro de Custo type: object required: – code – name properties: id: type: string format: uuid description: Identificador único do registro. code: type: string maxLength: 255 description: Codigo do centro de custo name: type: string maxLength: 255 description: Nome do centro de custo enabled: type: string allOf: – #/definitions/situation description: Indicativo se o centro de custo está ativo ou não. externalId: type: string maxLength: 40 description: Id externo do Centro de custo company: type: object allOf: – #/definitions/company description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workstationGroup: description: Cadastro de Posto de Trabalho type: object required: – code – name properties: id: type: string format: uuid description: Identificador único do registro. code: type: string maxLength: 255 description: Código do Posto de Trabalho name: type: string maxLength: 255 description: Nome do Posto de Trabalho enabled: type: string allOf: – #/definitions/situation description: Indicativo se o Posto de Trabalho está ativo ou não. externalId: type: string maxLength: 40 description: Id externo do Posto de Trabalho company: type: object allOf: – #/definitions/company description: Empresa branchOffice: type: object allOf: – #/definitions/branchOffice description: Filial costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo 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 maxLength: 255 description: Razão social. tradingName: type: string maxLength: 255 description: Nome fantasia. enabled: type: string allOf: – #/definitions/situation description: Indicativo se a filial está ativa ou não. code: type: string maxLength: 255 description: Código do sistema externo. externalID: type: string maxLength: 36 description: ID externo da filial country: type: string format: uuid description: País de localização da filial. cep: type: string maxLength: 10 description: CEP do endereço da filial. state: type: string format: uuid description: Estado de localização da filial city: type: string format: uuid description: Cidade de localização da filial neighborhood: type: string maxLength: 255 description: Bairro do endereço da filial addressType: type: string allOf: – #/definitions/enumAddressType description: Logradouro endereço da filial address: type: string maxLength: 255 description: Endereço da filial number: type: string maxLength: 10 description: Número do endereço da filial additional: type: string maxLength: 255 description: Informações adicionais do endereço da filial cnpj: type: string maxLength: 14 description: CNPJ da filial 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 maxLength: 255 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 maxLength: 255 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 maxLength: 255 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: professionalRecord: description: Dados do registro profissional type: object properties: id: type: string format: uuid description: Identificador único do registro professionalAdvice: type: string format: uuid description: Conselho profissional number: type: string maxLength: 20 description: Número de registro no conselho profissional isTemporary: type: string allOf: – #/definitions/enumYesNo description: É temporário? mteNumber: type: string maxLength: 255 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. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do second arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeToken: description: Dados da entidade de token da pre-admissão colaborador type: object required: – token – tokenCreatedDate – attempts properties: id: type: string format: uuid description: Identificador único do registro token: type: string maxLength: 6 description: Token tokenCreatedDate: type: string format: date-time description: Data Criação Token attempts: type: integer format: int64 description: Validade do Token expired: type: boolean description: Verificador se está expirado default: false preAdmission: type: string format: uuid description: Pré-admissão. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: customEntityOne: description: Entidade Customizada 1 type: object properties: id: type: string format: uuid description: Identificador da entidade. preAdmissionCustomEntities: type: array items: type: object allOf: – #/definitions/preAdmissionCustomEntities description: Relacionamento da preAdmissionCustomEntities validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: customEntityTwo: description: Entidade Customizada 2 type: object properties: id: type: string format: uuid description: Identificador da entidade. preAdmissionCustomEntities: type: array items: type: object allOf: – #/definitions/preAdmissionCustomEntities description: Relacionamento da preAdmissionCustomEntities validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: customEntityThree: description: Entidade Customizada 3 type: object properties: id: type: string format: uuid description: Identificador da entidade. preAdmissionCustomEntities: type: array items: type: object allOf: – #/definitions/preAdmissionCustomEntities description: Relacionamento da preAdmissionCustomEntities validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionCustomEntities: description: Dados das entidades Customizadas type: object required: – preAdmission properties: id: type: string format: uuid description: Identificador da entidade. preAdmission: type: object allOf: – #/definitions/preAdmission description: Relacionamento com a Pré-Admissão customEntityOne: type: object allOf: – #/definitions/customEntityOne description: Relacionamento com a entidade customizada 1 customEntityTwo: type: object allOf: – #/definitions/customEntityTwo description: Relacionamento com a entidade customizada 2 customEntityThree: type: object allOf: – #/definitions/customEntityThree description: Relacionamento com a entidade customizada 3 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: termOfPrivacy: description: Dados dos termos de uso type: object required: – title – content properties: id: type: string format: uuid description: Identificador da entidade. type: string maxLength: 255 description: Titulo do termo code: type: string maxLength: 255 description: Código do sistema externo. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o termo está ativa ou não. content: type: string description: Conteúdo do termo de uso que deve ser fornecido nos idiomas aceitos x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: content: type: string example: pt-BR: content: Exemplo de texto usando locale pt-BR. en-US: content: Text example using en-US locale. candidateTermOfPrivacy: description: Dados dos termos de uso type: object required: – actionUser – actionDate properties: id: type: string format: uuid description: Identificador da entidade. inviteModelTerm: type: string format: uuid description: Relacionamento com o termo de uso preAdmission: type: string format: uuid description: Relacionamento com a Pré-Admissão modelId: type: string format: uuid description: Relacionamento com o modelo de convite actionUser: type: string allOf: – #/definitions/enumTermOfPrivacyCandidateAction description: Status da ação actionDate: type: string format: date-time description: Data do aceite createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelTerm: description: Seção do termo de uso do modelo de convite. type: object required: – termOfPrivacy – email properties: id: type: string format: uuid description: Identificador da entidade. termOfPrivacy: type: string format: uuid description: Relacionamento com os termos de privacidade modelId: type: object allOf: – #/definitions/inviteModel description: ID do modelo de convite email: type: string maxLength: 100 description: Email do termo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: auditRecord: description: Registro de auditoria type: object required: – primitive – serviceName – auditRecordJsons properties: id: type: string format: uuid description: Id da entidade primitive: type: string maxLength: 150 description: Primitiva que está sendo auditada serviceName: type: string maxLength: 150 description: Serviço onde está a primitiva auditada auditRecordJsons: type: array items: type: object allOf: – #/definitions/auditRecordJson minimum: 1 description: Lista de objetos auditados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: auditRecordJson: description: Registro de objetos de uma auditoria type: object required: – json – logType – description properties: id: type: string format: uuid description: Id da entidade json: type: string description: Objeto em formato json logType: type: string allOf: – #/definitions/enumLogType description: Tipo de log esté é pra quando analisarmos ver a criticidade se ele é INFO, WARN, ERROR e etc description: type: string maxLength: 255 description: Descrição sobre o item auditado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocrExtractedText: description: Registro de OCR de uma pré admissão type: object required: – preAdmissionId – refEntityId – category – ocrExtractedTextFields – ocrTextractResults properties: id: type: string format: uuid description: identificador único da entidade preAdmissionId: type: string format: uuid description: Id da pre-admissão refEntityId: type: string format: uuid description: Referencia do id da entidade category: type: string allOf: – #/definitions/categoryField description: categoria da entidade, seguindo o padrão da categoria da tabela averageAccuracy: type: number format: double description: média da acurácia dos textos extraídos ocrExtractedTextFields: type: array items: type: object allOf: – #/definitions/ocrExtractedTextFields minimum: 1 description: Lista dos campos validados pelo OCR ocrTextractResults: type: array items: type: object allOf: – #/definitions/ocrTextractResults minimum: 1 description: Lista contendo os textos extraídos dos documentos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocrExtractedTextFields: description: Registro de OCR dos campos de uma pré admissão type: object required: – ocrExtractedText – valueType – valid – similarity – text properties: id: type: string format: uuid description: identificador único da entidade ocrExtractedText: type: object allOf: – #/definitions/ocrExtractedText description: ID da entidade ocrExtractedText valueType: type: string allOf: – #/definitions/valueType description: Tipos de valores aceitos pelo campo. valid: type: boolean description: valor que verifica se está válido ou não similarity: type: integer format: int64 description: similaridade dos textos text: type: string description: Texto encontrado pelo OCR createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: generatedJobDescription: description: Registro de geração da descrição de vaga via ChatGPT type: object required: – keyword – input – output properties: id: type: string format: uuid description: Id da entidade keyword: type: string maxLength: 255 description: Palavra-chave usada campaign: type: string maxLength: 255 description: Campanha input: type: string description: Texto de entrada para o ChatGPT output: type: string description: Texto de saida do ChatGPT createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocrTextractResults: description: Registro de extração de cada documento do ocr type: object required: – ocrExtractedText – document – text – fileId – fileVersion – amountReading properties: id: type: string format: uuid description: identificador único da entidade ocrExtractedText: type: object allOf: – #/definitions/ocrExtractedText description: Referencia do ocr document: type: string allOf: – #/definitions/textractDocumentType description: Numero do documento que será extraído text: type: string description: texto extraído e serializado fileId: type: string description: id do arquivo S3 fileVersion: type: string description: versão do arquivo fileUploadDate: type: string format: date-time description: Data do upload do arquivo amountReading: type: integer format: int64 description: Quantidade de de leituras createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionStatusSummary: description: Registro do Status da Data de uma pré admissão type: object required: – preAdmission – status – totalTime properties: id: type: string format: uuid description: identificador único da entidade preAdmission: type: string format: uuid description: preAdmission referente ao status status: type: string allOf: – #/definitions/invitationStatus description: Status do convite totalTime: type: integer format: int64 description: Tempo total no status correspondente em minutos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: area: description: Área type: object required: – name – code properties: id: type: string format: uuid description: Identificador da área company: type: object allOf: – #/definitions/company description: Empresa na qual a área pertence name: type: string maxLength: 255 description: Nome da área enabled: type: string allOf: – #/definitions/situation description: Indicativo se a área está ativa ou não. code: type: string maxLength: 255 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: rne: description: Dados do Registro Nacional de Estrangeiro type: object properties: id: type: string format: uuid description: Identificador único do registro. arrivalDate: type: string format: date description: Data de chegada. residenceTime: type: string allOf: – #/definitions/enumResidenceTime description: Tempo de residência conditionVisaType: type: string allOf: – #/definitions/enumConditionVisaType description: Condição de estrangeiro number: type: string maxLength: 255 description: Número issuer: type: string maxLength: 255 description: Emissor issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade ordinanceNumber: type: string maxLength: 255 description: Número da portaria marriedWithBrazilian: type: string allOf: – #/definitions/enumYesNo description: Casado com brasileiro brazilianChildren: type: string allOf: – #/definitions/enumYesNo description: Filhos brasileiros fathersName: type: string maxLength: 255 description: Nome do pai mothersName: type: string maxLength: 255 description: Nome da mãe birthDate: type: string format: date description: Data de nascimento firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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 refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui RNE default: false residencyEndDate: type: string format: date description: Data de Término da Residência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionRegister: description: Registro de utilização de SMS da pré-admissão type: object required: – preAdmissionId properties: id: type: string format: uuid description: Id de identificação preAdmissionId: type: string format: uuid description: Id da pré-admissão sms: type: integer format: int64 description: Quantidade SMS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ethnicity: description: Etnia type: object properties: id: type: string format: uuid description: Id da Etnia. code: type: integer format: int64 description: Código da etnia name: type: string maxLength: 255 description: Nome da etnia eSocialRacialType: type: string allOf: – #/definitions/enumRacialType description: Tipo da etnia. enabled: type: string allOf: – #/definitions/situation description: Indicativo se o cargo está ativo ou não. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionHistory: description: Histórico de movimentação da pré-admissão type: object required: – preAdmissionId – logDate – title properties: id: type: string format: uuid description: Identificador único do registro preAdmissionId: type: string format: uuid description: Id da pré-admissão logDate: type: string format: date-time description: Data/hora que foi gerado o registro da pré-admissão type: string maxLength: 255 description: Título do registro de histórico description: type: string description: Descrição do registro de histórico createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: typification: description: Registro de extração de cada documento da tipificação type: object required: – preAdmissionId – category – documentType – accuracy – fileId – fileVersion – fileUploadDate properties: id: type: string format: uuid description: identificador único da entrada preAdmissionId: type: string format: uuid description: Id da pre-admissão refEntityId: type: string format: uuid description: referência do id da entidade category: type: string allOf: – #/definitions/categoryField description: Categoria do documento documentType: type: string allOf: – #/definitions/textractDocumentType description: ordinal do documento em que será extraído type: type: string allOf: – #/definitions/typificationDocumentType description: Documento identificado accuracy: type: number format: double description: Acurácia fileId: type: string description: id do arquivo S3 fileVersion: type: string description: versão do arquivo fileUploadDate: type: string format: date-time description: Data do upload do arquivo amountReading: type: integer format: int64 description: Quantidade de de leituras default: 0 status: type: string allOf: – #/definitions/typificationStatus description: Status hash: type: string maxLength: 255 description: Hash createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionReasonWithdrawal: description: Registro de desistência da pré-admissão type: object required: – preAdmission – withdrawal – reason properties: id: type: string format: uuid description: Identificador único do registro preAdmission: type: string format: uuid description: preAdmission a que se refere a motivação withdrawal: type: string allOf: – #/definitions/enumWithdrawal description: Identificador da situação gerou do registro reason: type: string maxLength: 300 description: Justificativa da desistência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: disabilities: description: Registro para guardar a lista de deficiências do eSocial. type: object required: – name – type – enabled properties: id: type: string format: uuid description: Identificador único do registro code: type: integer format: int64 description: Código da deficiência name: type: string maxLength: 255 description: Descrição da deficiência type: type: string allOf: – #/definitions/disabilityType description: Tipo de deficiência enabled: type: string allOf: – #/definitions/situation description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: disability: description: Registro de informações de deficiência do candidato. type: object properties: id: type: string format: uuid description: Identificador único do registro preAdmissionId: type: string format: uuid description: Identificação da pré-admissão. disabilityItem: type: array items: type: object allOf: – #/definitions/disabilityItem description: Relacionamento da disabilityItem hasDisability: type: boolean description: tem deficiência 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: disabilityItem: description: Registro de informações de deficiência do candidato. type: object required: – isRehabilitated – isMainDisability properties: id: type: string format: uuid description: Identificador único do registro disabilityId: type: object allOf: – #/definitions/disability description: Deficiência disabilityType: type: string format: uuid description: Tipo de deficiência startDate: type: string format: date description: Data de início isRehabilitated: type: boolean description: É Reabilitado isMainDisability: type: boolean description: Principal deficiência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: componentEntityConfiguration: description: Configuração das entidades para o Frontend dinâmico type: object required: – country – type – subType – category – propertyName properties: id: type: string format: uuid description: Identificador country: type: string allOf: – #/definitions/inviteModelCountry description: País type: type: string allOf: – #/definitions/inviteFieldType description: Tipo de campo subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo category: type: string allOf: – #/definitions/categoryField description: Categoria do campo categoryName: type: string maxLength: 255 description: Nome da categoria propertyName: type: string maxLength: 255 description: Nome da propriedade da entidade no DTO entityName: type: string maxLength: 255 description: Nome da entidade entityOrder: type: integer format: int64 description: Ordenação description: type: string maxLength: 255 description: Chave de tradução entityNameFieldCustomization: type: string maxLength: 255 description: Nome da entidade no fieldCustomization createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelLayoutAttachment: description: Registro para armazenar os anexos. type: object required: – inviteModelLayout – fileId – fileName – fileUploadDate – size properties: id: type: string format: uuid description: Identificador único do registro inviteModelLayout: type: object allOf: – #/definitions/inviteModelLayout description: Layout do modelo de convite associado a entidade fileId: type: string maxLength: 300 description: Identificador do arquivo no blob service fileName: type: string maxLength: 255 description: Nome do arquivo fileUploadDate: type: string format: date-time description: Data/hora de upload do arquivo size: type: integer format: int64 description: Tamanho do arquivo em bytes createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionMissingInformation: description: Registro para armazenar as entidades da pré-admissão com campos obrigatórios incompletos. type: object properties: id: type: string format: uuid description: Identificador único do registro preAdmission: type: string format: uuid description: ID da pré admissão type: type: string allOf: – #/definitions/inviteFieldType description: Tipo do campo do modelo de convite. subType: type: string allOf: – #/definitions/inviteFieldSubType description: Subtipo do campo do modelo de convite. category: type: string allOf: – #/definitions/categoryField description: Nome da categoria do cmapo. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionPersonalCOL: description: Dados pessoais da pré-admissão Col. 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/personalBasicCOL description: Dados básicos da pré-admissão. complementary: type: object allOf: – #/definitions/personalComplementaryCOL description: Dados complementares da pré-admissão. emergencyContact: type: object allOf: – #/definitions/personalEmergencyContact description: Contato emergencial da pré-admissão. birthPlace: type: object allOf: – #/definitions/personalBirthPlace description: Dados do local de nascimento. address: type: object allOf: – #/definitions/personalAddressCOL 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: personalBasicCOL: description: Dados pessoais básicos da pré-admissão Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstName: type: string maxLength: 25 description: Primeiro nome do novo colaborador. middleName: type: string maxLength: 75 description: Nome do meio do novo colaborador. firstSurname: type: string maxLength: 50 description: Primeiro sobrenome do novo colaborador. secondSurname: type: string maxLength: 50 description: Segundo sobrenome 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. badgeUploadDate: type: string format: date-time description: Data do upload da imagem do crachá gender: type: string allOf: – #/definitions/enumGender description: Gênero do novo colaborador. birthDate: type: string format: date description: Data de nascimento do novo colaborador. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalComplementaryCOL: description: DTO com Dados complementares da pré-admissão Col. type: object properties: id: type: string format: uuid description: Identificador da tabela firstFile: type: string maxLength: 300 description: Primeiro arquivo firstFileUploadDate: type: string format: date-time description: Primeira data de carremento do arquivo maritalStatus: type: string allOf: – #/definitions/enumMaritalStatus description: Estado civil degreeOfEducation: type: string format: uuid description: Grau de instrução nationality: type: string format: uuid description: Nacionalidade religion: type: string format: uuid description: Religião ethnicity: type: string format: uuid description: Etnia socialName: type: string maxLength: 255 description: Nome social bloodType: type: string allOf: – #/definitions/enumBloodType description: Tipo sanguineo bloodFactor: type: string allOf: – #/definitions/enumBloodFactor description: fator do sangue height: type: string maxLength: 8 description: Altura weight: type: string maxLength: 8 description: Peso validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalAddressCOL: description: Dados do endereço da pré-admissão Col. 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/enumAddressTypeCOL description: Logradouro. address: type: string maxLength: 255 description: Endereço. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. 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. preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personalEmergencyContact: description: Dados do contato de emergência Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstContactName: type: string maxLength: 255 description: Nome do primeiro contato. firstContactKinship: type: string allOf: – #/definitions/enumDegreeOfKinship description: Parentesco do primeiro contato. firstContactPhone: type: string maxLength: 255 description: Telefone do primeiro contato. firstContactPhoneCountryId: type: string maxLength: 5 description: ID do país do telefone do primeiro contato. secondContactName: type: string maxLength: 255 description: Nome do segundo contato. secondContactKinship: type: string allOf: – #/definitions/enumDegreeOfKinship description: Parentesco do segundo contato. secondContactPhone: type: string maxLength: 255 description: Telefone do segundo contato. secondContactPhoneCountryId: type: string maxLength: 5 description: ID do país do telefone do primeiro contato. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionPersonalCOL: type: array items: type: object allOf: – #/definitions/preAdmissionPersonalCOL description: Relacionamento da preAdmissionPersonalCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionDocumentCOL: description: Documentos relacionados a pré-admissão Col. 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. identityDocument: type: object allOf: – #/definitions/identityDocumentCOL description: Dados do documento de identidade. professionalRecord: type: object allOf: – #/definitions/professionalRecordCOL description: Registro profissional. militaryServiceBook: type: object allOf: – #/definitions/militaryServiceBookCOL description: Certificado de reservista driverLicense: type: object allOf: – #/definitions/driverLicenseCOL description: Licença de condução epsAffiliation: type: object allOf: – #/definitions/epsAffiliation description: Afiliação EPS afpAffiliation: type: object allOf: – #/definitions/afpAffiliation description: Afiliação AFP severanceAffiliation: type: object allOf: – #/definitions/severanceAffiliation description: Afiliação de indenização bankAccount: type: object allOf: – #/definitions/bankAccount description: Dados bancários. workCertificate: type: object allOf: – #/definitions/workCertificate description: Certificado de trabalho studyCertificate: type: object allOf: – #/definitions/studyCertificate description: Certificado de estudo documentReference: type: object allOf: – #/definitions/documentReference description: Referência de documento backgroundInformation: type: object allOf: – #/definitions/backgroundInformation description: Informações de fundo passport: type: object allOf: – #/definitions/passport description: Relacionamento da passport createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: identityDocumentCOL: description: Dados do documento de identidade Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. documentType: type: string format: uuid description: Tipo do documento issueDate: type: string format: date description: Data de emissão. issuerCountry: type: string format: uuid description: País de emissão. issuerState: type: string format: uuid description: Estado de emissão. issuerCity: type: string format: uuid description: Cidade de emissão. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui documento de identificação default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: professionalRecordCOL: description: Dados do registro profissional Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. issueDate: type: string format: date description: Data de emissão. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui registro profissional default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: militaryServiceBookCOL: description: Dados do documento de serviço militar Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. issueDate: type: string format: date description: Data de emissão. militaryServiceBookClass: type: string allOf: – #/definitions/enumMilitaryServiceBookClassCOL description: Relacionamento da militaryServiceBookClassCOL district: type: string description: Distrito do documento. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui livro de serviço militar default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: driverLicenseCOL: description: Dados do documento de licença de condução Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. number: type: string description: Número do documento. category: type: string allOf: – #/definitions/enumDriverLicenseCategoryCOL description: Categoria do documento. issueDate: type: string format: date description: Data de emissão. expiryDate: type: string format: date description: Data de validade. issuer: type: string description: Emissor do documento. restrictions: type: string description: Restrições do documento. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui licença motorista default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eps: description: Dados do documento de afiliação EPS Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. code: type: integer format: int64 description: Código do documento name: type: string description: Nome EPS type: type: string allOf: – #/definitions/enumSocialSecurityTypeCOL description: Tipo EPS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentTypeCOL: description: Dados do tipo de documento Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. code: type: integer format: int64 description: Código do documento name: type: string description: Nome do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: epsAffiliation: description: Dados da afiliação EPS Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: string format: uuid description: Nome da EPS validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui EPS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: afpAffiliation: description: Dados da afiliação AFP Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: string format: uuid description: Nome da AFP validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui AFP default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: severanceAffiliation: description: Dados da afiliação de indenização Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: string format: uuid description: Nome da afiliação de indenização validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui indenização de afiliação default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workCertificate: description: Dados do certificado de trabalho Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. workCertificateItem: type: array items: type: object allOf: – #/definitions/workCertificateItem description: Item do certificado de trabalho validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão hasWorkCertificate: type: boolean description: Tem certificado trabalho doesntHave: type: boolean description: Não possui default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workCertificateItem: description: Dados do item certificado de trabalho Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. workCertificateId: type: object allOf: – #/definitions/workCertificate description: Certificado de trabalho firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: string description: Nome do item do certificado de trabalho createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: studyCertificate: description: Dados do certificado de estudo Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. studyCertificateItem: type: array items: type: object allOf: – #/definitions/studyCertificateItem description: Item do certificado de estudo validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL hasStudyCertificate: type: boolean description: Tem certificado estudo doesntHave: type: boolean description: Não possui default: false refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: studyCertificateItem: description: Dados do item certificado de estudo Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. studyCertificateId: type: object allOf: – #/definitions/studyCertificate description: Certificado de estudo firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. name: type: string description: Nome do item do certificado de estudo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentReference: description: Dados do documento de referência Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. documentReferenceItem: type: array items: type: object allOf: – #/definitions/documentReferenceItem description: Item do documento de referência validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL hasDocumentReference: type: boolean description: Tem documento de referencia doesntHave: type: boolean description: Não possui default: false refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentReferenceItem: description: Dados do item documento de referência Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. documentReferenceId: type: object allOf: – #/definitions/documentReference description: Documento de referência firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. reference: type: string allOf: – #/definitions/enumDocumentReference description: Nome do item do documento de referência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: backgroundInformation: description: Dados do documento de fundo Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. thirdFile: type: string maxLength: 300 description: Terceira imagem. thirdFileUploadDate: type: string format: date-time description: Data do upload do terceiro arquivo. validation: type: object allOf: – #/definitions/validationData description: Indicação de validação do documento. preAdmissionDocumentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDocumentCOL description: Relacionamento da preAdmissionDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão validationPercentage: type: integer format: int64 description: Porcentagem de validação do OCR default: 0 doesntHave: type: boolean description: Se a pessoa não possui documento de fundo default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionDependentCOL: description: Dados do dependente Col. 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/dependentBasicCOL description: Dados básicos do dependente. document: type: object allOf: – #/definitions/dependentDocumentCOL description: Dados do documento 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 documento. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentDocumentCOL: description: Dados do documento do dependente Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. spouse: type: object allOf: – #/definitions/dependentSpouse description: Cônjuge dependente. child: type: object allOf: – #/definitions/dependentChild description: Filho dependente. parent: type: object allOf: – #/definitions/dependentParent description: Parente dependente preAdmissionDependentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDependentCOL description: Relacionamento da preAdmissionDependentCOL createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentBasicCOL: description: Dados basicos do dependente Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. firstName: type: string maxLength: 255 description: Primeiro nome do dependente. firstSurname: type: string description: Primeiro sobrenome secondSurname: type: string description: Segundo sobrenome number: type: string maxLength: 20 description: Número do dependente epsBeneficiary: type: string allOf: – #/definitions/enumYesNo description: EPS beneficiario do dependente? compensationFundBeneficiary: type: string allOf: – #/definitions/enumYesNo description: Compensação de fundo beneficiario do dependente? livesWithCollab: type: string allOf: – #/definitions/enumYesNo description: Vive com o colaborador? degreeOfKinship: type: string allOf: – #/definitions/enumDegreeOfKinship description: Grau de parentesco. gender: type: string allOf: – #/definitions/enumGender description: Gênero do dependente birthDate: type: string format: date description: Data de nascimento do dependente. declareIncomeTax: type: string allOf: – #/definitions/enumYesNo description: Declara imposto de renda? documentType: type: string format: uuid description: Tipo do documento maritalStatus: type: string allOf: – #/definitions/enumMaritalStatus description: Estado civil preAdmissionDependentCOL: type: array items: type: object allOf: – #/definitions/preAdmissionDependentCOL description: Relacionamento da preAdmissionDependentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentSpouse: description: Dados do dependente cônjuge Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocumentCOL description: Relacionamento da dependentDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentChild: description: Dados do dependente filho Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. thirdFile: type: string maxLength: 300 description: Terceira imagem. thirdFileUploadDate: type: string format: date-time description: Data do upload do terceiro arquivo. fourthFile: type: string maxLength: 300 description: Quarta imagem. fourthFileUploadDate: type: string format: date-time description: Data do upload do quarto arquivo. fifthFile: type: string maxLength: 300 description: Quinta imagem. fifthFileUploadDate: type: string format: date-time description: Data do upload do quinto arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocumentCOL description: Relacionamento da dependentDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dependentParent: description: Dados do dependente parente Col. type: object properties: id: type: string format: uuid description: Identificador único do registro. firstFile: type: string maxLength: 300 description: Primeira imagem. firstFileUploadDate: type: string format: date-time description: Data do upload do primeiro arquivo. secondFile: type: string maxLength: 300 description: Segunda imagem. secondFileUploadDate: type: string format: date-time description: Data do upload do segundo arquivo. dependentDocument: type: array items: type: object allOf: – #/definitions/dependentDocumentCOL description: Relacionamento da dependentDocumentCOL refPreAdmission: type: string format: uuid description: Referencia do id da pré-admissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: preAdmissionContractModelSend: description: Registro para armazenar os anexos. type: object required: – preAdmissionId – fileId – sendDate properties: id: type: string format: uuid description: Identificador único do registro preAdmissionId: type: string format: uuid description: Identificador da pré-admissão que o registro está associado fileId: type: string maxLength: 300 description: Identificador do arquivo enviado para o candidato (blobservice) sendDate: type: string format: date-time description: Identifica a data/hora que o arquivo foi enviado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelLayoutContract: description: Registro para armazenar os contratos associados ao layout do modelo de convite. type: object required: – inviteModelLayout – contractModel properties: id: type: string format: uuid description: Identificador único do registro inviteModelLayout: type: object allOf: – #/definitions/inviteModelLayout description: Layout do modelo de convite associado a entidade contractModel: type: object allOf: – #/definitions/contractModel description: Modelo de documento associado para envio no modelo de convite createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: inviteModelIntegration: description: Dados do convite de modelo de integração type: object required: – modelId properties: id: type: string format: uuid description: Identificador único do registro. modelId: type: object allOf: – #/definitions/inviteModel description: Modelo de convite. managementTrainingPreOnboardingEnabled: type: boolean description: Treinamento pré-integração habilitado. managementTrainingPreOnboardingId: type: string format: uuid description: ID do treinamento pré-integração. 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