1.0.1

bacen · Oct 20, 2020 · 4b8969b · 4b8969b
1 parent a5cce64
commit 4b8969b
Show file tree

Hide file tree

Showing 25 changed files with 238 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 Mudanças relevantes na API do DICT serão documentadas aqui.
 
+## [1.0.1] - 2020-10-20
+### Adicionado
+- campos CorrelationId e ResponseTime em todos Responses
+
+### Alterado
+- Regex para nomes de pessoas físicas passou a permitir apóstrofo (U+0027)
+- Definição de SyncVerifierStart, para refletir como está implementado
+
 ## [1.0.0] - 2020-09-16
 ### Adicionado
 - Seção com recomendações de desempenho

diff --git a/openapi/examples/claims/AcknowledgeClaimResponse.xml b/openapi/examples/claims/AcknowledgeClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <AcknowledgeClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/CancelClaimResponse.xml b/openapi/examples/claims/CancelClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CancelClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/CompleteClaimResponse.xml b/openapi/examples/claims/CompleteClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CompleteClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/ConfirmClaimResponse.xml b/openapi/examples/claims/ConfirmClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ConfirmClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/CreateClaimResponse.xml b/openapi/examples/claims/CreateClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CreateClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/GetClaimResponse.xml b/openapi/examples/claims/GetClaimResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetClaimResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Claim>
         <Type>OWNERSHIP</Type>
         <Key>+5561988887777</Key>

diff --git a/openapi/examples/claims/ListClaimsResponse.xml b/openapi/examples/claims/ListClaimsResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ListClaimsResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <HasMoreElements>true</HasMoreElements>
     <Claims>
         <Claim>

diff --git a/openapi/examples/entries/CreateEntryResponse.xml b/openapi/examples/entries/CreateEntryResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CreateEntryResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Entry>
         <Key>11122233300</Key>
         <KeyType>CPF</KeyType>

diff --git a/openapi/examples/entries/DeleteEntryResponse.xml b/openapi/examples/entries/DeleteEntryResponse.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <DeleteEntryResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Key>+5561988887777</Key>
 </DeleteEntryResponse>
diff --git a/openapi/examples/entries/GetEntryResponse.xml b/openapi/examples/entries/GetEntryResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetEntryResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Entry>
         <Key>11122233300</Key>
         <KeyType>CPF</KeyType>

diff --git a/openapi/examples/entries/UpdateEntryResponse.xml b/openapi/examples/entries/UpdateEntryResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <UpdateEntryResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Entry>
         <Key>11122233300</Key>
         <KeyType>CPF</KeyType>

diff --git a/openapi/examples/infractions/AcknowledgeInfractionReportResponse.xml b/openapi/examples/infractions/AcknowledgeInfractionReportResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <AcknowledgeInfractionReportResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <InfractionReport>
         <TransactionId>E9999901012341234123412345678900</TransactionId>
         <InfractionType>FRAUD</InfractionType>

diff --git a/openapi/examples/infractions/CancelInfractionReportResponse.xml b/openapi/examples/infractions/CancelInfractionReportResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CancelInfractionReportResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <InfractionReport>
         <TransactionId>E9999901012341234123412345678900</TransactionId>
         <InfractionType>FRAUD</InfractionType>

diff --git a/openapi/examples/infractions/CloseInfractionReportResponse.xml b/openapi/examples/infractions/CloseInfractionReportResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CloseInfractionReportResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <InfractionReport>
         <TransactionId>E9999901012341234123412345678900</TransactionId>
         <InfractionType>FRAUD</InfractionType>

diff --git a/openapi/examples/infractions/CreateInfractionReportResponse.xml b/openapi/examples/infractions/CreateInfractionReportResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CreateInfractionReportResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <InfractionReport>
         <TransactionId>E9999901012341234123412345678900</TransactionId>
         <InfractionType>FRAUD</InfractionType>

diff --git a/openapi/examples/infractions/GetInfractionReportResponse.xml b/openapi/examples/infractions/GetInfractionReportResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetInfractionReportResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <InfractionReport>
         <TransactionId>E9999901012341234123412345678900</TransactionId>
         <InfractionType>FRAUD</InfractionType>

