Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
DICT proxy claims

List DICT proxy claims

Returns proxy claims for the authenticated legal entity, with cursor pagination (limit, starting_after) and optional filters (status, connected_account_id, type, role, proxy_type_code, proxy_identification, internal_account_id, proxy_key_id). Records are ordered by created_at descending, then id descending. To page forward, pass the last record's id as starting_after on the next request.

get/proxy_services/dict/proxy_claims

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_creation' | 'open' | 'creation_rejected'

Filter by claim status.

connected_account_idstring uuid

Filter by connected account ID.

type'ownership' | 'portability'

Filter by claim type.

role'claimer' | 'donor'

Filter by the legal entity's role in the claim. Today all rows have role=claimer; donor-side rows ship with the discovery flow.

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

Filter by scheme-specific proxy type code.

proxy_identificationstring

Exact-match filter on the proxy identification.

internal_account_idstring uuid

Filter by internal account linkage.

proxy_key_idstring uuid

Filter by the bound local proxy key. Claimer-side rows have a null binding and are not returned by this filter today.

Response

List of filtered proxy claims.

Example response

{
  "records": [
    {
      "id": "e5f6a7b8-c9d0-1234-efff-123456789012",
      "object": "proxy_claim",
      "scheme": "dict",
      "type": "portability",
      "role": "claimer",
      "status": "open",
      "proxy_type": "tax_id",
      "proxy_type_code": "cpf",
      "proxy_identification": "12345678901",
      "claimer_name": "Maria Silva",
      "claimer_account_identification": "0001234-5",
      "claimer_account_type": "CACC",
      "claimer_account_issuer": "12345678",
      "claimer_servicer": "12345678",
      "connected_account_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "resolution_period_end": "2026-01-08T12:00:00Z",
      "completion_period_end": "2026-01-15T12:00:00Z",
      "scheme_data": {
        "claim_id": "claim-bacen-uuid-001",
        "claimer_tax_identification_number": "12345678901",
        "claimer_owner_type": "individual",
        "claimer_opening_date": "2020-01-01T00:00:00Z"
      },
      "metadata": {},
      "created_at": "2026-01-01T12:00:00Z"
    }
  ]
}