---
title: "Consultar Vínculo"
method: GET
path: "/entries/{Key}"
tags: ["Directory"]
---

# Consultar Vínculo

`GET /entries/{Key}`

Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento.

### Dados anti-fraude
A fim de permitir avaliação de risco de fraude, na consulta de vínculos são fornecidos contadores
dos seguintes eventos:

1. transações realizadas
2. relatos de infrações (Fraude e PLD/FT)
3. relatos de infrações com análise e concordância do creditado

Os eventos são agregados por chave, titular (cpf ou cnpj) e conta transacional em 3 janelas temporais:

- últimos 3 dias (d3)
- últimos 30 dias (d30) 
- últimos 6 meses, sem contar o mês corrente (m6)

Esses contadores tem ciclo de vida independente do vínculo. Eles não são zerados, mesmo que haja 
desativação da chave ou da conta. Se houver troca de titularidade, ou portabilidade, os dados 
são herdados pelo novo registro no que couber (titular, chave, ou conta).

Os contadores de transações realizadas são quantizados. A escala usada é 0, 1, 5, 10, 50, 100, 500, 1000, 5000 ...
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.

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 
[HMAC-SHA-256](https://tools.ietf.org/html/rfc4634#section-7) a um identificador do usuário, 
com chave de conhecimento restrito ao participante.

### Cache
Consultas a vínculos podem ter suas respostas _cacheadas_ no PSP, devendo seguir as 
diretivas contidas no header [`Cache-Control`](https://tools.ietf.org/html/rfc7234#section-5.2).

_Importante_: Para fazer uso de cache, clientes HTTP geralmente precisam ser configurados. Não
é comum que tenham essa funcionalidade habilitada por padrão.

## Headers

- `PI-RequestingParticipant` string, required
- `PI-PayerId` string, required
- `PI-EndToEndId` string, required

## Response `200`

OK

## Other responses

- `404` — unresolved $ref
- `429` — unresolved $ref

## Changes

- **2020-08-24** `e7d43b7c35fd` — 1 warning
  - changed the pattern of the `header` request parameter `PI-PayerId` from `[0-9a-f]{64}` to `[0-9a-fA-F]{64}`
- **2020-07-22** `b5bc698deec9` — 1 breaking, 2 warning
  - added the new required `header` request parameter `PI-RequestingParticipant`
  - changed the pattern of the `header` request parameter `PI-PayerId` from `[0-9a-z]{64}` to `[0-9a-f]{64}`
  - deleted the `header` request parameter `PI-PayerAccountServicer`

[Change history](https://skmtc.dev/bacen/apis/dict-api/changes/entries/:Key/get.md)

---

[API](https://skmtc.dev/bacen/apis/dict-api.md) · [All operations](https://skmtc.dev/bacen/apis/dict-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bacen/dict-api/revisions/e7d43b7c35fd/schema)