Criar chave Pix da conta.

POST

/accounts/keys

Chaves Pix

Cria uma chave Pix no DICT para a conta autenticada.

Tipos sem OTP

EVP: não envie key (a chave aleatória é gerada pelo DICT).

CPF / CNPJ: envie key igual ao documento da conta.

Tipos com OTP (EMAIL / PHONE) — fluxo obrigatório

Chame POST /accounts/keys/challenge com o mesmo keyType e key.

Guarde o validationHash da resposta e peça ao usuário o código OTP recebido.

Chame este endpoint com keyType, key, validationHash e validationCode.

Sem validationHash + validationCode, a criação de EMAIL/PHONE é rejeitada.
Se o código expirar (5 minutos), solicite um novo challenge.

Requisição

Authorization

OAuth 2.0

Client Credentials

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Token URL: /oauth/token

Scopes:

pix.write-Permite criar pagamentos Pix e gerenciar chaves Pix da conta

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Chave criada

Bodyapplication/json

🟠400

🟠401

🟠403

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

cURL

Chave aleatória (EVP)CPF da contaE-mail com OTP

curl --location '/accounts/keys' \
--header 'x-account-id;' \
--header 'Content-Type: application/json' \
--data '{
    "keyType": "EVP"
}'

Response Example

200 - Sucesso

{
    "key": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
    "keyType": "EVP",
    "branch": "0001",
    "accountNumber": "123456",
    "accountType": "CACC",
    "name": "Cliente Exemplo",
    "taxIdNumber": "12345678901",
    "creationDate": "2024-01-01T12:00:00.000Z"
}

Página anterior

Listar chaves Pix da conta.

Próxima página

Solicitar OTP para criar chave EMAIL ou PHONE.