Merge pull request #2395 from Sensedia/aggr-consents

Aggr consents

dictionary/consentsGetConsentsConsentIdExtends_v2.csv

@@ -0,0 +1,10 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format), utilizado apenas para consulta de alterações históricas de extensão do consentimento.;Date Hora;20;Opcional;(^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$);;0;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/loggedUser;loggedUser;"Usuário (pessoa natural) que encontra-se logado na instituição receptora e que iniciará o processo de consentimento para compartilhamento de dados.  
+Deve ser armazenado como novo usuário logado responsável pela renovação do consentimento atual.
+";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/loggedUser/document;document;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/loggedUser/document/identification;identification;Número do documento de identificação oficial do usuário.;Texto;11;Obrigatório;^\d{11}$;;1;1;"";Não permitido;string;11111111111;
+/data/loggedUser/document/rel;rel;Tipo do documento de identificação oficial do usuário.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;CPF;
+/data/requestDateTime;requestDateTime;Data e hora em que o recurso foi criado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;

dictionary/consentsGetConsentsConsentId_v2.csv

@@ -50,7 +50,7 @@ CREDIT_FIXED_INCOMES_READ
 FUNDS_READ 
 VARIABLE_INCOMES_READ 
 TREASURE_TITLES_READ";1;N;"";Não permitido;array;;
-/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC (UTC time format). Para consentimentos com prazo indeterminado, é esperado preenchimento com `2300-01-01T00:00:00Z`.;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
 /data/rejection;rejection;Objeto a ser retornado caso o consentimento seja rejeitado.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
 /data/rejection/rejectedBy;rejectedBy;"Informar usuário responsável pela rejeição.   
 1. USER usuário   

dictionary/consentsGetConsentsConsentId_v3.csv

