Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
DICT proxy lookup

List DICT proxy lookups

List and filter past DICT proxy lookups.

get/proxy_services/dict/proxy_lookups

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'created' | 'processing' | 'sent' | 'completed' | 'rejected'

Filter by lookup 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.

Response

List of filtered proxy lookups

Example response

{
  "records": [
    {
      "id": "d4e5f6a7-b8c9-0123-deff-012345678901",
      "object": "proxy_lookup",
      "scheme": "dict",
      "status": "sent",
      "proxy_type": "tax_id",
      "proxy_type_code": "cpf",
      "proxy_identification": "12345678901",
      "owner_name": "Maria Silva",
      "owner_type": "individual",
      "account_identification": "0001234-5",
      "account_type": "CACC",
      "account_issuer": "12345678",
      "servicer": "12345678",
      "connected_account_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "scheme_data": {
        "pi_payer_id": "12345678901",
        "pi_end_to_end_id": "E1234567820250101120000000000001",
        "pi_requesting_participant": "12345678",
        "owner_statistics": {},
        "key_statistics": {}
      },
      "created_at": "2025-01-01T12:00:00Z",
      "updated_at": "2025-01-01T12:00:01Z"
    }
  ]
}