diff --git a/openapi/examples/infractions/ListInfractionReportsResponse.xml b/openapi/examples/infractions/ListInfractionReportsResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ListInfractionReportsResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <HasMoreElements>true</HasMoreElements>
     <InfractionReports>
         <InfractionReport>

diff --git a/openapi/examples/reconciliation/CreateCidSetFileResponse.xml b/openapi/examples/reconciliation/CreateCidSetFileResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CreateCidSetFileResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <CidSetFile>
         <Id>1234</Id>
         <Status>REQUESTED</Status>

diff --git a/openapi/examples/reconciliation/CreateSyncVerificationResponse.xml b/openapi/examples/reconciliation/CreateSyncVerificationResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <CreateSyncVerificationResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <SyncVerification>
         <Participant>12345678</Participant>
         <KeyType>CPF</KeyType>

diff --git a/openapi/examples/reconciliation/GetCidSetFileResponse.xml b/openapi/examples/reconciliation/GetCidSetFileResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetCidSetFileResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <CidSetFile>
         <Id>1234</Id>
         <Status>AVAILABLE</Status>

diff --git a/openapi/examples/reconciliation/GetEntryByCidResponse.xml b/openapi/examples/reconciliation/GetEntryByCidResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <GetEntryByCidResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <Cid>ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb</Cid>
     <Entry>
         <Key>11122233300</Key>

diff --git a/openapi/examples/reconciliation/ListCidSetEventsResponse.xml b/openapi/examples/reconciliation/ListCidSetEventsResponse.xml
@@ -1,6 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <ListCidSetEventsResponse>
     <Signature></Signature>
+    <ResponseTime>2020-01-10T10:00:00Z</ResponseTime>
+    <CorrelationId>a9f13566e19f5ca51329479a5bae60c5</CorrelationId>
     <HasMoreElements>true</HasMoreElements>
     <Participant>12345678</Participant>
     <KeyType>CPF</KeyType>

diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: DICT API
-  version: '1.0.0'
+  version: '1.0.1'
   license:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0
@@ -10,21 +10,21 @@ info:
     email: [email protected]
     url: https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos
   description: |- 
