PIX Keys Management

PIX keys are registered directly with BACEN’s DICT (Diretório de Identificadores de Contas Transacionais). The BRZ API simplifies this process by auto-filling account data from your onboarding.

Key Types

Register a PIX Key

Only key_type is required. Account data is auto-filled from your approved onboarding:

$
curl -X POST https://api.brzip.com.br/api/v1/pix/keys \
>
  -H "Authorization: Bearer <your-jwt>" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "key_type": "EVP"
>
  }'

Response (201 Created):

1
{
2
  "key_type": "EVP",
3
  "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4
  "account": {
5
    "participant": "12345678",
6
    "branch": "0001",
7
    "account_number": "12345678",
8
    "account_type": "CACC",
9
    "opening_date": "2026-02-23"
10
  },
11
  "owner": {
12
    "type": "NATURAL_PERSON",
13
    "tax_id_number": "22768368067",
14
    "name": "Ana Paula Oliveira"
15
  },
16
  "created_at": "2026-02-23T21:10:00.000Z",
17
  "status": "REGISTERED"
18
}

Optional Override Fields

If you need to override the auto-filled onboarding data, you can include any of these fields:

• account_type, account_number, branch_number
• person_type, tax_id, name, trade_name
• account_open_date

List PIX Keys

List all PIX keys registered for your account:

$
curl -X GET https://api.brzip.com.br/api/v1/pix/keys \
>
  -H "Authorization: Bearer <your-jwt>"

Search a PIX Key

Search for a specific PIX key by its value:

$
curl -X GET https://api.brzip.com.br/api/v1/pix/keys/12345678901 \
>
  -H "Authorization: Bearer <your-jwt>"

Delete a PIX Key

Delete a registered PIX key:

$
curl -X DELETE https://api.brzip.com.br/api/v1/pix/keys/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
>
  -H "Authorization: Bearer <your-jwt>" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "reason": "USER_REQUESTED"
>
  }'

Deletion Reasons