Cadastrar chave PIX
POST
/api/pix-keys
Autenticação
Bearer pela sua API Key real (vk_live_* produção, vk_test_* sandbox). Crie a chave em https://app.dotfy.com.br/dashboard/chaves-api. Sem o header → 401. Com chave inválida/revogada → 401. Com chave sem o escopo necessário → 403 insufficient_scope.pix-keys:write. Pré-requisito: TOTP/2FA habilitado na conta (a API rejeita com 403 TOTP_REQUIRED se ainda não foi configurado).type: CPF | CNPJ | EMAIL | PHONE | RANDOM. A chave passa por aprovação manual antes de ficar utilizável (status: PENDING → APPROVED).Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/pix-keys' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"type": "CNPJ",
"key": "12345678000190",
"name": "Conta principal"
}'Response Response Example
{
"pixKey": {
"id": "clpix0001",
"type": "CNPJ",
"key": "12345678000190",
"name": "Conta principal",
"isDefault": false,
"isVerified": false,
"status": "PENDING_APPROVAL",
"rejectionReason": null,
"createdAt": "2026-05-07T10:30:00.000Z"
},
"message": "Chave PIX cadastrada e enviada para aprovação. Um administrador irá analisar em breve."
}Modificado em 2026-07-02 06:57:27