Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
DICT proxy keys

List DICT proxy keys

List and filter DICT proxy keys.

get/proxy_services/dict/proxy_keys

Query parameters

limitinteger

Maximum number of records to return (1–100). Defaults to 25.

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

status'pending_registration' | 'registration_failed' | 'active' | 'disabled'

Filter by proxy key status.

connected_account_idstring uuid

Filter by connected account ID.

proxy_type'phone' | 'email' | 'tax_id' | 'organisation' | 'random_alias'

Filter by proxy type.

proxy_type_code'cpf' | 'cnpj' | 'abn' | 'teli' | 'emal' | 'aubn' | 'orgn' | 'evp'

Filter by scheme-specific proxy type code.

proxy_identificationstring

Filter by proxy identification value.

owner_namestring

Filter by owner name (maximum 140 characters).

internal_account_idstring uuid

Filter by internal account ID.

Response

List of filtered proxy keys

Example response

{
  "records": [
    {
      "id": "c39d1eff-c5ed-4197-8f24-28a68bd0eee6",
      "object": "proxy_key",
      "scheme": "dict",
      "owner_type": "individual",
      "owner_name": "Maria Silva",
      "proxy_type": "tax_id",
      "proxy_type_code": "cpf",
      "proxy_identification": "12345678901",
      "status": "active",
      "account_identification": "0001234-5",
      "account_type": "CACC",
      "account_issuer": "12345678",
      "connected_account_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "servicer": "12345678",
      "scheme_data": {
        "reason": "USER_REQUESTED",
        "tax_identification_number": "12345678901",
        "directory_entry_id": "dict-entry-abc123"
      },
      "metadata": {
        "customer_ref": "cust-001"
      },
      "created_at": "2025-01-01T12:00:00Z"
    }
  ]
}