---
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
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 consulta a chaves 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.

O parâmetro `PI-PayerId` é o identificador único 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.
A partir da versão `1.5.0` da API DICT, este parâmetro deverá ser preenchido com o CPF do usuário final
(11 dígitos), no caso de pessoa física, ou com o CNPJ (14 dígitos), no caso de pessoa jurídica.
O valor **não deve ser pseudonimizado**, pois a informação passará a ser considerada no rastreamento
de possíveis violações de limites.

### 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

---

[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/509ab4f55204/schema)