---
title: "List DICT proxy keys"
method: GET
path: "/proxy_services/dict/proxy_keys"
tags: ["DICT proxy keys"]
---

# List DICT proxy keys

`GET /proxy_services/dict/proxy_keys`

List and filter DICT proxy keys.

## Query parameters

- `limit` integer
- `starting_after` string, uuid
- `status` 'pending_registration' | 'registration_failed' | 'active' | 'disabled'
- `connected_account_id` string, uuid
- `proxy_type` 'phone' | 'email' | 'tax_id' | 'organisation' | 'random_alias'
- `proxy_type_code` 'cpf' | 'cnpj' | 'abn' | 'teli' | 'emal' | 'aubn' | 'orgn' | 'evp'
- `proxy_identification` string
- `owner_name` string
- `internal_account_id` string, uuid

## Response `200`

List of filtered proxy keys

- DictProxyKeyListResult — Paginated list of DICT proxy keys.
  - `records` DictProxyKey[], required — List of proxy keys matching the query.
    - `id` string, uuid, required — Unique identifier of the proxy key.
    - `object` 'proxy_key', required — Object type label.
    - `scheme` string, required — The directory scheme this proxy key is registered in.
    - `owner_type` 'individual' | 'legal_entity', required — Whether the owner is an individual or a legal entity.
    - `owner_name` string, required — Full name of the proxy key owner.
    - `proxy_type` 'phone' | 'email' | 'tax_id' | 'organisation' | 'random_alias', required — The category of proxy identifier.
    - `proxy_type_code` 'cpf' | 'cnpj' | 'abn' | 'teli' | 'emal' | 'aubn' | 'orgn' | 'evp' | 'null', nullable, required — The scheme-specific sub-type code for the proxy.
    - `proxy_identification` string, required — The proxy identifier value.
    - `status` 'pending_registration' | 'registration_failed' | 'active' | 'disabled', required — Current status of the proxy key. A newly created key is `pending_registration` until the scheme accepts the registration, at which point it becomes `active`. If the scheme refuses the registration the key becomes `registration_failed`.
    - `status_details` string, nullable, required — Additional information about the current status.
    - `status_reason` 'released_via_claim' | 'null', nullable, required — Machine-readable reason the key reached its current status. `released_via_claim` when disabled by a confirmed donor-side claim.
    - `account_identification` string, required — Account number associated with this proxy key.
    - `account_type` 'CACC' | 'SVGS' | 'SLRY' | 'TRAN' | 'null', nullable, required — ISO 20022 account type code.
    - `account_issuer` string, nullable, required — Identifier of the institution that issued the account.
    - `connected_account_id` string, uuid, required — ID of the Mambu Payments connected account this proxy key is registered against.
    - `internal_account_id` string, uuid, nullable, required — ID of the Mambu Payments internal account linked to this proxy key, if any.
    - `servicer` string, required — Identifier of the financial institution servicing the account.
    - `scheme_data` DictProxyKeySchemeData, required — DICT-specific output fields on a proxy key.
      - `reason` string, required — Reason for which the proxy key was registered.
      - `tax_identification_number` string, required — Tax identification number of the proxy key owner.
      - `directory_entry_id` string, required — BACEN directory entry ID returned by the provider when the key was registered.
    - `metadata` object, required — Customer-defined key/value pairs.
    - `created_at` string, date-time, required — UTC timestamp when the proxy key was created.
    - `disabled_at` string, date-time, nullable, required — UTC timestamp when the proxy key was disabled, if applicable.
    - `enabled_at` string, date-time, nullable, required — UTC timestamp when the proxy key was last enabled, if applicable.

## Other responses

- `400` — Validation error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)