@@ -0,0 +1,77 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/consentId;consentId;"O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.  
+Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource 
+Identifier - URI - que é atribuído sob o URI scheme ""urn"" e um namespace URN específico, com a intenção de que o URN 
+seja um identificador de recurso persistente e independente da localização.  
+Considerando a string urn:bancoex:C1DD33123 como exemplo para consentId temos:
+- o namespace(urn)
+- o identificador associado ao namespace da instituição transnmissora (bancoex) 
+- o identificador específico dentro do namespace (C1DD33123).  
+Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
+";Texto;256;Obrigatório;"^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$";;1;1;"";Não permitido;string;urn:bancoex:C1DD33123;
+/data/creationDateTime;creationDateTime;Data e hora em que o recurso foi criado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/status;status;Estado atual do consentimento cadastrado.;Texto;;Obrigatório;;"AUTHORISED 
+AWAITING_AUTHORISATION 
+REJECTED";1;1;"";Não permitido;string;AWAITING_AUTHORISATION;
+/data/statusUpdateDateTime;statusUpdateDateTime;Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/permissions;permissions;Especifica os tipos de permissões de acesso às APIs no escopo do Open Finance Brasil - Dados cadastrais e transacionais, de acordo com os blocos de consentimento fornecidos pelo usuário e necessários ao acesso a cada endpoint das APIs. Esse array não deve ter duplicidade de itens.;Lista;;Obrigatório;;"ACCOUNTS_READ 
+ACCOUNTS_BALANCES_READ 
+ACCOUNTS_TRANSACTIONS_READ 
+ACCOUNTS_OVERDRAFT_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ 
+CREDIT_CARDS_ACCOUNTS_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ 
+CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ 
+CUSTOMERS_PERSONAL_ADITTIONALINFO_READ 
+CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ 
+CUSTOMERS_BUSINESS_ADITTIONALINFO_READ 
+FINANCINGS_READ 
+FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+FINANCINGS_PAYMENTS_READ 
+FINANCINGS_WARRANTIES_READ 
+INVOICE_FINANCINGS_READ 
+INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+INVOICE_FINANCINGS_PAYMENTS_READ 
+INVOICE_FINANCINGS_WARRANTIES_READ 
+LOANS_READ 
+LOANS_SCHEDULED_INSTALMENTS_READ 
+LOANS_PAYMENTS_READ 
+LOANS_WARRANTIES_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ 
+RESOURCES_READ 
+BANK_FIXED_INCOMES_READ 
+CREDIT_FIXED_INCOMES_READ 
+FUNDS_READ 
+VARIABLE_INCOMES_READ 
+TREASURE_TITLES_READ";1;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/rejection;rejection;Objeto a ser retornado caso o consentimento seja rejeitado.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/rejection/rejectedBy;rejectedBy;"Informar usuário responsável pela rejeição.   
+1. USER usuário   
+2. ASPSP instituição transmissora   
+3. TPP instituição receptora   
+";Texto;;Obrigatório;;"USER 
+ASPSP 
+TPP";1;1;"";Não permitido;string;USER;
+/data/rejection/reason;reason;Define a razão pela qual o consentimento foi rejeitado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/rejection/reason/code;code;"Define o código da razão pela qual o consentimento foi rejeitado.
+
+- CONSENT_EXPIRED – consentimento que ultrapassou o tempo limite para autorização.   
+- CUSTOMER_MANUALLY_REJECTED – cliente efetuou a rejeição do consentimento manualmente através de interação nas instituições participantes.   
+- CUSTOMER_MANUALLY_REVOKED – cliente efetuou a revogação após a autorização do consentimento.   
+- CONSENT_MAX_DATE_REACHED – consentimento que ultrapassou o tempo limite de compartilhamento.   
+- CONSENT_TECHNICAL_ISSUE – consentimento que foi rejeitado devido a um problema técnico que impossibilita seu uso pela instituição receptora, por exemplo: falha associada a troca do AuthCode pelo AccessToken, durante o processo de Hybid Flow.   
+- INTERNAL_SECURITY_REASON – consentimento que foi rejeitado devido as políticas de segurança aplicada pela instituição transmissora.
+";Texto;;Obrigatório;;"CONSENT_EXPIRED 
+CUSTOMER_MANUALLY_REJECTED 
+CUSTOMER_MANUALLY_REVOKED 
+CONSENT_MAX_DATE_REACHED 
+CONSENT_TECHNICAL_ISSUE 
+INTERNAL_SECURITY_REASON";1;1;"";Não permitido;string;CONSENT_EXPIRED;
+/data/rejection/reason/additionalInformation;additionalInformation;Contém informações adicionais a critério da transmissora.;Texto;140;Opcional;^(?!\s)[\w\W\s]*[^\s]$;;0;1;"";Não permitido;string;Tempo de confirmação da múltipla alçada excedido.;

dictionary/consentsPostConsentsConsentIdExtends_v2.csv

@@ -0,0 +1,49 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/consentId;consentId;"[O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.](https://tools.ietf.org/html/rfc8141)  
+";Texto;256;Obrigatório;"^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$";;1;1;"";Não permitido;string;urn:bancoex:C1DD33123;
+/data/creationDateTime;creationDateTime;Data e hora em que o recurso foi criado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/status;status;Estado atual do consentimento cadastrado.;Texto;;Obrigatório;;"AUTHORISED 
+AWAITING_AUTHORISATION 
+REJECTED";1;1;"";Não permitido;string;AWAITING_AUTHORISATION;
+/data/statusUpdateDateTime;statusUpdateDateTime;Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/permissions;permissions;Especifica os tipos de permissões de acesso às APIs no escopo do Open Finance Brasil - Dados cadastrais e transacionais, de acordo com os blocos de consentimento fornecidos pelo usuário e necessários ao acesso a cada endpoint das APIs. Esse array não deve ter duplicidade de itens.;Lista;;Obrigatório;;"ACCOUNTS_READ 
+ACCOUNTS_BALANCES_READ 
+ACCOUNTS_TRANSACTIONS_READ 
+ACCOUNTS_OVERDRAFT_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ 
+CREDIT_CARDS_ACCOUNTS_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ 
+CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ 
+CUSTOMERS_PERSONAL_ADITTIONALINFO_READ 
+CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ 
+CUSTOMERS_BUSINESS_ADITTIONALINFO_READ 
+FINANCINGS_READ 
+FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+FINANCINGS_PAYMENTS_READ 
+FINANCINGS_WARRANTIES_READ 
+INVOICE_FINANCINGS_READ 
+INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+INVOICE_FINANCINGS_PAYMENTS_READ 
+INVOICE_FINANCINGS_WARRANTIES_READ 
+LOANS_READ 
+LOANS_SCHEDULED_INSTALMENTS_READ 
+LOANS_PAYMENTS_READ 
+LOANS_WARRANTIES_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ 
+RESOURCES_READ 
+BANK_FIXED_INCOMES_READ 
+CREDIT_FIXED_INCOMES_READ 
+FUNDS_READ 
+VARIABLE_INCOMES_READ 
+TREASURE_TITLES_READ";1;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;"Data e hora de expiração da permissão. Deve ser preenchido caso o consentimento tenha data limite de validade. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
+
+[Restrição] Aceitar apenas data no futuro em relação à data de requisição.
+";Date Hora;20;Condicional;;;0;1;" Aceitar apenas data no futuro em relação à data de requisição.
+";Não permitido;string;2021-05-21T08:30:00Z;

