--- title: "Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento." method: GET path: "/pix/indireto/dict/vinculo/{chave}" tags: ["Diretorio"] --- # Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento. `GET /pix/indireto/dict/vinculo/{chave}` ## Request - Base URL: `https://example.com` - URL: `https://example.com/pix/indireto/dict/vinculo/{chave}` - Auth: none required 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 `Documento` é o identificador do usuário final e é usado para aplicar as políticas de limitação com escopo de usuário. Deve ser preenchido com o CPF ou CNPJ (apenas dígitos), a depender do tipo da entidade titular da conta pagadora.
Estatísticas Através do parâmetro opcional `IncluirEstatisticas`, é possível indicar se as informações de contadores antifraude devem ou não ser incluídas na resposta. ## Path parameters - `chave` string, required ## Query parameters - `incluirEstatisticas` boolean ## Headers - `documento` string, required - `endToEndId` string - `api-version` string, required - `Authorization` string, required ## Response `200` Quando a consulta do vínculo for executada com sucesso. - Bs2Core2PixIndiretoDictAppApisDictDiretorioConsultarVinculoVinculoConsultado: Representa as informações resultantes da consulta de um vínculo no DICT. - `correlationId` string, nullable: Retorna ou define o identificador de correlação para o suporte operacional do DICT. - `dataCriacao` string, date-time, nullable: Retorna ou define a data de criação do vínculo. - `dataPosse` string, date-time, nullable: Retorna ou define a data a partir da qual o dono tem posse ininterrupta da chave de endereçamento. A posse da chave aqui é definida pela existência de um vínculo associando a chave ao dono, possivelmente com contas distintas. - `dataAberturaReivindicacao` string, date-time, nullable: Retorna ou define a data da abertura do processo de reivindicação de posse ou portabilidade, caso a chave esteja possua um destes processos abertos no momento. - `vinculo` Bs2Core2PixIndiretoDictAppApisCompartilhadosVinculoChavePix: Representa um vínculo entre uma chave de endereçamento do Pix no DICT, uma conta transacional e seu dono. - `chavePix` Bs2Core2PixIndiretoDictAppApisCompartilhadosChavePix: Representa uma chave de endereçamento Pix de um participante direto ou indireto no DICT. - `tipo` 'CPF' | 'CNPJ' | 'Telefone' | 'Email' | 'Aleatoria': Representa o tipo da chave Pix. - `chave` string, nullable: Retorna ou define a chave de endereçamento do participante. - `contaTransacional` Bs2Core2PixIndiretoDictAppApisCompartilhadosContaTransacionalPix: Representa uma conta transacional do Pix no DICT. - `ispb` string, nullable: Retorna ou define o número do Identificador de Sistema de Pagamentos Brasileiro do participante responsável da requisição. - `agencia` string, nullable: Retorna ou define o número da Agência, sem o dígito verificador - `numeroConta` string, nullable: Retorna ou define o número da Conta, incluindo o dígito verificador. Se o dígito verificador for uma letra, deve substituir por 0. - `tipo` 'Corrente' | 'Salario' | 'Poupanca' | 'Pagamento': Representa o tipo de conta de débito ou crédito do Pix segundo as especificações da ISO 20022. - `dataAbertura` string, date-time, nullable: Retorna ou define a data de abertura da conta. Para o horário, caso não seja conhecido, convenciona-se o início do dia em BRT (00:00:00). - `proprietario` Bs2Core2PixIndiretoDictAppApisCompartilhadosProprietario: Representa uma pessoa física ou pessoa jurídica, participante de uma conta transacional de Pix no DICT. - `tipo` 'PessoaFisica' | 'PessoaJuridica': Representa o tipo do dono da solicitação ou da chave de endereçamento Pix no DICT. - `nome` string, nullable: Retorna ou define o nome da pessoa física participante da contra transacional. - `documento` string, nullable: Retorna ou define o número do CPF da pessoa física participante do Pix ou o número do CNPJ da pessoa jurídica participante do Pix. - `nomeFantasia` string, nullable: Retorna ou define o nome fantasia da pessoa jurídica participante do Pix. - `estatisticasChave` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2EstatisticasChave: Estatísticas associadas à chave, como entidade independente de seu registro atual no DICT. - `transacoesLiquidadasSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TransacaoLiquidadaSpi - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `liquidacoesSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2LiquidacoesSpi - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `marcacoesFraude` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2MarcacoesFraude - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `falsidadeIdeologica` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesFalsidadeIdeologica - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `contaLaranja` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesContaLaranja - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `contaFraudador` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesContaFraudador - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `outros` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesOutros - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `desconhecidas` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesDesconhecidas - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `totalLiquidadasSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TotalFraudesLiquidadasSpi - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `totalPorParticipante` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TotalFraudesParticipantes - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `notificacoesInfracaoRegistradas` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2NotificacaoInfracaoChaveRegistrada - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `quantidadeEmAberto` integer, nullable: Número de notificações de infração ainda não concluídas nem canceladas. - `quantidadePorParticipante` integer, nullable: Número de participantes distintos criadores de notificações de infração ainda não concluídas nem canceladas. - `rejeitadas` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2NotificacoesInfracaoRejeitadas - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `contasPessoa` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2ContasPessoa - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `contasAssociadas` integer, nullable: Número de contas da pessoa associadas a chaves atualmente registradas. - `estatisticasPessoa` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2EstatisticasPessoa: Estatísticas associadas a pessoa física ou pessoa jurídica. - `transacoesLiquidadasSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TransacaoLiquidadaSpi - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `liquidacoesSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2LiquidacoesSpi - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `marcacoesFraude` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2MarcacoesFraude - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `falsidadeIdeologica` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesFalsidadeIdeologica - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `contaLaranja` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesContaLaranja - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `contaFraudador` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesContaFraudador - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `outros` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesOutros - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `desconhecidas` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2FraudesDesconhecidas - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `totalLiquidadasSpi` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TotalFraudesLiquidadasSpi - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `totalPorParticipante` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2TotalFraudesParticipantes - `d90` integer, nullable: Valor para os últimos 90 dias - `m12` integer, nullable: Valor para os últimos 12 meses - `m60` integer, nullable: Valor para os últimos 60 meses - `notificacoesInfracaoRegistradas` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2NotificacaoInfracaoRegistrada - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `quantidadeEmAberto` integer, nullable: Número de notificações de infração ainda não concluídas nem canceladas. - `quantidadePorParticipante` integer, nullable: Número de participantes distintos criadores de notificações de infração ainda não concluídas nem canceladas. - `contasPessoa` Bs2Core2PixIndiretoDictAppApisCompartilhadosV2ContasPessoa - `dataHoraUltimoEvento` string, date-time, nullable: DataHora do último evento considerado - `contasAssociadas` integer, nullable: Número de contas da pessoa associadas a chaves atualmente registradas. ## Other responses - `404`: Quando a consulta do vínculo não encontrar as informações do vínculo solicitado. - `429`: Quando o número máximo de consultas de vínculos for atingido. --- [API](https://skmtc.dev/bs2/apis/api-dict.md) - [All operations](https://skmtc.dev/bs2/apis/api-dict/llms.txt) - [OpenAPI document](https://skmtc.dev/bs2/apis/api-dict/revisions/6f6959388685?raw)