> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nlbs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Buscar entidades canônicas

> Busca entidades canônicas por nome, documento, ou ambos. Ao menos um de name ou document é obrigatório. Busca parcial por documento exige name.



## OpenAPI

````yaml GET /entities
openapi: 3.1.0
info:
  description: Superfície pública da API para clientes autenticados por chave de API.
  title: NL Labs Gateway (Public API)
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
tags:
  - description: Busca de entidades canônicas.
    name: entities
  - description: Criação, leitura, grafo e dossiê de análises.
    name: analyses
  - description: Relatório regulatório (COAF/SUSEP).
    name: reports
  - description: Triagem de mídia adversa.
    name: adverse-media
  - description: Versões do manifesto regulatório.
    name: regulatory
  - description: Versões do catálogo de regras do motor de risco.
    name: rules
  - description: Endpoints e eventos de webhook.
    name: webhooks
  - description: >-
      Entrypoints HTTP de workflow: invocar um workflow e consultar sua
      execução.
    name: workflow-endpoints
paths:
  /entities:
    get:
      tags:
        - entities
      summary: Buscar entidades canônicas
      description: >-
        Busca entidades canônicas por nome, documento, ou ambos. Ao menos um de
        name ou document é obrigatório. Busca parcial por documento exige name.
      operationId: list_entities
      parameters:
        - description: Fragmento de nome. Deve conter ao menos 3 caracteres úteis.
          in: query
          name: name
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Fragmento de nome. Deve conter ao menos 3 caracteres úteis.
            examples:
              - Maria Silva
            title: Name
        - description: >-
            CPF válido ou CNPJ numérico/alfanumérico. Valores parciais exigem
            name.
          in: query
          name: document
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              CPF válido ou CNPJ numérico/alfanumérico. Valores parciais exigem
              name.
            examples:
              - '12345678901'
            title: Document
        - description: Filtro opcional de tipo de entidade.
          in: query
          name: entity_type
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/EntityType'
              - type: 'null'
            description: Filtro opcional de tipo de entidade.
            title: Entity Type
        - description: Tamanho máximo da página.
          in: query
          name: limit
          required: false
          schema:
            default: 20
            description: Tamanho máximo da página.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: Deslocamento da página, a partir de zero.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: Deslocamento da página, a partir de zero.
            minimum: 0
            title: Offset
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityListResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Chave de API ausente, malformada, expirada ou inválida.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: A chave de API autenticada não tem o escopo necessário.
        '422':
          description: >-
            Corpo da requisição, parâmetro de rota, parâmetro de query ou regra
            de negócio inválidos.
components:
  schemas:
    EntityType:
      enum:
        - person
        - organization
        - government_agency
        - financial_institution
        - political_party
        - foreign_entity
        - vessel
        - aircraft
        - notary_office
        - unknown
      title: EntityType
      type: string
    EntityListResponse:
      properties:
        items:
          description: Entidades na página atual.
          items:
            $ref: '#/components/schemas/EntityListItem'
          title: Items
          type: array
        limit:
          description: Tamanho de página solicitado.
          examples:
            - 20
          title: Limit
          type: integer
        offset:
          description: Deslocamento solicitado, a partir de zero.
          examples:
            - 0
          title: Offset
          type: integer
        total:
          description: Número total de entidades encontradas.
          examples:
            - 1
          title: Total
          type: integer
      required:
        - items
        - total
        - limit
        - offset
      title: EntityListResponse
      type: object
    ErrorResponse:
      properties:
        detail:
          description: Mensagem de erro pública e estável.
          examples:
            - Resource not found.
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    EntityListItem:
      examples:
        - aliases:
            - M. Silva
          display_name: Maria Silva
          entity_type: person
          id: 410752090310337400
          identifiers:
            - identifier_type: CPF
              is_masked: true
              value: '***.123.456-**'
          legal_name: Maria Silva
      properties:
        aliases:
          description: Apelidos conhecidos da entidade.
          items:
            type: string
          title: Aliases
          type: array
        display_name:
          description: Nome de exibição escolhido para o resultado de busca.
          title: Display Name
          type: string
        entity_type:
          $ref: '#/components/schemas/EntityType'
          description: Tipo canônico da entidade.
        id:
          description: Identificador numérico externo da entidade canônica.
          title: Id
          type: integer
        identifiers:
          description: Identificadores relevantes, mascarados.
          items:
            $ref: '#/components/schemas/EntityIdentifierSummary'
          title: Identifiers
          type: array
        legal_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Razão social/nome legal, quando disponível.
          title: Legal Name
      required:
        - id
        - entity_type
        - display_name
        - legal_name
        - identifiers
        - aliases
      title: EntityListItem
      type: object
    EntityIdentifierSummary:
      properties:
        identifier_type:
          $ref: '#/components/schemas/EntityIdentifierType'
          description: Tipo do identificador, como CPF ou CNPJ.
        is_masked:
          description: Se o valor do identificador está mascarado.
          title: Is Masked
          type: boolean
        value:
          description: Valor mascarado do identificador, seguro para resposta de API.
          title: Value
          type: string
      required:
        - identifier_type
        - value
        - is_masked
      title: EntityIdentifierSummary
      type: object
    EntityIdentifierType:
      enum:
        - CPF
        - CNPJ
        - CNPJ_ROOT
        - RG
        - PASSPORT
        - VOTER_ID
        - TSE_CANDIDATE_ID
        - OAB
        - CVM_CODE
        - OFAC_UID
        - UN_SANCTION_ID
        - LEI
        - INTERNAL_ID
        - TSE_PARTY_NUMBER
        - NIS
        - GOV_ORG_CODE
      title: EntityIdentifierType
      type: string

````