Merge pull request #286 from Sensedia/draft-release-enrollments-2023-…

…09-13

GT Serviços; Feat(Enrollments); PJR29

dictionary/enrollmentCreateFidoRegistrationOptions_v1.csv

@@ -4,9 +4,9 @@
 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:
+Considerando a string urn:bancoex:C1DD33123 como exemplo para enrollmentId temos:
 - o namespace(urn)
-- o identificador associado ao namespace da instituição transnmissora (bancoex)
+- o identificador associado ao namespace da instituição detentora de conta (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;
@@ -32,3 +32,4 @@ Informações mais detalhadas sobre a construção de namespaces devem ser consu
 /data/authenticatorSelection/userVerification;userVerification;Indica o requisito de verificação do usuário.;Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
 /data/attestation;attestation;Indica o tipo de attestation que o autenticador pode utilizar.;Texto;;Opcional;;;0;1;"";Não permitido;string;none, indirect, direct, enterprise;
 /data/attestationFormats;attestationFormats;Indica as preferências de formato sobre o campo attestation.;Lista;;Opcional;;;0;N;"";Não permitido;array;packed, tpm, android-key, android-safetynet, fido-u2f, apple, none;
+/data/extensions;extensions;Campo de extensão com opções que variam por plataforma.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;

dictionary/enrollmentCreateFidoSigningOptions_v1.csv

@@ -8,3 +8,4 @@
 /data/allowCredentials/type;type;Identificador do tipo de credencial.;Texto;;Obrigatório;;;1;1;"";Não permitido;string;public-key;
 /data/allowCredentials/transports;transports;Indicação opcional de como o cliente pode se comunicar com o autenticador do dispositivo.;Lista;;Opcional;;;0;N;"";Não permitido;array;usb, nfc, ble, smart-card, hybrid, internal;
 /data/userVerification;userVerification;;Texto;;Opcional;;;0;1;"";Não permitido;string;required, preferred, discouraged;
+/data/extensions;extensions;Campo de extensão com opções que variam por plataforma.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;

dictionary/getEnrollment_v1.csv

@@ -4,16 +4,18 @@
 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:
+Considerando a string urn:bancoex:C1DD33123 como exemplo para enrollmentId temos:
 - o namespace(urn)
-- o identificador associado ao namespace da instituição transnmissora (bancoex)
+- o identificador associado ao namespace da instituição detentora de conta (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;O instante em que o vínculo de conta foi criado no ambiente da detentora.;Date Hora;20;Obrigatório;^(\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;2023-07-12T08:30:00Z;
 /data/status;status;"Status do vínculo de conta:
 
-• AWAITING_AUTHORISATION: Vínculo de conta criado e aguando autorização no ambiente da dentora de conta.
+• AWAITING_RISK_SIGNALS: Vínculo de conta criado e aguardando envio dos sinais de risco para a dentora.
+
+• AWAITING_ACCOUNT_HOLDER_VALIDATION: Vínculo de conta aguardando autorização no ambiente da detentora.
 
 • AWAITING_ENROLLMENT: Vínculo de conta autorizado no ambiente da detentora e aguardando o vínculo de credenciais (FIDO2).
 
@@ -22,7 +24,8 @@ Informações mais detalhadas sobre a construção de namespaces devem ser consu
 • REVOKED: Vínculo de conta revogado.
 
 • REJECTED: Vínculo de conta rejeitado.
-";Texto;;Obrigatório;;"AWAITING_AUTHORISATION 
+";Texto;;Obrigatório;;"AWAITING_RISK_SIGNALS 
+AWAITING_ACCOUNT_HOLDER_VALIDATION 
 AWAITING_ENROLLMENT 
 AUTHORISED 
 REVOKED 
@@ -38,30 +41,7 @@ REJECTED";1;1;"";Não permitido;string;;
 /data/businessEntity/document;document;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/businessEntity/document/identification;identification;Número do documento de identificação oficial do titular pessoa jurídica.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;11111111111111;
 /data/businessEntity/document/rel;rel;Tipo do documento de identificação oficial do titular pessoa jurídica.;Texto;4;Obrigatório;^[A-Z]{4}$;;1;1;"";Não permitido;string;CNPJ;
-/data/debtorAccount;debtorAccount;"Objeto que contém a identificação da conta de origem do pagador.  
-As informações quanto à conta de origem do pagador poderão ser trazidas no vínculo para a detentora, caso a iniciadora tenha coletado essas informações do cliente. Do contrário, será coletada na detentora e trazida para a iniciadora como resposta à criação do vínculo.
-";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/debtorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números.
-";Texto;8;Obrigatório;^[0-9]{8}$;;1;1;"";Não permitido;string;12345678;8
-/data/debtorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito.  
-(Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito,  
-no exercício de atividades da instituição, não podendo ser móvel ou transitória).  
-[Restrição] Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA).
-";Texto;4;Condicional;^[0-9]{1,4}$;;0;1;" Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA).
-";Não permitido;string;1774;1
-/data/debtorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir),  
-se houver valor alfanumérico, este deve ser convertido para 0.
-";Texto;20;Obrigatório;^[0-9]{1,20}$;;1;1;"";Não permitido;string;1234567890;1
-/data/debtorAccount/accountType;accountType;"Tipos de contas usadas para pagamento via Pix.  
-Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas,  
-conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica.  
-Segue descrição de cada valor do ENUM para o escopo do Pix.  
-CACC - Current - Conta Corrente.    
-SVGS - Savings - Conta de Poupança.  
-TRAN - TransactingAccount - Conta de Pagamento pré-paga.
-";Texto;;Obrigatório;;"CACC 
-SVGS 
-TRAN";1;1;"";Não permitido;string;CACC;
+/data/debtorAccount;debtorAccount;;"";;Opcional;;;0;1;"";Não permitido;;;
 /data/cancellation;cancellation;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
 /data/cancellation/cancelledBy;cancelledBy;"Informação relacionada ao usuário pagador que solicitou o cancelamento do vínculo de conta.
 Pode estar ausente em cenários de processos automatizados realizarem o cancelamento do vínculo, por exemplo, por data de expiração.
