2.0info: 6.5.9 LGPD – Lei Geral de Proteção de Dados description: Permite gerenciar os dados dos usuários/pessoas para a Lei Geral de Proteção de Dados x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: lgpd 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /lgpd/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getFields: post: description: API DEPRECIADA: Use listFields instead | DATA: 2023-04-27 | Obtém os campos que armazena dados que devem ser tratados pelo LGPD (Lei Geral de Proteção de Dados) tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: includeDisabledField: type: boolean description: Flag utilizada para incluir os campos customizados que estão desabilitados default: false responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Campos padrão de sistema customFields: type: array items: type: object allOf: – #/definitions/completeCustomField description: Campos customizados pelo usuário 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Use listFields instead | DATA: 2023-04-27 | Obtém os campos que armazena dados que devem ser tratados pelo LGPD (Lei Geral de Proteção de Dados) tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: includeDisabledField description: Flag utilizada para incluir os campos customizados que estão desabilitados in: query type: boolean responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Campos padrão de sistema customFields: type: array items: type: object allOf: – #/definitions/completeCustomField description: Campos customizados pelo usuário 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /lgpd/queries/listFields: post: description: Lista os campos que armazena dados a serem tratados pelo LGPD tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da pagina, se não informado o valor padrão será 0 default: 0 size: type: integer format: int64 description: Número total de registros por página, se não informado o valor será 10 default: 10 searchValue: type: string description: Filtro utilizado para localizar um campo ou mais responses: 200: description: Ok schema: type: object required: – fields – listInformation properties: fields: type: array items: type: object allOf: – #/definitions/fieldInfoDef minimum: 1 description: Listagem dos campos listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os campos que armazena dados a serem tratados pelo LGPD tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Número da pagina, se não informado o valor padrão será 0 in: query type: integer format: int64 – name: size description: Número total de registros por página, se não informado o valor será 10 in: query type: integer format: int64 – name: searchValue description: Filtro utilizado para localizar um campo ou mais in: query type: string responses: 200: description: Ok schema: type: object required: – fields – listInformation properties: fields: type: array items: type: object allOf: – #/definitions/fieldInfoDef minimum: 1 description: Listagem dos campos listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/listRequests: post: description: Lista as requisições de dossiês gerados\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: requestType: type: string allOf: – #/definitions/requestType description: Tipo da requisição status: type: string allOf: – #/definitions/requestStatus description: Filtro por status da requisição searchTerm: type: object allOf: – #/definitions/searchTerm description: Termo de pesquisa para diminuir a abrangência na listagem dos dossiês pagination: type: object allOf: – #/definitions/pagination description: As configurações de paginação. Não definido retornará os 10 primeiros resultados. responses: 200: description: Ok schema: type: object required: – requests – listInformation properties: requests: type: array items: type: object allOf: – #/definitions/requestData minimum: 1 description: Dados da requisição: dossiê ou deleção de informações listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre o resultado da listagem 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /lgpd/queries/getDossier: post: description: Obtém o dossiê da pessoa\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Identificador de consulta do dossiê responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/consolidatedDossierData minimum: 1 description: Dados do Dossiê status: type: string allOf: – #/definitions/requestStatus description: Status do progresso 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError get: description: Obtém o dossiê da pessoa\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ticket description: Identificador de consulta do dossiê in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/consolidatedDossierData minimum: 1 description: Dados do Dossiê status: type: string allOf: – #/definitions/requestStatus description: Status do progresso 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /lgpd/queries/getRequest: post: description: Obtém dados de uma requisição\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Identificador de consulta do dossiê responses: 200: description: Ok schema: type: object allOf: – #/definitions/completeRequest 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError get: description: Obtém dados de uma requisição\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ticket description: Identificador de consulta do dossiê in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/completeRequest 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /lgpd/queries/getRemovalStatus: post: description: Pesquisa pelo status do andamento da remoção dos dados sensíveis do dossiê tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket da solicitação de remoção responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/dossierData minimum: 1 description: Dados do Dossê status: type: string allOf: – #/definitions/processStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pesquisa pelo status do andamento da remoção dos dados sensíveis do dossiê tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ticket description: Ticket da solicitação de remoção in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dossiers – status properties: dossiers: type: array items: type: object allOf: – #/definitions/dossierData minimum: 1 description: Dados do Dossê status: type: string allOf: – #/definitions/processStatus description: Status do progresso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/exportDossier: post: description: Exportar Dossiê para PDF\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Identificador da requisição responses: 200: description: Ok schema: type: object required: – pdf properties: pdf: type: string format: byte description: 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError get: description: Exportar Dossiê para PDF\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ticket description: Identificador da requisição in: query required: true type: string responses: 200: description: Ok schema: type: object required: – pdf properties: pdf: type: string format: byte description: 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /lgpd/queries/getUserCookiesConsentStatus: post: description: Retorna as informações do consentimento de cookies do usuário atual tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasAcceptedCookies – acceptedCookiesDate properties: hasAcceptedCookies: type: boolean description: Informa se o usuário atual já aceitou o consentimento de cookies acceptedCookiesDate: type: string format: date-time description: Informa a data que o usuário atual aceitou o consentimento de cookies. Retorna nulo se ele ainda não aceitou 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do consentimento de cookies do usuário atual tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasAcceptedCookies – acceptedCookiesDate properties: hasAcceptedCookies: type: boolean description: Informa se o usuário atual já aceitou o consentimento de cookies acceptedCookiesDate: type: string format: date-time description: Informa a data que o usuário atual aceitou o consentimento de cookies. Retorna nulo se ele ainda não aceitou 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getFieldReclassificationEnablingData: post: description: Obtém os dados de habilitação da reclassificação de campos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – username – fullName – email – enabled – enabledDate – message properties: username: type: string description: Usuário que habilitou a reclassificação de campos fullName: type: string description: Nome completo do usuário email: type: string description: E-mail do usuário enabled: type: boolean description: Informa se a relcassificação está ativada enabledDate: type: string format: date description: Data de ativação da reclassificação de campos message: type: string description: Messagem exemplo (E-mail de confirmação pendente | Reclassificação habilitada com sucesso) 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Dados de configuração de reclassificação de campos não encontrados default: description: Error response schema: #/definitions/genericError get: description: Obtém os dados de habilitação da reclassificação de campos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – username – fullName – email – enabled – enabledDate – message properties: username: type: string description: Usuário que habilitou a reclassificação de campos fullName: type: string description: Nome completo do usuário email: type: string description: E-mail do usuário enabled: type: boolean description: Informa se a relcassificação está ativada enabledDate: type: string format: date description: Data de ativação da reclassificação de campos message: type: string description: Messagem exemplo (E-mail de confirmação pendente | Reclassificação habilitada com sucesso) 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Dados de configuração de reclassificação de campos não encontrados default: description: Error response schema: #/definitions/genericError /lgpd/queries/supportCustomFieldEnabled: post: description: Verifica se o serviço possui suporte para campos de entidade customizada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domain – service properties: domain: type: string description: Nome do domínio service: type: string description: Nome do serviço responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indica se o suporte para campos customizados está ativo para o serviço informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o serviço possui suporte para campos de entidade customizada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domain description: Nome do domínio in: query required: true type: string – name: service description: Nome do serviço in: query required: true type: string responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indica se o suporte para campos customizados está ativo para o serviço informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/listReclassifiedFields: post: description: Lista os campos reclassificados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Número da página, se não informado o valor padrão será 0 default: 0 size: type: integer format: int64 description: Número total de registros por página, se não informado o valor será 10 default: 10 searchValue: type: string description: Filtro utilizado para localizar um campo ou mais responses: 200: description: Ok schema: type: object required: – fields – listInformation properties: fields: type: array items: type: object allOf: – #/definitions/reclassifiedFieldInfo minimum: 1 description: Lista de campos listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os campos reclassificados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página, se não informado o valor padrão será 0 in: query type: integer format: int64 – name: size description: Número total de registros por página, se não informado o valor será 10 in: query type: integer format: int64 – name: searchValue description: Filtro utilizado para localizar um campo ou mais in: query type: string responses: 200: description: Ok schema: type: object required: – fields – listInformation properties: fields: type: array items: type: object allOf: – #/definitions/reclassifiedFieldInfo minimum: 1 description: Lista de campos listInformation: type: object allOf: – #/definitions/listInformation description: Informação sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/listFieldChangeHistory: post: description: Lista o histórico de alterações de um campo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: page: type: integer format: int64 description: Número da página, se não informado o valor padrão será 0 default: 0 size: type: integer format: int64 description: Número total de registros por página, se não informado o valor será 10 default: 10 name: type: string description: Nome do campo responses: 200: description: Ok schema: type: object required: – history – listInformation properties: history: type: array items: type: object allOf: – #/definitions/fieldChangeHistory minimum: 1 description: Histórico de alterações de um campo listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista o histórico de alterações de um campo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página, se não informado o valor padrão será 0 in: query type: integer format: int64 – name: size description: Número total de registros por página, se não informado o valor será 10 in: query type: integer format: int64 – name: name description: Nome do campo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – history – listInformation properties: history: type: array items: type: object allOf: – #/definitions/fieldChangeHistory minimum: 1 description: Histórico de alterações de um campo listInformation: type: object allOf: – #/definitions/listInformation description: Informações sobre a listagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/queries/getFieldClassificationsByOwner: post: description: Retorna as informações de como o campo está classificado para os serviços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – field properties: field: type: string description: Nome do campo responses: 200: description: Ok schema: type: object required: – classificationByOwner properties: classificationByOwner: type: array items: type: object allOf: – #/definitions/ownerService minimum: 1 description: Lista as informações de classificação do campo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de como o campo está classificado para os serviços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: field description: Nome do campo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – classificationByOwner properties: classificationByOwner: type: array items: type: object allOf: – #/definitions/ownerService minimum: 1 description: Lista as informações de classificação do campo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/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 /lgpd/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 /lgpd/actions/registerDataField: post: description: Registra os campos que serão enviados para o LGPD tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/createDataField minimum: 1 description: Informação do campo que será registrado service: type: object allOf: – #/definitions/serviceData description: Serviço que utiliza os campos registrados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/requestDossier: post: description: Solicita dossiê, lançando o evento dossierRequested com os dados da pessoa\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/personData description: Filtro para localizar a pessoa fields: type: array items: type: object allOf: – #/definitions/selectedField description: Campos solicitados customFields: type: array items: type: object allOf: – #/definitions/selectedCustomField description: Campos customizados solicitados includeAllFields: type: boolean description: Incluir todos os campos na geração do Dossier default: false responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Retorna o identificador para consulta do dossiê 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /lgpd/actions/retryRequestDossier: post: description: Solicita a atualização de um dossiê existente lançando o evento dossierRequested\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket – requestType properties: ticket: type: string description: Identificador do dossiê gerado requestType: type: string allOf: – #/definitions/requestType description: Tipo da requisição do dossiê gerado filter: type: object allOf: – #/definitions/personData description: Filtro usado para identificação da pessoa responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerDossier: post: description: Registra o dossiê do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket – dossier properties: ticket: type: string description: Identificador da requisição dossiê dossier: type: object allOf: – #/definitions/dossierData description: Dados do Dossiê responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou não do registro dos dados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/requestDeleteInformation: post: description: Solicita a remoção de informações, lançando o evento deleteInformationRequested com os dados a serem deletados\n ### Resources:\n – res://senior.com.br/platform/lgpd/dossier\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket – fields properties: ticket: type: string description: Identificador da requisição dossiê fields: type: array items: type: string minimum: 1 description: Campos solicitados includeAllFields: type: boolean description: Incluir todos os campos na geração do Dossier default: false responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Retorna o identificador da consulta de remoção de campos do dossiê 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada 404: description: Requisição não encontrada default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerDeletedInformation: post: description: Registra as informações que foram deletas do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ticket – dossier properties: ticket: type: string description: Identificador da requisição dossier: type: object allOf: – #/definitions/dossierData description: Dados do Dossiê responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou não do registro de remoção dos dados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/acceptCookiesConsent: post: description: Registra que o usuário atual aceitou o consentimento de cookies tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/enableFieldReclassification: post: description: Habilita a reclassificação de campos tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/confirmFieldReclassification: post: description: Realiza a confirmação da ativação da reclassificação de campos por e-mail tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – token properties: token: type: string description: Token enviado por e-mail através da ação enableFieldReclassification responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lgpd/actions/registerFieldByTenant: post: description: Permite adicionar ou reclassificar um campo para o sistema tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/fieldTenant minimum: 1 description: Lista de campos para reclassificar ou cadastrar responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/restoreFields: post: description: Restaura os campos reclassificados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: string minimum: 1 description: Nome dos campos a serem restaurados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/actions/deleteDossier: post: description: Exclui os dossiês dos tickets informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /lgpd/events/dossierRequested: post: description: Notifica o produto para coletar os dados da pessoa x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – filter – fields properties: ticket: type: string description: ticket da requisição filter: type: object allOf: – #/definitions/personData description: Filtro dos campos fields: type: array items: type: string minimum: 1 description: Campos deseja consultar customFields: type: array items: type: object allOf: – #/definitions/completeCustomFieldEvent description: Campos customizados que deseja consultar responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /lgpd/events/dossierGenerationRequested: post: description: Notifica o produto para gerar o dossiê da pessoa informada no filtro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – filter – fields properties: ticket: type: string description: Ticket da requisição filter: type: object allOf: – #/definitions/personData description: Filtro para localizar a pessoa fields: type: array items: type: object allOf: – #/definitions/fieldWithOwner minimum: 1 description: Campos padrão de sistema que deseja consultar customFields: type: array items: type: object allOf: – #/definitions/completeCustomFieldEvent description: Campos de entidades customziadas que seja consultar responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /lgpd/events/deleteDossierRequested: post: description: Notifica o produto para excluir os dados da pessoa x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – filter – fields properties: ticket: type: string description: Ticket da requisição filter: type: object allOf: – #/definitions/personData description: Informações únicas da pessoa que deseja excluir os dados fields: type: array items: type: object allOf: – #/definitions/deleteField minimum: 1 description: Campos padrão do sistema para realizar a exclusão dos dados customFields: type: array items: type: object allOf: – #/definitions/completeCustomFieldEvent description: Campos customizados para realizar a exclusão dos dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /lgpd/events/deleteInformationRequested: post: description: Notifica produtos sobre a necessidade de remoção de dados do usuário x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket – filter – fields properties: ticket: type: string description: ticket da requisição filter: type: object allOf: – #/definitions/personData description: Filtro dos campos fields: type: array items: type: string minimum: 1 description: Campos padrões definidos pelos times de produtos que serão excluídos customFields: type: array items: type: object allOf: – #/definitions/completeCustomFieldEvent description: Campos customizados que serão exlcuídos responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do health check type: string enum: – UP – DOWN typeCustom: description: Tipo do campo que será registrado para o tenant type: string enum: – RECLASSIFICATION – CUSTOM_SERVICE requestType: description: Enum que identifica o Tipo de Requisição type: string enum: – DOSSIER – DELETE_INFORMATION processStatus: description: Enum que identifica o Status de Processamento type: string enum: – WAITING – PROCESSING – TIMEOUT – DONE – DONE_WITH_TIMEOUT – DONE_WITHOUT_INFORMATION – MORE_ONE_RECORD_FOUND requestStatus: description: Enum que identifica o status da requisição type: string enum: – PROCESSING – DONE – DONE_WITH_TIMEOUT deleteStatus: description: Enum que identifica o Status da Remoção de Informações type: string enum: – DELETED – NOT_FOUND – DELETION_UNAUTHORIZED_BY_TENANT – DELETION_UNAUTHORIZED_BY_SERVICE – DEFINED_LEGAL_OBLIGATION dataType: description: Tipos de dados type: string enum: – PERSONAL_DATA – SENSITIVE_PERSONAL_DATA – GENERIC_DATA 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 completeRequest: description: type: object required: – ticket – createdAt – requestType – status – filter – data – audit properties: ticket: type: string description: Ticket createdAt: type: string format: date-time description: Data da requisição requestType: type: string allOf: – #/definitions/requestType description: Tipo da requisição status: type: string allOf: – #/definitions/requestStatus description: Status filter: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Filtro dos campos data: type: array items: type: object allOf: – #/definitions/requestField minimum: 1 description: Dados retornados da requisição child: type: array items: type: object allOf: – #/definitions/requestData description: Se o tipo for DOSSIER, então pode haver requisições de delação filhas audit: type: object allOf: – #/definitions/audit description: Auditoria requestField: description: type: object required: – field – fieldInformation properties: field: type: object allOf: – #/definitions/field description: Campo fieldInformation: type: array items: type: object allOf: – #/definitions/requestFieldInformation minimum: 1 description: Informações encontradas/aplicadas sobre os campos fieldAvailable: type: boolean description: Campos que foram removidos/atualizados do dicionários de dados dos Serviços/Produtos que implementa o LGPD default: true customizable: type: boolean description: Indica se o campo é customizado default: false requestFieldInformation: description: type: object required: – owner – value properties: owner: type: object allOf: – #/definitions/ownerService description: Produto que possui as informações sensíveis value: type: string description: Valor deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Identifica o status de exclusão do campo informado processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso where: type: string description: Onde é utilizado complement: type: string description: Porque esse campo é importante consolidatedDossierData: description: Dados que identifica o dossiê consolidado type: object required: – field – informations properties: field: type: object allOf: – #/definitions/field description: Campo informations: type: array items: type: object allOf: – #/definitions/consolidatedInformationData minimum: 1 description: Informações coletadas por serviço consolidatedInformationData: description: Dados que identifica as informações por produto type: object required: – owner – value properties: owner: type: object allOf: – #/definitions/ownerService description: Produto que possui as informações sensíveis value: type: string description: Valor deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Identifica o status de exclusão do campo informado processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso dossierData: description: Dados que identifica a requisição type: object required: – owner properties: owner: type: object allOf: – #/definitions/serviceData description: Produto que possui as informações sensíveis informations: type: array items: type: object allOf: – #/definitions/informationData description: Informações sensíveis processStatus: type: string allOf: – #/definitions/processStatus description: Status do progresso informationData: description: Identifica os dados do campo type: object required: – field – whereUsed properties: field: type: object allOf: – #/definitions/fieldData description: Campo. Por exemplo: CPF whereUsed: type: string description: Onde é utilizado complement: type: string description: Porque esse campo é importante deleteStatus: type: string allOf: – #/definitions/deleteStatus description: Status de remoção serviceData: description: Dado que identifica o serviço type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio serviceName: type: string description: Nome do Serviço supportCustomField: type: boolean description: Indica se o serviço tem suporte para processar informações de campos de entidades customizadas default: false fieldData: description: Estrutura do campo utilizado no filtro de dados type: object required: – name – value properties: name: type: string description: Nome do campo value: type: string description: Valor do campo requestData: description: Dado que identifica a requisição type: object required: – ticket – createdAt – requestType – status – filter properties: ticket: type: string description: Ticket createdAt: type: string format: date-time description: Data da requisição createdAtFormatted: type: string description: Data da requisição formatada no idioma do usúario requestType: type: string allOf: – #/definitions/requestType description: Data da requisição status: type: string allOf: – #/definitions/requestStatus description: Status filter: type: object allOf: – #/definitions/personData description: Filtro dos campos ownerRequest: type: array items: type: object allOf: – #/definitions/ownerRequest description: Serviço proprietário da requisição do dossiê processStatus: type: array items: type: object allOf: – #/definitions/processStatusDetail description: Status do processamento por serviço filterData: description: Estrutura do campo utilizado no filtro de pesquisa do getAllDossiers type: object properties: status: type: string allOf: – #/definitions/processStatus description: Status personData: description: Campos usados na identificação da pessoa type: object properties: fields: type: array items: type: object allOf: – #/definitions/fieldData description: Campos que podem representar: CPF, RG, PIS, Passaporte, CRM e outros fieldWithOwner: description: Representa um campo e seus donos. Utilizado para solicitar a gereção de um dossiê type: object required: – name – owners properties: name: type: string description: Nome do campo owners: type: array items: type: object allOf: – #/definitions/serviceData minimum: 1 description: Serviços dono do campo field: description: Dados do campo resumido type: object required: – name – description properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo fiscal: type: boolean description: Indica se o campo faz parte de uma obrigação legal default: false isReclassified: type: boolean description: Indica se o campo foi reclassificado default: false fieldInfoDef: description: Representa um campo e suas configurações por serviço type: object required: – name – description – dataType – classificationByOwner properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: type: string allOf: – #/definitions/dataType description: Tipo do dado do campo classificationByOwner: type: array items: type: object allOf: – #/definitions/ownerService minimum: 1 description: Classificação do campo por serviço isReclassified: type: boolean description: Indica se o campo foi reclassificado default: false reasonChange: type: string description: Motivo pelo qual o campo foi reclassificado createDataField: description: Informações do campo que será registado type: object required: – name – description – dataType properties: name: type: string description: Nome de campo description: type: string description: Descrição do campo fiscal: type: boolean description: Indica se o campo faz parte de um obrigação legal default: false dataType: type: string allOf: – #/definitions/dataType description: Tipo do dado que o campo armazena, sendo (DADO GENÉRICO | DADO PESSOAL | DADO PESSOAL SENSÍVEL) canBeCustomized: type: boolean description: Indica se o campo pode ser customizado default: false reason: type: string description: Se a customização do campo não for permitida, o motivo deve ser informado fieldDef: description: Retorna o campo com a sua configuração por serviço type: object required: – name – description – dataType – legalObligation properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: type: string allOf: – #/definitions/dataType description: Tipo de dado armazenado no campo Ex.: (Dado Pessoal, Dado Pessoal Sensível) legalObligation: type: array items: type: object allOf: – #/definitions/ownerService minimum: 1 description: Serviços que considera o campo como obrigação legal ownerService: description: Serviço proprietário do campo, com as informações de classificação do campo type: object required: – domainName – serviceName – fiscal properties: domainName: type: string description: Domínio do serviço serviceName: type: string description: Nome do serviço fiscal: type: boolean description: Define se campo faz parte de uma obrigação legal (informações fiscais) canBeCustomized: type: boolean description: Indica se o campo pode ser reclassificado para este serviço default: false reason: type: string description: Caso o campo não possa ser classificado, o motivo deve ser informado customizedByUser: type: boolean description: Indica se o campo foi customizado pelo usuário default: false searchTerm: description: type: object required: – fieldNames – searchValue properties: fieldNames: type: array items: type: string minimum: 1 description: Nome do campo que será utilizado no filtro searchValue: type: string description: Valor do campo informado no filtro pagination: description: As configurações de paginação de uma listagem type: object properties: pageNumber: type: integer format: int64 description: O número da página retornado. A primeira pagina corresponde ao índice 0 default: 0 pageSize: type: integer format: int64 description: Quantidade de registros por página default: 10 listInformation: description: As infomações sobre os resultados de listagem realizada type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Quantidade total de resultados encontrados totalPages: type: integer format: int64 description: Quantidade total de paginas encontradas ownerRequest: description: Serviço que está registrado no LGPD esperando o retorno da solicitação do dossiê type: object required: – domainName – serviceName – status properties: domainName: type: string description: Domínio do serviço serviceName: type: string description: Nome de serviço status: type: string allOf: – #/definitions/processStatus description: Status do processo de geração do dossiê completeCustomField: description: Informação completa do campo customizado com suporte ao LGPD type: object required: – domainName – serviceName – data properties: domainName: type: string description: Nome do domainio serviceName: type: string description: Nome do serviço data: type: array items: type: object allOf: – #/definitions/customField minimum: 1 description: Informações do campo customizado customField: description: Campos customizados que serão enviados para geração do dossiê type: object required: – entityName – fields properties: entityName: type: string description: Nome da entidade que contem campos customizados fields: type: array items: type: object allOf: – #/definitions/customFieldDef minimum: 1 description: Campos customizados completeCustomFieldEvent: description: Informações completas do campo customizado para publicar o evento de requisição/deleção do dossiê type: object required: – domainName – serviceName – data properties: domainName: type: string description: Nome do domínio que pertece o campo customizado serviceName: type: string description: Nome do serviço que pertence o campo customizado data: type: array items: type: object allOf: – #/definitions/customFieldEvent minimum: 1 description: Campos customizados customFieldEvent: description: Campo customizado para publicação do evento de requisição/deleção do dossiê type: object required: – entityName – fields properties: entityName: type: string description: Nome da entidade que pertence o campo customizado fields: type: array items: type: object allOf: – #/definitions/fieldEvent minimum: 1 description: Campos customizados com suporte ao LGPD que entidade possui fieldEvent: description: Campo utilizado no evento de requisição/deleção do dossiê type: object required: – name – fiscal properties: name: type: string description: Nome do campo fiscal: type: boolean description: O campo é uma obrigação legal customFieldDef: description: Informações do campo type: object required: – name – fiscal properties: name: type: string description: Nome do campo fiscal: type: boolean description: O campo é uma obrigação legal description: type: string description: Descrição do campo dataType: type: string allOf: – #/definitions/dataType description: Tipo do dado armazenado (DADO PESSOAL ou DADO PESSOAL SENSÍVEL) selectedCustomField: description: Campo de entidades customizadas: Campos criado pelo Field Customization type: object required: – domainName – serviceName – entityName – name – description properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço entityName: type: string description: Nome da entidade que pertence o campo customizado name: type: string description: Nome do campo do campo description: type: string description: Descrição do campo fiscal: type: boolean description: O campo é uma obrigação legal default: false audit: description: Auditoria de geração de dossiê type: object required: – createdBy – createDate properties: createdBy: type: string description: Nome do usuário que criou o dossiê createDate: type: string description: Data da criação selectedField: description: Campo padrão selecionado para geração do dossiê type: object required: – name – description properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo isReclassified: type: boolean description: Identifica se o campo é reclassificado default: false deleteField: description: Campo que comtém a informação que será excluída type: object required: – name – classificationByOwner properties: name: type: string description: Nome do campo classificationByOwner: type: array items: type: object allOf: – #/definitions/fieldClassification minimum: 1 description: Classificação por serviço fieldClassification: description: Classificação do campo type: object required: – domainName – serviceName – fiscal – reclassifiedByUser properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço fiscal: type: boolean description: O campo é uma obrigação legal reclassifiedByUser: type: boolean description: Indica se campo foi reclassificado pelo usuário fieldTenant: description: Representa as informações básica de um campo que será registrado no tenant discriminator: _discriminator type: object required: – name – dataType – typeCustom – _discriminator properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: type: string allOf: – #/definitions/dataType description: Tipo de dado que o campo armazena exemplo: (DADO PESSOAL|DADO PESSOAL SENSÍVEL) typeCustom: type: string allOf: – #/definitions/typeCustom description: Tipo do campo, para indicar se o campo é reclassificado ou customizado _discriminator: type: string description: legalObligation: description: Informa para qual serviço um determinado campo faz parte de uma obrigação legal type: object required: – domainName – serviceName – fiscal properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço fiscal: type: boolean description: Indica se é uma obrigação legal reclassifyField: description: Representa o registro de reclassificação de um campo allOf: – #/definitions/fieldTenant – type: object required: – reasonChange properties: reasonChange: type: string description: Motivo da reclassificação legalObligation: type: array items: type: object allOf: – #/definitions/legalObligation description: Configuração de obrigação legal de um derteminado campo para os serviços registerCustomField: description: Representa o registro de um campo para o tenant allOf: – #/definitions/fieldTenant – type: object required: – domainName – serviceName – entityName – fiscal properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço entityName: type: string description: Nome da entidade que o campo pertence fiscal: type: boolean description: Informa se o campo é fiscal reclassifiedFieldInfo: description: Representa um campo reclassificado type: object required: – name – description – dataType – reasonChange – change – classificationByOwner – audit properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: type: string allOf: – #/definitions/dataType description: Tipo de dado do campo, exemplo: DADO PESSOAL | DADO PESSOAL SENSÍVEL reasonChange: type: string description: Motivo que gerou a reclassificação do campo change: type: string description: Alteração que foi realizada no campo, tendo o valor anterior e o valor atual separados por pipe. Exemplo: DADO PESSOAL|DADO PESSOAL SENSÍVEL classificationByOwner: type: array items: type: object allOf: – #/definitions/reclassifiedLegalObligation minimum: 1 description: Informa para quais serviços este campo é uma obrigação legal audit: type: object allOf: – #/definitions/auditField description: Informações de auditoria reclassifiedLegalObligation: description: Representa a definição de obrigação legal do campo para um serviço type: object required: – domainName – serviceName – fiscal – change properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço fiscal: type: boolean description: Indica se o campo é uma obrigação legal change: type: string description: Alteração que foi realizada no campo, tendo o valor anterior e o valor atual separados por pipe. Exemplo: Sim|Não auditField: description: Auditoria de alteração de campos type: object required: – createdBy – createdAt properties: createdBy: type: string description: Nome do usuário que reclassificou o campo createdAt: type: string format: date-time description: Data da criação updatedAt: type: string format: date-time description: Data da última atualização updatedBy: type: string description: Usuário que realizou a última alteração fieldChangeHistory: description: Histórico de alteração de um campo type: object required: – username – operation – createdAt – classificationByOwner properties: username: type: string description: Nome do usuário que realizou a alteração operation: type: string description: Tipo de alteração createdAt: type: string format: date-time description: Data da alteração change: type: string description: Alteração realizada classificationByOwner: type: array items: type: object allOf: – #/definitions/legalObligationChangeHistory minimum: 1 description: Obrigação legal legalObligationChangeHistory: description: Histórico de alteração de uma obrigação legal type: object required: – domainName – serviceName – change properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço change: type: string description: Alteração realizada processStatusDetail: description: Representa o status de cada serviço type: object required: – domainName – serviceName – status properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço status: type: string allOf: – #/definitions/processStatus description: Nome do status checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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