---
title: "Cria um novo vínculo de chave com uma conta transacional."
method: POST
path: "/pix/indireto/dict/vinculo"
tags: ["Diretorio"]
---

# Cria um novo vínculo de chave com uma conta transacional.

`POST /pix/indireto/dict/vinculo`

## Request

- Base URL: `https://example.com`
- URL: `https://example.com/pix/indireto/dict/vinculo`
- Auth: none required

<br>
  <b>Idempotência</b>

<br>A operação de criação de vínculo é idempotente. Isso significa que é seguro realizar uma nova tentativa 
            em caso de falhas temporárias, como erros de conexão ou término abrupto de processos. A resposta retornada 
            para uma requisição repetida é equivalente à resposta dada à primeira requisição processada.
<br>Para garantir a idempotência da operação, a requisição tem um campo `RequestId`. Esse campo é um 
            `UUID` versão 4 e deve ser único no contexto de um mesmo participante. O RequestId fica associado ao 
            vínculo criado e é usado no cálculo do seu CID (ver seção de reconciliação na documentação).
<br>Uma requisição de criação é considerada repetida quando o CID do vínculo contido na requisição já existe no DICT. 
            Caso seja feita uma requisição com um `RequestId` previamente usado, mas com parâmetros diferentes para o vínculo, 
            será retornado o erro `RequestIdAlreadyUsed`.

## Headers

- `api-version` string, required
- `Authorization` string, required

## Request body

- Bs2Core2PixIndiretoDictAppApisDictDiretorioCriarVinculoCriarVinculo: Representa o corpo de uma requisição para criação de um novo vínculo de chave com conta transacional.
  - `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.
  - `razao` 'SolicitacaoUsuario' | 'FechamentoConta' | 'TransferenciaAgencia' | 'Reconciliacao' | 'Fraude': Representa o tipo definindo os motivos de criação, atualização, remoção, reivindicação de posse ou reivindicação de portabilidade de vínculos de chaves de endereçamento do Pix no DICT.
  - `requestId` string, uuid, nullable: Retorna ou define a chave de idempotência da requisição de criação de vínculo da chave de endereçamento do Pix no DICT, representado por um `UUID` versão 4.

## Response `201`

Quando o vínculo da chave foi criado com sucesso.

- Bs2Core2PixIndiretoDictAppApisDictDiretorioCriarVinculoVinculoCriado: Representa as informações do vínculo criado no DICT.
  - `correlationId` string, nullable: Retorna ou define o identificador de correlação para o suporte operacional do DICT.
  - `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.
  - `dataCriacao` string, date-time: Retorna ou define a data de criação do vínculo.
  - `dataPosse` string, date-time: 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.

## Other responses

- `400`: Quando o corpo da requisição de criação de vínculo é inválido.
- `403`: Quando houver erros e/ou violações de acesso na requisição de criação do vínculo.
- `404`: Quando `apikey` é inválido.
- `503`: Quando o a API do DICT não respondeu em tempo hábil e retorna o número de segundos necessário para a próxima tentativa de requisição.

---

[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)