LGPD – Lei Geral de Proteção de Dados (lgpd)

2.0info: 6.2.0 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: api.senior.com.br /platform/lgpd/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /getRequest: post: description: Obtém dados de uma requisição ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: – ticket – createdAt – requestType – status – filter – data – audit properties: ticket: type: string description: Ticket createdAt: type: string description: Data da requisição requestType: #/definitions/requestType status: #/definitions/requestStatus filter: #/definitions/fieldData data: #/definitions/requestField child: #/definitions/requestData audit: #/definitions/audit 403: description: Permissão negada 401: description: Usuário ou senha inválidos 404: description: Requisição não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getDossier: post: description: Obtém o dossiê da pessoa ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/consolidatedDossierData status: #/definitions/requestStatus 403: description: Permissão negada 401: description: Usuário ou senha inválidos 404: description: Requisição não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /listFields: post: description: Lista os campos que armazena dados a serem tratados pelo LGPD x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: page: type: integer description: Número da pagina, se não informado o valor padrão será '0' size: type: integer description: Número total de registros por página, se não informado o valor será '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: #/definitions/fieldInfoDef listInformation: #/definitions/listInformation default: description: Error response schema: #/definitions/genericError /listRequests: post: description: Lista as requisições de dossiês gerados ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: requestType: #/definitions/requestType status: #/definitions/requestStatus searchTerm: #/definitions/searchTerm pagination: #/definitions/pagination responses: 200: description: Ok schema: type: object required: – requests – listInformation properties: requests: #/definitions/requestData listInformation: #/definitions/listInformation 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /exportDossier: post: description: Exportar Dossiê para PDF ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 description: 403: description: Permissão negada 401: description: Usuário ou senha inválidos 404: description: Requisição não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /requestDeleteInformation: post: description: Solicita a remoção de informações, lançando o evento 'deleteInformationRequested' com os dados a serem deletados ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 description: Campos solicitados 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ê 403: description: Permissão negada 401: description: Usuário ou senha inválidos 404: description: Requisição não encontrada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getFields: post: description: Obtém os campos que armazena dados que devem ser tratados pelo LGPD (Lei Geral de Proteção de Dados) x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 responses: 200: description: Ok schema: type: object required: – fields properties: fields: #/definitions/fieldDef customFields: #/definitions/completeCustomField 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /getFieldReclassificationEnablingData: post: description: Obtém os dados de habilitação da reclassificação de campos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: 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 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) 404: description: Dados de configuração de reclassificação de campos não encontrados 403: description: Permissão negada 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /retryRequestDossier: post: description: Solicita a atualização de um dossiê existente lançando o evento 'dossierRequested' ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – ticket – requestType properties: ticket: type: string description: Identificador do dossiê gerado requestType: #/definitions/requestType responses: 200: description: Ok 403: description: Permissão negada 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /requestDossier: post: description: Solicita dossiê, lançando o evento 'dossierRequested' com os dados da pessoa ### Resources: – res://senior.com.br/platform/lgpd/dossier x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – filter – fields properties: filter: #/definitions/personData fields: type: array items: #/definitions/selectedField description: Campos solicitados customFields: type: array items: #/definitions/selectedCustomField description: Campos customizados solicitados responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Retorna o identificador para consulta do dossiê 403: description: Permissão negada 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: requestType: type: string enum: – DOSSIER – DELETE_INFORMATION requestStatus: type: string enum: – PROCESSING – DONE – DONE_WITH_TIMEOUT deleteStatus: type: string enum: – DELETED – NOT_FOUND – DELETION_UNAUTHORIZED_BY_TENANT – DELETION_UNAUTHORIZED_BY_SERVICE processStatus: type: string enum: – WAITING – PROCESSING – TIMEOUT – DONE – DONE_WITH_TIMEOUT – DONE_WITHOUT_INFORMATION dataType: type: string enum: – PERSONAL_DATA – SENSITIVE_PERSONAL_DATA – GENERIC_DATA requestField: type: object required: – field – fieldInformation properties: field: #/definitions/field fieldInformation: type: array items: #/definitions/requestFieldInformation 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 customizable: type: boolean description: Indica se o campo é customizado field: 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 requestFieldInformation: type: object required: – owner – value properties: owner: #/definitions/ownerService value: type: string description: Valor deleteStatus: #/definitions/deleteStatus processStatus: #/definitions/processStatus where: type: string description: Onde é utilizado complement: type: string description: Porque esse campo é importante ownerService: 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 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 consolidatedDossierData: type: object required: – field – informations properties: field: #/definitions/field informations: type: array items: #/definitions/consolidatedInformationData description: Informações coletadas por serviço consolidatedInformationData: type: object required: – owner – value properties: owner: #/definitions/ownerService value: type: string description: Valor deleteStatus: #/definitions/deleteStatus processStatus: #/definitions/processStatus fieldData: type: object required: – name – value properties: name: type: string description: Nome do campo value: type: string description: Valor do campo requestData: type: object required: – ticket – createdAt – requestType – status – filter properties: ticket: type: string description: Ticket createdAt: type: string description: Data da requisição format: date-time createdAtFormatted: type: string description: Data da requisição formatada no idioma do usúario requestType: #/definitions/requestType status: #/definitions/requestStatus filter: #/definitions/personData ownerRequest: type: array items: #/definitions/ownerRequest description: Serviço proprietário da requisição do dossiê personData: type: object properties: fields: type: array items: #/definitions/fieldData description: Campos que podem representar: CPF, RG, PIS, Passaporte, CRM e outros ownerRequest: 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: #/definitions/processStatus fieldInfoDef: type: object required: – name – description – dataType – classificationByOwner properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: #/definitions/dataType classificationByOwner: type: array items: #/definitions/ownerService description: Classificação do campo por serviço fieldDef: type: object required: – name – description – dataType – legalObligation properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo dataType: #/definitions/dataType legalObligation: type: array items: #/definitions/ownerService description: Serviços que considera o campo como obrigação legal searchTerm: type: object required: – fieldNames – searchValue properties: fieldNames: type: array items: type: string description: Nome do campo que será utilizado no filtro searchValue: type: string description: Valor do campo informado no filtro pagination: type: object properties: pageNumber: type: integer description: O número da página retornado. A primeira pagina corresponde ao índice 0 pageSize: type: integer description: Quantidade de registros por página listInformation: type: object required: – totalElements – totalPages properties: totalElements: type: integer description: Quantidade total de resultados encontrados totalPages: type: integer description: Quantidade total de paginas encontradas completeCustomField: 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: #/definitions/customField description: Informações do campo customizado customField: type: object required: – entityName – fields properties: entityName: type: string description: Nome da entidade que contem campos customizados fields: type: array items: #/definitions/customFieldDef description: Campos customizados customFieldDef: 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: #/definitions/dataType selectedCustomField: 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 audit: 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: type: object required: – name – description properties: name: type: string description: Nome do campo description: type: string description: Descrição do campo 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

Plataforma (platform)