Skip to main content
GET
Buscar entidades canônicas

Query Parameters

name
string | null

Fragmento de nome. Deve conter ao menos 3 caracteres úteis.

Example:

"Maria Silva"

document
string | null

CPF válido ou CNPJ numérico/alfanumérico. Valores parciais exigem name.

Example:

"12345678901"

entity_type
enum<string> | null

Filtro opcional de tipo de entidade.

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

Tamanho máximo da página.

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

Deslocamento da página, a partir de zero.

Required range: x >= 0

Response

Successful Response

items
EntityListItem · object[]
required

Entidades na página atual.

limit
integer
required

Tamanho de página solicitado.

Example:

20

offset
integer
required

Deslocamento solicitado, a partir de zero.

Example:

0

total
integer
required

Número total de entidades encontradas.

Example:

1