dictionary/consentsPostConsents_v2.csv

@@ -50,4 +50,4 @@ CREDIT_FIXED_INCOMES_READ
 FUNDS_READ 
 VARIABLE_INCOMES_READ 
 TREASURE_TITLES_READ";1;N;"";Não permitido;array;;
-/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC (UTC time format). Para consentimentos com prazo indeterminado, é esperado preenchimento com `2300-01-01T00:00:00Z`.;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;

dictionary/consentsPostConsents_v3.csv

@@ -0,0 +1,53 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/consentId;consentId;"O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.  
+Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource 
+Identifier - URI - que é atribuído sob o URI scheme ""urn"" e um namespace URN específico, com a intenção de que o URN 
+seja um identificador de recurso persistente e independente da localização.  
+Considerando a string urn:bancoex:C1DD33123 como exemplo para consentId temos:
+- o namespace(urn)
+- o identificador associado ao namespace da instituição transnmissora (bancoex) 
+- o identificador específico dentro do namespace (C1DD33123).  
+Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
+";Texto;256;Obrigatório;"^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$";;1;1;"";Não permitido;string;urn:bancoex:C1DD33123;
+/data/creationDateTime;creationDateTime;Data e hora em que o recurso foi criado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/status;status;Estado atual do consentimento cadastrado.;Texto;;Obrigatório;;"AUTHORISED 
+AWAITING_AUTHORISATION 
+REJECTED";1;1;"";Não permitido;string;AWAITING_AUTHORISATION;
+/data/statusUpdateDateTime;statusUpdateDateTime;Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/permissions;permissions;Especifica os tipos de permissões de acesso às APIs no escopo do Open Finance Brasil - Dados cadastrais e transacionais, de acordo com os blocos de consentimento fornecidos pelo usuário e necessários ao acesso a cada endpoint das APIs. Esse array não deve ter duplicidade de itens.;Lista;;Obrigatório;;"ACCOUNTS_READ 
+ACCOUNTS_BALANCES_READ 
+ACCOUNTS_TRANSACTIONS_READ 
+ACCOUNTS_OVERDRAFT_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_READ 
+CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ 
+CREDIT_CARDS_ACCOUNTS_LIMITS_READ 
+CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ 
+CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ 
+CUSTOMERS_PERSONAL_ADITTIONALINFO_READ 
+CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ 
+CUSTOMERS_BUSINESS_ADITTIONALINFO_READ 
+FINANCINGS_READ 
+FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+FINANCINGS_PAYMENTS_READ 
+FINANCINGS_WARRANTIES_READ 
+INVOICE_FINANCINGS_READ 
+INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ 
+INVOICE_FINANCINGS_PAYMENTS_READ 
+INVOICE_FINANCINGS_WARRANTIES_READ 
+LOANS_READ 
+LOANS_SCHEDULED_INSTALMENTS_READ 
+LOANS_PAYMENTS_READ 
+LOANS_WARRANTIES_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ 
+UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ 
+RESOURCES_READ 
+BANK_FIXED_INCOMES_READ 
+CREDIT_FIXED_INCOMES_READ 
+FUNDS_READ 
+VARIABLE_INCOMES_READ 
+TREASURE_TITLES_READ";1;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).;Date Hora;20;Obrigatório;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;