@@ -72,17 +52,19 @@ Pode estar ausente em cenários de processos automatizados realizarem o cancelam
 /data/cancellation/reason;;Motivo da rejeição do vínculo de conta.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
 /data/cancellation/reason/rejectionReason;rejectionReason;"Indica o motivo do cancelamento do vínculo de conta. Valores possíveis:
 
-• REJEITADO_TEMPO_EXPIRADO_AUTHORISATION: Expiração automática devido a timeout no status ""AWAITING_AUTHORISATION"". O processo de redirecionamento não foi concluído com sucesso a tempo.
+• REJEITADO_TEMPO_EXPIRADO_RISK_SIGNALS: Expiração automática devido a timeout no status ""AWAITING_RISK_SIGNALS"". O envio de sinais de risco não foi concluído.
+
+• REJEITADO_TEMPO_EXPIRADO_ACCOUNT_HOLDER_VALIDATION: Expiração automática devido a timeout no status ""AWAITING_ACCOUNT_HOLDER_VALIDATION"". O processo de redirecionamento não foi concluído com sucesso.
 
-• REJEITADO_TEMPO_EXPIRADO_ENROLLMENT: Expiração automática devido a timeout no status ""AWAITING_ENROLLMENT"". O processo de criação e envio de credenciais FIDO2 não foi condluído com sucesso a tempo.
+• REJEITADO_TEMPO_EXPIRADO_ENROLLMENT: Expiração automática devido a timeout no status ""AWAITING_ENROLLMENT"". O processo de criação e envio de credenciais FIDO2 não foi concluído com sucesso.
 
-• REJEITADO_MAXIMO_CHALLENGES_ATINGIDO: Vínculo de conta rejeitado devido várias tentativas frustradas.
+• REJEITADO_MAXIMO_CHALLENGES_ATINGIDO: Vínculo de conta rejeitado devido várias tentativas vínculo frustradas.
 
-• REJEITADO_MANUALMENTE: Cancelamento manual, explicitamente a mando do usuário.
+• REJEITADO_MANUALMENTE: Cancelamento manual, explicitamente a pedido do usuário.
 
 • REJEITADO_DISPOSITIVO_INCOMPATIVEL: Dispositivo não suporta o protocolo FIDO.
 
-• REJEITADO_FALHA_INFRAESTRUTURA: Falha na infraestrutura na detentora na etapa anterior ao aceite de vínculo.
+• REJEITADO_FALHA_INFRAESTRUTURA: Falha na infraestrutura na detentora.
 
 • REJEITADO_SEGURANCA_INTERNA: Vínculo de conta rejeitado devido à política de segurança de instituição detentora ou iniciadora considerando a análise dos sinais de risco.
 
