GT Dados do cliente: Feat(Consents) Versão 3.3.1

dictionary/consentsDeleteConsentsConsentId_v3.3.1.csv

@@ -0,0 +1 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Obrigatório por Regulação;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo

dictionary/consentsGetConsentsConsentIdExtensions_v3.3.1.csv

@@ -0,0 +1,33 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Obrigatório por Regulação;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;Opcional;;;0;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;"Data e hora de expiração da permissão. 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.
+
+[Restrição] De preenchimento obrigatório nos casos em que houver validade determinada.
+
+Em casos de consentimento com prazo indeterminada o campo não deve ser preenchido.
+";Date Hora;20;Condicional;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;" De preenchimento obrigatório nos casos em que houver validade determinada.
+
+Em casos de consentimento com prazo indeterminada o campo não deve ser preenchido.
+";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;Opcional;;;1;1;"";Não permitido;object;;
+/data/loggedUser/document;document;;Objeto;;Obrigatório;Opcional;;;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;Opcional;^\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;Opcional;^[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;Opcional;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/previousExpirationDateTime;previousExpirationDateTime;"Data e hora de expiração anteriores a renovação. Reflete a data limite anterior 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).
+
+[Restrição] De preenchimento obrigatório nos casos em que houver validade determinada. Em casos de consentimento com prazo indeterminado, ou renovações feitas com a v2.2.0 em que não exista persistência dessa informação, o campo não deve ser preenchido.
+";Date Hora;20;Condicional;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;" De preenchimento obrigatório nos casos em que houver validade determinada. Em casos de consentimento com prazo indeterminado, ou renovações feitas com a v2.2.0 em que não exista persistência dessa informação, o campo não deve ser preenchido.
+";Não permitido;string;2023-10-18T18:30:00Z;
+/data/xFapiCustomerIpAddress;xFapiCustomerIpAddress;"O endereço IP do usuário logado com o receptor que solicitou a renovação sem redirecionamento.
+
+[Restrição] De preenchimento obrigatório a partir da v3.0.0. Opcional para renovações feitas com a v2.2.0 quando não existir persistência dessa informação.
+";Texto;100;Condicional;Opcional;^[^\s](.*[^\s])?$;;0;1;" De preenchimento obrigatório a partir da v3.0.0. Opcional para renovações feitas com a v2.2.0 quando não existir persistência dessa informação.
+";Não permitido;string;172.217.22.14;1
+/data/xCustomerUserAgent;xCustomerUserAgent;"Indica o user-agent que o usuário utilizou quando solicitou a renovação sem redirecionamento.
+
+[Restrição] De preenchimento obrigatório a partir da v3.0.0. Opcional para renovações feitas com a v2.2.0 quando não existir persistência dessa informação.
+";Texto;255;Condicional;Opcional;^[^\s](.*[^\s])?$;;0;1;" De preenchimento obrigatório a partir da v3.0.0. Opcional para renovações feitas com a v2.2.0 quando não existir persistência dessa informação.
+";Não permitido;string;"Mozilla/5.0 (iPhone14,6; U; CPU iPhone OS 15_4 like Mac OS X)";1

dictionary/consentsGetConsentsConsentId_v3.3.1.csv

@@ -0,0 +1,88 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Obrigatório por Regulação;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;Opcional;;;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;Opcional;"^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;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$;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/status;status;Estado atual do consentimento cadastrado.;Texto;;Obrigatório;Opcional;;"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;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$;;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;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 
+EXCHANGES_READ";1;N;"";Não permitido;array;;
+/data/expirationDateTime;expirationDateTime;"Data e hora de expiração da permissão. 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).  
+
+[Restrição] De preenchimento obrigatório nos casos em que houver validade determinada. Em casos de consentimento com prazo indeterminado o campo não deve ser preenchido.
+";Date Hora;20;Condicional;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;" De preenchimento obrigatório nos casos em que houver validade determinada. Em casos de consentimento com prazo indeterminado o campo não deve ser preenchido.
+";Não permitido;string;2021-05-21T08:30:00Z;
+/data/rejection;rejection;Objeto a ser retornado caso o consentimento seja rejeitado.;Objeto;;Opcional;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;Opcional;;"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;Opcional;;;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 Hybrid Flow.   
+- INTERNAL_SECURITY_REASON – consentimento que foi rejeitado devido as políticas de segurança aplicada pela instituição transmissora.
+";Texto;;Obrigatório;Opcional;;"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;Opcional;^[^\s](.*[^\s])?$;;0;1;"";Não permitido;string;Tempo de confirmação da múltipla alçada excedido.;
+/data/journey;journey;"Informações adicionais sobre o contexto de Jornada Otimizada. [RESTRIÇÃO] Objeto de envio obrigatório quando o usuário manifestar consentimento para compartilhamento de saldo  através da Jornada Otimizada.
+";Objeto;;Opcional;Opcional;;;0;1;"";Não permitido;object;;
+/data/journey/isLinked;isLinked;"Campo para identificação de consentimento iniciado em Jornada Otimizada. [RESTRIÇÃO] Campo de preenchimento obrigatório para todo consentimento iniciado a partir da jornada otimizada, independente do status do consentimento.
+";Booleano;;Opcional;Opcional;;;0;1;"";Não permitido;boolean;true;
+/data/journey/linkId;linkId;"Identificador do consentimento de pagamento/vínculo ao qual este consentimento está vinculado. [RESTRIÇÃO] Esse campo será preenchido caso o consentimento tenha sido autorizado ou rejeitado por ação do cliente.
+";Texto;256;Opcional;Opcional;"^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*'%\/?#]+$";;0;1;"";Não permitido;string;urn:bancoex:C1DD331237;

dictionary/consentsPostConsentsConsentIdExtends_v3.3.1.csv

@@ -0,0 +1,60 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Obrigatório por Regulação;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;Opcional;;;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;Opcional;"^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;Opcional;;;1;1;"";Não permitido;string;2021-05-21T08:30:00Z;
+/data/status;status;Estado atual do consentimento cadastrado.;Texto;;Obrigatório;Opcional;;"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;Opcional;;;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;Opcional;;"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. 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).
+
+[Restrição] De preenchimento obrigatório nos casos em que houver validade determinada.
+Em casos de consentimento com prazo indeterminado o campo não deve ser enviado.
+";Date Hora;20;Condicional;Opcional;;;0;1;" De preenchimento obrigatório nos casos em que houver validade determinada.
+Em casos de consentimento com prazo indeterminado o campo não deve ser enviado.
+";Não permitido;string;2021-05-21T08:30:00Z;