-    O Diretório de Identificadores de Contas Transacionais - DICT - é o serviço do arranjo Pix que permite 
-    buscar detalhes de contas transacionais com chaves de endereçamento mais convenientes para quem faz 
+    O Diretório de Identificadores de Contas Transacionais - DICT - é o serviço do arranjo Pix que permite
+    buscar detalhes de contas transacionais com chaves de endereçamento mais convenientes para quem faz
     um pagamento. Entre os tipos de chave atualmente disponíveis estão CPF, CNPJ, telefone, e-mail e EVP.
     As informações retornadas pelo DICT permitem ao pagador confirmar a identidade do recebedor, proporcionando 
     uma experiência mais fácil e segura. Permitem também ao PSP do pagador criar a mensagem de instrução de 
     pagamento a ser enviada para o sistema de liquidação com os detalhes de conta do recebedor.
 
     Para informações adicionais, consulte a [página do Pix](https://www.bcb.gov.br/estabilidadefinanceira/pagamentosinstantaneos).
-  
+
     # Segurança
     ## Autenticação 
     O DICT utiliza autenticação mútua TLS.
 
-    As definições de autenticação para essa API estão especificadas no 
-    [manual de segurança do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/cedsfn/Manual%20de%20Seguranca%20do%20PIX%20v3.0.pdf).
+    As definições de autenticação para essa API estão especificadas no
+    [manual de segurança do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/cedsfn/Manual%20de%20Seguranca%20do%20PIX%20v3.1.pdf).
    
     ## Assinatura digital
     Requisições que incluam ou alterem informações no DICT devem ser assinadas com 
@@ -37,7 +37,7 @@ info:
     sendo assinado (assinatura é um elemento filho).
 
     Para mais detalhes sobre a forma de construir a assinatura, consulte o
-    [manual de segurança do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/cedsfn/Manual%20de%20Seguranca%20do%20PIX%20v3.0.pdf).
+    [manual de segurança do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/cedsfn/Manual%20de%20Seguranca%20do%20PIX%20v3.1.pdf).
 
     ## Limitação de requisições
     
@@ -53,15 +53,15 @@ info:
 
     # Recomendações de desempenho
 
-    É altamente recomendável que as conexões HTTP para a comunicação com a API sejam reutilizadas, pois o custo de 
+    É altamente recomendável que as conexões HTTP para a comunicação com a API sejam reutilizadas, pois o custo de
     estabelecimento de uma conexão mTLS é muito alto em termos de latência. O uso de um _pool_ de conexões HTTP
     é uma alternativa efetiva para reutilização de conexões. A API retorna o header [`Keep-Alive`](https://tools.ietf.org/html/rfc2068#section-19.7.1.1)
     com o parâmetro `timeout`. Nele é informado o tempo em segundos que o servidor esperará antes de fechar a conexão caso não ocorram
     requisições adicionais.
 
-    É recomendável também que se utilize compressão. Para que as respostas da API utilizem compressão, adicione nas 
+    É recomendável também que se utilize compressão. Para que as respostas da API utilizem compressão, adicione nas
     requisições o header `Accept-Encoding: gzip`. O envio de requisições com compressão não é suportado.
-   
+
     # Evolução da API
 
     As seguintes mudanças são esperadas e consideradas retro-compatíveis (_backwards-compatibility_):
@@ -379,7 +379,7 @@ tags:
       Cada participante deve realizar _polling_ periódico na lista de relatos para verificar se
       existem novos relatos em que é parte. O recebimento do relato não implica em concordância.
       Os níveis de serviço exigidos para as operações com relatos de infração estão definidos no
-      [Manual de Tempos do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/IX.ManualdeTemposdoPix-versao1.1.pdf). 
+      [Manual de Tempos do Pix](https://www.bcb.gov.br/content/estabilidadefinanceira/pix/Regulamento_Pix/IX.ManualdeTemposdoPix-versao1.1.pdf).
 
       As relatos por motivo de fraude e PLD/FT são contabilizadas e retornadas ao
       [consultar vínculo](#operation/getEntry). Se for cancelado, o relato deixa de ser contabilizado
@@ -474,8 +474,11 @@ paths:
         Arrendonda-se o número para cima, por exemplo: 3 → 5, 190 → 500 .
 
         ### Limitação de requisições
-        A política de limitação (_rate-limiting_) funciona com base em cabeçalhos enviados na requisição.
-
+        A consulta a chaves do tipo EMAIL e PHONE está sujeita à política de limitação (_rate-limiting_) de requisições.
+        A limitação funciona com base em cabeçalhos enviados na requisição. Os cabeçalhos de requisição são obrigatórios 
+        para todos os tipos de chaves. Na resposta, para consultas sujeitas à política de limitação, são enviados 
+        cabeçalhos que informam detalhes sobre o estado dos _buckets_ associados ao participante e ao usuário final.
+        
         O parâmetro `PI-PayerId` é o identificador pseudonimizado do usuário final, vinculado a um participante. 
         Requisições vindas de um mesmo usuário, para um mesmo participante, devem usar o mesmo identificador. 
         Como sugestão de implementação, pode ser utilizado o valor hexadecimal da aplicação de 
@@ -958,8 +961,8 @@ paths:
       description: |- 
         Cancela reivindicação. 
                 
-        Para reivindicação de posse, status deve ser `WAITING_RESOLUTION` ou `CONFIRMED`. Se razão 
-        de cancelamento for `DEFAULT_OPERATION`, prazo de validação de posse da chave do usuário 
+        Para reivindicação de posse, status deve ser `WAITING_RESOLUTION` ou `CONFIRMED`. Se razão
+        de cancelamento for `DEFAULT_OPERATION`, prazo de validação de posse da chave do usuário
         reivindicador deve ter passado.
 
         Para portabilidade, status deve ser `WAITING_RESOLUTION`. Se razão de cancelamento for