API Reference

DICT - Keys Management

DICT – Diretório de Identificadores de Contas Transacionais – Componente do PIX que armazena as informações dos usuários recebedores e suas respectivas contas transacionais. Essas informações podem ser localizadas através das chaves de endereçamento. Em resumo, o DICT funciona como um catálogo de chaves Pix, onde cada chave registrada é vinculada a um número de telefone (PHONE), CPF ou CNPJ (DOCUMENT), e-mail (EMAIL) ou chave aleatória (EVP).

Segue abaixo alguns exemplos:

TipoEnum utilizado nas APIsExemplo
Chave aleatóriaEVPaba79f2d-2de2-42de-b126-4a478885315e
CPFDOCUMENT45118133025
CNPJDOCUMENT67831274000101
TelefonePHONE+5579999999999
E-mailEMAIL[email protected]

Se a chave de endereçamento já estiver registrada no DICT, um erro será retornado. O cliente poderá então fazer uma solicitação de Reivindicação de Chave. Se a chave já existente estiver vinculada ao mesmo CPF/CNPJ, tratar-se-á de uma Reivindicação do tipo Portabilidade, caso contrário, será classificada como uma Reivindicação de Posse.