@@ -92,6 +74,7 @@ Pode estar ausente em cenários de processos automatizados realizarem o cancelam
 
 • REJEITADO_OUTRO: Outros motivos não descritos pelas demais. Indicar, neste caso, o motivo em ""additionalInformation"".
 ";Texto;;Obrigatório;;"REJEITADO_TEMPO_EXPIRADO_AUTHORISATION 
+REJEITADO_TEMPO_EXPIRADO_ACCOUNT_HOLDER_VALIDATION 
 REJEITADO_TEMPO_EXPIRADO_ENROLLMENT 
 REJEITADO_MAXIMO_CHALLENGES_ATINGIDO 
 REJEITADO_MANUALMENTE 
@@ -112,7 +95,13 @@ DETENTORA";1;1;"";Não permitido;string;;
 /data/cancellation/rejectedAt;rejectedAt;Instante de rejeição do vínculo de conta no ambiente da detentora.;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;2023-07-12T08:30:00Z;
 /data/transactionLimit;transactionLimit;"Valor máximo, por transação, admitido para este vínculo de conta. Este limite não garante a autorização de iniciações de pagamento;
 servindo como referência para a iniciadora evitar a criação de consentimentos de valores tais que, garantidamente, não serão autorizados.
-";Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12;4
+
+[Restrição] Campo de preenchimento obrigatório pelos participantes quando o campo `status` for preenchido com os valores `AUTHORISED` ou `AWAITING_ENROLLMENT`.
+";Texto;19;Condicional;^((\d{1,16}\.\d{2}))$;;0;1;" Campo de preenchimento obrigatório pelos participantes quando o campo `status` for preenchido com os valores `AUTHORISED` ou `AWAITING_ENROLLMENT`.
+";Não permitido;string;100000.12;4
 /data/dailyLimit;dailyLimit;"Limite diário cumulativo para este vínculo de conta. Este limite não garante a autorização de iniciações de pagamento;
 servindo como referência para a iniciadora evitar a criação de consentimentos para valores tais que, garantidamente, não serão autorizados.
-";Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12;4
+
+[Restrição] Campo de preenchimento obrigatório pelos participantes quando o campo `status` for preenchido com os valores `AUTHORISED` ou `AWAITING_ENROLLMENT`.
+";Texto;19;Condicional;^((\d{1,16}\.\d{2}))$;;0;1;" Campo de preenchimento obrigatório pelos participantes quando o campo `status` for preenchido com os valores `AUTHORISED` ou `AWAITING_ENROLLMENT`.
+";Não permitido;string;100000.12;4

dictionary/postEnrollments_v1.csv

@@ -4,16 +4,18 @@
 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:
+Considerando a string urn:bancoex:C1DD33123 como exemplo para enrollmentId temos:
 - o namespace(urn)
-- o identificador associado ao namespace da instituição transnmissora (bancoex)
+- o identificador associado ao namespace da instituição detentora de conta (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;O instante em que o vínculo de conta foi criado no ambiente da detentora.;Date Hora;20;Obrigatório;^(\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;2023-07-12T08:30:00Z;
 /data/status;status;"Status do vínculo de conta:
 
-• AWAITING_AUTHORISATION: Vínculo de conta criado e aguando autorização no ambiente da dentora de conta.
+• AWAITING_RISK_SIGNALS: Vínculo de conta criado e aguardando envio dos sinais de risco para a dentora.
+
+• AWAITING_ACCOUNT_HOLDER_VALIDATION: Vínculo de conta aguardando autorização no ambiente da detentora.
 
 • AWAITING_ENROLLMENT: Vínculo de conta autorizado no ambiente da detentora e aguardando o vínculo de credenciais (FIDO2).
 
@@ -22,7 +24,8 @@ Informações mais detalhadas sobre a construção de namespaces devem ser consu
 • REVOKED: Vínculo de conta revogado.
 
 • REJECTED: Vínculo de conta rejeitado.
-";Texto;;Obrigatório;;"AWAITING_AUTHORISATION 
+";Texto;;Obrigatório;;"AWAITING_RISK_SIGNALS 
+AWAITING_ACCOUNT_HOLDER_VALIDATION 
 AWAITING_ENROLLMENT 
 AUTHORISED 
 REVOKED