Skip to main content
GET
Search canonical entities

Query Parameters

name
string | null

Name fragment. Must contain at least 3 useful characters.

Example:

"Maria Silva"

document
string | null

CPF or CNPJ search value. Partial values require name.

Example:

"12345678901"

entity_type
enum<string> | null

Optional entity type filter.

Available options:
person,
organization,
government_agency,
financial_institution,
political_party,
foreign_entity,
vessel,
aircraft
limit
integer
default:20

Maximum page size.

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based page offset.

Required range: x >= 0
bypass_entity_cache
boolean
default:false

Testing: ignores the cached entity_id and forces lake resolution, reusing the cached PH3A payload (no new API call, no credit spend). Use to measure lake resolution latency repeatably.

Response

Successful Response

items
EntityListItem · object[]
required

Entities in the current page.

limit
integer
required

Requested page size.

Example:

20

offset
integer
required

Requested zero-based offset.

Example:

0

total
integer
required

Total number of matching entities.

Example:

1