> ## 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.

# Consulta de dados por documento

> Consulta os dados de um CPF ou CNPJ em um ou mais datasets (pep, processos, faccionados, midia, sancoes, vinculos, ubo, identidade, beneficios). Retorna, por dataset, `encontrado` e os `itens` resumidos, com documento de terceiros mascarado; processos traz tambem `total` e `proximo_cursor`. Envie `documento` e a lista `datasets`; so os datasets pedidos voltam na resposta. Dataset sem dado responde vazio (encontrado=false). Para paginar processos, repita a chamada com `processos.cursor` igual ao `proximo_cursor` recebido. Cursor invalido, adulterado ou de outro documento responde 422 (cursor_invalido). O dataset ubo exige CNPJ: com CPF responde 422 (ubo_exige_cnpj). O dataset identidade exige CPF: com CNPJ responde 422 (identidade_exige_cpf). O dataset beneficios exige CPF: com CNPJ responde 422 (beneficios_exige_cpf).



## OpenAPI

````yaml /data-openapi.yaml post /dados/consultar
openapi: 3.1.0
info:
  description: API de dados por documento (CPF/CNPJ) e por numero de processo.
  title: NL Labs API de Dados
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
paths:
  /dados/consultar:
    post:
      tags:
        - dados
      summary: Consulta de dados por documento
      description: >-
        Consulta os dados de um CPF ou CNPJ em um ou mais datasets (pep,
        processos, faccionados, midia, sancoes, vinculos, ubo, identidade,
        beneficios). Retorna, por dataset, `encontrado` e os `itens` resumidos,
        com documento de terceiros mascarado; processos traz tambem `total` e
        `proximo_cursor`. Envie `documento` e a lista `datasets`; so os datasets
        pedidos voltam na resposta. Dataset sem dado responde vazio
        (encontrado=false). Para paginar processos, repita a chamada com
        `processos.cursor` igual ao `proximo_cursor` recebido. Cursor invalido,
        adulterado ou de outro documento responde 422 (cursor_invalido). O
        dataset ubo exige CNPJ: com CPF responde 422 (ubo_exige_cnpj). O dataset
        identidade exige CPF: com CNPJ responde 422 (identidade_exige_cpf). O
        dataset beneficios exige CPF: com CNPJ responde 422
        (beneficios_exige_cpf).
      operationId: consultar_dados_consultar_post
      parameters:
        - description: >-
            Opcional. Mesma chave em 24 h a partir da primeira chamada devolve a
            mesma resposta, sem repetir a leitura.
          in: header
          name: Idempotency-Key
          required: false
          schema:
            anyOf:
              - maxLength: 255
                minLength: 1
                pattern: ^[A-Za-z0-9._\-]+$
                type: string
              - type: 'null'
            description: >-
              Opcional. Mesma chave em 24 h a partir da primeira chamada devolve
              a mesma resposta, sem repetir a leitura.
            title: Idempotency-Key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsultaRequisicao'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                consultado_em: '2026-01-15T12:00:00Z'
                datasets:
                  faccionados:
                    encontrado: true
                    itens:
                      - documento: '***.982.***-**'
                        faixa: T1
                        nome: Beltrano de Tal
                        numero_processo: 0001234-56.2020.8.26.0100
                        organizacao: Organizacao Exemplo
                  midia:
                    encontrado: true
                    itens:
                      - categoria: exemplo
                        data: '2025-06-20'
                        dominios:
                          - exemplo.com.br
                        fase: exemplo
                        tema: exemplo
                        titulo: Titulo sintetico
                        url: https://exemplo.com.br/noticia
                        veiculo: Veiculo Exemplo
                  pep:
                    encontrado: true
                    itens:
                      - cargo: Prefeito
                        descricao: Descricao sintetica.
                        inicio: '2021-01-01'
                        instituicao: Prefeitura Exemplo
                        status_pep: active
                        tipo_pep: elected_official
                        tipo_perfil: politico
                  processos:
                    encontrado: true
                    itens:
                      - assuntos:
                          - codigo: '7691'
                            nome: Obrigacoes
                        classes:
                          - codigo: '7'
                            nome: Procedimento Comum Civel
                        data_ajuizamento: '2024-03-10'
                        data_distribuicao: '2024-03-11'
                        moeda: BRL
                        numero: 0000000-00.2024.8.26.0000
                        papel: reu
                        partes:
                          - consultada: true
                            nome: Fulano de Tal
                            papel: reu
                          - consultada: false
                            nome: Beltrano de Tal
                            papel: autor
                        status: ativo
                        tipo: civel
                        tribunal:
                          cidade: Cidade
                          nome: Tribunal Exemplo
                          uf: SP
                        ultima_movimentacao: '2025-11-02'
                        valor: '10000.00'
                    total: 1
                documento: '12345678909'
                encontrado: true
                tipo: cpf
              schema:
                $ref: '#/components/schemas/ConsultaResposta'
          description: Um bloco por dataset pedido.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Chave invalida
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Escopo insuficiente ou sem acesso
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Entrada invalida, ubo com CPF ou identidade com CNPJ
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Cota esgotada
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroResposta'
          description: Indisponivel
      security:
        - APIKeyHeader: []
components:
  schemas:
    ConsultaRequisicao:
      additionalProperties: false
      properties:
        datasets:
          items:
            $ref: '#/components/schemas/Dataset'
          maxItems: 9
          minItems: 1
          title: Datasets
          type: array
        documento:
          description: CPF ou CNPJ, com ou sem pontuacao.
          title: Documento
          type: string
        processos:
          anyOf:
            - $ref: '#/components/schemas/ParametrosProcessos'
            - type: 'null'
          description: Paginacao dos processos. Sem offset.
      required:
        - documento
        - datasets
      title: ConsultaRequisicao
      type: object
    ConsultaResposta:
      properties:
        consultado_em:
          description: Instante da consulta, ISO 8601 em UTC (sufixo Z).
          examples:
            - '2026-01-15T12:00:00Z'
          format: date-time
          title: Consultado Em
          type: string
        datasets:
          $ref: '#/components/schemas/DatasetsResposta'
        documento:
          title: Documento
          type: string
        encontrado:
          title: Encontrado
          type: boolean
        tipo:
          enum:
            - cpf
            - cnpj
          title: Tipo
          type: string
      required:
        - documento
        - tipo
        - encontrado
        - consultado_em
        - datasets
      title: ConsultaResposta
      type: object
    ErroResposta:
      properties:
        erro:
          $ref: '#/components/schemas/ErroDetalhe'
      required:
        - erro
      title: ErroResposta
      type: object
    Dataset:
      enum:
        - pep
        - processos
        - faccionados
        - midia
        - sancoes
        - vinculos
        - ubo
        - identidade
        - beneficios
      title: Dataset
      type: string
    ParametrosProcessos:
      additionalProperties: false
      properties:
        cursor:
          anyOf:
            - maxLength: 512
              type: string
            - type: 'null'
          description: >-
            Cursor opaco e assinado da pagina anterior: use exatamente o
            proximo_cursor recebido.
          title: Cursor
        limite:
          default: 25
          description: Itens por pagina.
          maximum: 100
          minimum: 1
          title: Limite
          type: integer
      title: ParametrosProcessos
      type: object
    DatasetsResposta:
      description: So aparecem os datasets pedidos.
      properties:
        beneficios:
          anyOf:
            - $ref: '#/components/schemas/DatasetBeneficios'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Beneficios
        faccionados:
          anyOf:
            - $ref: '#/components/schemas/DatasetFaccionados'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Faccionados
        identidade:
          anyOf:
            - $ref: '#/components/schemas/DatasetIdentidade'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Identidade
        midia:
          anyOf:
            - $ref: '#/components/schemas/DatasetMidia'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Midia
        pep:
          anyOf:
            - $ref: '#/components/schemas/DatasetPep'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Pep
        processos:
          anyOf:
            - $ref: '#/components/schemas/DatasetProcessos'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Processos
        sancoes:
          anyOf:
            - $ref: '#/components/schemas/DatasetSancoes'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Sancoes
        ubo:
          anyOf:
            - $ref: '#/components/schemas/DatasetUbo'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Ubo
        vinculos:
          anyOf:
            - $ref: '#/components/schemas/DatasetVinculos'
            - $ref: '#/components/schemas/BlocoIndisponivel'
            - type: 'null'
          title: Vinculos
      title: DatasetsResposta
      type: object
    ErroDetalhe:
      properties:
        codigo:
          title: Codigo
          type: string
        mensagem:
          title: Mensagem
          type: string
      required:
        - codigo
        - mensagem
      title: ErroDetalhe
      type: object
    DatasetBeneficios:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: >-
            Um item por programa de beneficio social federal. Vazio quando nao
            ha beneficio.
          items:
            $ref: '#/components/schemas/ItemBeneficio'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetBeneficios
      type: object
    BlocoIndisponivel:
      description: 'Dataset pedido que nao pode ser servido (ex.: nao_implementado).'
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        erro:
          $ref: '#/components/schemas/ErroDetalhe'
        itens:
          description: Itens resumidos. Documento de terceiros sempre mascarado.
          items:
            additionalProperties: true
            type: object
          title: Itens
          type: array
      required:
        - encontrado
        - itens
        - erro
      title: BlocoIndisponivel
      type: object
    DatasetFaccionados:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Ate 50 avaliacoes. Sem cursor.
          items:
            $ref: '#/components/schemas/ItemFaccionado'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetFaccionados
      type: object
    DatasetIdentidade:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: A pessoa consultada (um item). So para CPF.
          items:
            $ref: '#/components/schemas/ItemIdentidade'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetIdentidade
      type: object
    DatasetMidia:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Ate 25 ocorrencias, mais recentes primeiro.
          items:
            $ref: '#/components/schemas/ItemMidia'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetMidia
      type: object
    DatasetPep:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Ate 50 perfis.
          items:
            $ref: '#/components/schemas/ItemPep'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetPep
      type: object
    DatasetProcessos:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Uma pagina de processos.
          items:
            $ref: '#/components/schemas/ItemProcesso'
          title: Itens
          type: array
        proximo_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Cursor da proxima pagina; null quando acabou.
          title: Proximo Cursor
        total:
          description: Total de processos do documento.
          minimum: 0
          title: Total
          type: integer
      required:
        - encontrado
        - itens
        - total
      title: DatasetProcessos
      type: object
    DatasetSancoes:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: >-
            Sancoes, restricoes, processos administrativos e watchlist; ate 50
            de cada tipo.
          items:
            discriminator:
              mapping:
                processo_administrativo: '#/components/schemas/ItemProcessoAdministrativo'
                restricao: '#/components/schemas/ItemRestricao'
                sancao: '#/components/schemas/ItemSancao'
                watchlist: '#/components/schemas/ItemWatchlist'
              propertyName: tipo
            oneOf:
              - $ref: '#/components/schemas/ItemSancao'
              - $ref: '#/components/schemas/ItemRestricao'
              - $ref: '#/components/schemas/ItemProcessoAdministrativo'
              - $ref: '#/components/schemas/ItemWatchlist'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetSancoes
      type: object
    DatasetUbo:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: Ate 50 beneficiarios finais. So para CNPJ.
          items:
            $ref: '#/components/schemas/ItemUbo'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetUbo
      type: object
    DatasetVinculos:
      properties:
        encontrado:
          title: Encontrado
          type: boolean
        itens:
          description: >-
            Ate 50 vinculos: primeiro os socios do consultado, depois as
            participacoes dele.
          items:
            $ref: '#/components/schemas/ItemVinculo'
          title: Itens
          type: array
      required:
        - encontrado
        - itens
      title: DatasetVinculos
      type: object
    ItemBeneficio:
      description: >-
        Resumo de um programa de beneficio social federal, sem historico de
        pagamentos.
      properties:
        first_payment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Primeiro pagamento (AAAA-MM-DD).
          title: First Payment Date
        last_budget_year:
          anyOf:
            - type: integer
            - type: 'null'
          description: Maior ano de orcamento dos pagamentos.
          title: Last Budget Year
        last_payment_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Ultimo pagamento (AAAA-MM-DD).
          title: Last Payment Date
        payment_count:
          minimum: 0
          title: Payment Count
          type: integer
        program_code:
          description: 'Codigo do programa (ex.: bolsa_familia, pe_de_meia).'
          title: Program Code
          type: string
        program_name:
          title: Program Name
          type: string
        total_amount:
          description: Soma dos pagamentos em BRL, texto decimal.
          title: Total Amount
          type: string
      required:
        - program_code
        - program_name
        - first_payment_date
        - last_payment_date
        - payment_count
        - total_amount
        - last_budget_year
      title: ItemBeneficio
      type: object
    ItemFaccionado:
      description: Avaliacao de vinculo com faccao. Documento de terceiros mascarado.
      properties:
        documento:
          anyOf:
            - type: string
            - type: 'null'
          description: CPF do membro; mascarado se nao for o documento consultado.
          title: Documento
        faixa:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Faixa da avaliação. T1 (Grau 1): condenado por crime associativo
            (organização criminosa, associação para o tráfico ou associação
            criminosa), ou incluído em Regime Disciplinar Diferenciado por
            decisão judicial. Uso recomendado: fundamenta diligência reforçada.
            T2 (Grau 2): decisão judicial aponta vínculo com facção criminosa.
            Não indica condenação. Uso recomendado: fundamenta diligência
            reforçada. T3 (Sinal): facção mencionada sem confirmação por decisão
            judicial. Não indica vínculo nem condenação. Uso recomendado:
            prioriza a análise humana. Sozinho, não fundamenta recusa nem
            encerramento.
          title: Faixa
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome do membro da faccao, inteiro.
          title: Nome
        numero_processo:
          anyOf:
            - type: string
            - type: 'null'
          description: Numero do processo ligado (CNJ), ou null se o caso nao tiver numero.
          title: Numero Processo
        organizacao:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome da organizacao criminosa.
          title: Organizacao
      required:
        - organizacao
        - faixa
        - numero_processo
        - nome
        - documento
      title: ItemFaccionado
      type: object
    ItemIdentidade:
      description: Dados cadastrais da pessoa fisica consultada. Raca e cor nunca entram.
      properties:
        cpf:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            CPF do consultado completo; CPF diferente do consultado vem
            mascarado.
          title: Cpf
        data_nascimento:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Nascimento
        data_obito:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Obito
        emails:
          description: Todos os emails, o principal primeiro (ate 50).
          items:
            type: string
          title: Emails
          type: array
        endereco:
          anyOf:
            - $ref: '#/components/schemas/EnderecoIdentidade'
            - type: 'null'
        escolaridade:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Nivel de escolaridade (ex.: higher_education).'
          title: Escolaridade
        estado_civil:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Estado civil (ex.: married).'
          title: Estado Civil
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        nome_mae:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome Mae
        nome_pai:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome Pai
        situacao_cadastral:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Situacao cadastral do CPF na Receita (ex.: regular, suspended).'
          title: Situacao Cadastral
        telefones:
          description: Todos os telefones, o principal primeiro (ate 50).
          items:
            type: string
          title: Telefones
          type: array
      required:
        - nome
        - cpf
        - nome_mae
        - nome_pai
        - escolaridade
        - estado_civil
        - emails
        - telefones
        - endereco
        - data_nascimento
        - situacao_cadastral
        - data_obito
      title: ItemIdentidade
      type: object
    ItemMidia:
      description: Ocorrencia de exposicao em midia, sem resumo.
      properties:
        categoria:
          anyOf:
            - type: string
            - type: 'null'
          description: Categoria da exposicao.
          title: Categoria
        crimes:
          anyOf:
            - type: string
            - type: 'null'
          description: Crimes imputados, em texto.
          title: Crimes
        data:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Data do evento (AAAA-MM-DD).
          title: Data
        dominios:
          description: Dominios das fontes.
          items:
            type: string
          title: Dominios
          type: array
        faccao:
          anyOf:
            - type: string
            - type: 'null'
          description: Faccao citada, quando houver.
          title: Faccao
        fase:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Fase da exposicao (ex.: preso).'
          title: Fase
        tema:
          anyOf:
            - type: string
            - type: 'null'
          description: Tema da exposicao.
          title: Tema
        titulo:
          anyOf:
            - type: string
            - type: 'null'
          description: Titulo da materia.
          title: Titulo
        url:
          anyOf:
            - type: string
            - type: 'null'
          description: Primeira URL de fonte.
          title: Url
        veiculo:
          anyOf:
            - type: string
            - type: 'null'
          description: Veiculo principal.
          title: Veiculo
      required:
        - data
        - titulo
        - categoria
        - tema
        - fase
        - faccao
        - crimes
        - url
        - dominios
        - veiculo
      title: ItemMidia
      type: object
    ItemPep:
      description: Perfil politico. Sem documento de terceiros.
      properties:
        cargo:
          anyOf:
            - type: string
            - type: 'null'
          description: Cargo ou funcao.
          title: Cargo
        descricao:
          anyOf:
            - type: string
            - type: 'null'
          description: Descricao resumida, truncada em 500 caracteres.
          title: Descricao
        fim:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Fim do exercicio; null se em curso.
          title: Fim
        grau:
          anyOf:
            - type: integer
            - type: 'null'
          description: Grau do vinculo, conforme a fonte.
          title: Grau
        inicio:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Inicio do exercicio (AAAA-MM-DD).
          title: Inicio
        instituicao:
          anyOf:
            - type: string
            - type: 'null'
          description: Orgao ou instituicao do cargo.
          title: Instituicao
        status_pep:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Situacao do PEP: active, former ou inactive.'
          title: Status Pep
        tipo_pep:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Classificacao do PEP: elected_official, senior_public_official,
            judiciary, military, political_party_leader,
            state_owned_company_executive, international_organization_official,
            related_person, close_associate ou other.
          title: Tipo Pep
        tipo_perfil:
          anyOf:
            - type: string
            - type: 'null'
          description: Tipo do perfil politico.
          title: Tipo Perfil
      required:
        - tipo_perfil
        - tipo_pep
        - status_pep
        - grau
        - cargo
        - instituicao
        - inicio
        - fim
        - descricao
      title: ItemPep
      type: object
    ItemProcesso:
      description: >-
        Processo ligado ao documento: cabecalho, vinculo da entidade e partes,
        sem movimentos.
      properties:
        assuntos:
          items:
            $ref: '#/components/schemas/AssuntoProcesso'
          title: Assuntos
          type: array
        ativo:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Se o vinculo esta ativo.
          title: Ativo
        classes:
          items:
            $ref: '#/components/schemas/ClasseProcesso'
          title: Classes
          type: array
        data_ajuizamento:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Ajuizamento
        data_distribuicao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Distribuicao
        moeda:
          anyOf:
            - type: string
            - type: 'null'
          title: Moeda
        numero:
          anyOf:
            - type: string
            - type: 'null'
          description: Numero CNJ.
          title: Numero
        papel:
          anyOf:
            - type: string
            - type: 'null'
          description: Papel do documento consultado no processo.
          title: Papel
        papel_detalhe:
          anyOf:
            - type: string
            - type: 'null'
          title: Papel Detalhe
        partes:
          items:
            $ref: '#/components/schemas/ParteConsulta'
          title: Partes
          type: array
        polaridade:
          anyOf:
            - type: string
            - type: 'null'
          title: Polaridade
        principal:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Se o vinculo e o principal.
          title: Principal
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        tipo:
          anyOf:
            - type: string
            - type: 'null'
          title: Tipo
        titulo:
          anyOf:
            - type: string
            - type: 'null'
          title: Titulo
        tribunal:
          $ref: '#/components/schemas/TribunalProcesso'
        ultima_movimentacao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Ultima Movimentacao
        valor:
          anyOf:
            - type: string
            - type: 'null'
          description: Valor da causa como texto decimal.
          title: Valor
      required:
        - numero
        - tipo
        - titulo
        - status
        - data_ajuizamento
        - data_distribuicao
        - ultima_movimentacao
        - valor
        - moeda
        - tribunal
        - classes
        - assuntos
        - papel
        - papel_detalhe
        - principal
        - ativo
        - polaridade
        - partes
      title: ItemProcesso
      type: object
    ItemProcessoAdministrativo:
      description: Processo administrativo sancionador.
      properties:
        acordo:
          anyOf:
            - type: boolean
            - type: 'null'
          description: 'Se houve acordo (ex.: leniencia).'
          title: Acordo
        data_abertura:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Abertura
        data_decisao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Decisao
        data_encerramento:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Encerramento
        descricao:
          anyOf:
            - type: string
            - type: 'null'
          description: Truncada em 500 caracteres.
          title: Descricao
        numero:
          anyOf:
            - type: string
            - type: 'null'
          title: Numero
        orgao_julgador:
          anyOf:
            - type: string
            - type: 'null'
          title: Orgao Julgador
        origem:
          anyOf:
            - type: string
            - type: 'null'
          title: Origem
        resultado:
          anyOf:
            - type: string
            - type: 'null'
          title: Resultado
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        tipo:
          const: processo_administrativo
          description: Sempre processo_administrativo.
          title: Tipo
          type: string
        tipo_processo:
          anyOf:
            - type: string
            - type: 'null'
          title: Tipo Processo
        titulo:
          anyOf:
            - type: string
            - type: 'null'
          title: Titulo
      required:
        - tipo
        - numero
        - tipo_processo
        - status
        - titulo
        - descricao
        - data_abertura
        - data_encerramento
        - data_decisao
        - origem
        - resultado
        - acordo
        - orgao_julgador
      title: ItemProcessoAdministrativo
      type: object
    ItemRestricao:
      description: >-
        Restricao ou impedimento (ex.: proibicao de contratar com o poder
        publico).
      properties:
        descricao:
          anyOf:
            - type: string
            - type: 'null'
          description: Truncada em 500 caracteres.
          title: Descricao
        escopo:
          anyOf:
            - type: string
            - type: 'null'
          description: Abrangencia da restricao.
          title: Escopo
        fim:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Fim da restricao; null se sem prazo.
          title: Fim
        inicio:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Inicio
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        tipo:
          const: restricao
          description: Sempre restricao.
          title: Tipo
          type: string
        tipo_restricao:
          anyOf:
            - type: string
            - type: 'null'
          title: Tipo Restricao
      required:
        - tipo
        - tipo_restricao
        - escopo
        - status
        - descricao
        - inicio
        - fim
      title: ItemRestricao
      type: object
    ItemSancao:
      description: Sancao aplicada a entidade (CEIS, CNEP, CVM etc.).
      properties:
        autoridade:
          anyOf:
            - type: string
            - type: 'null'
          description: Orgao sancionador.
          title: Autoridade
        categoria:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Categoria (ex.: administrative).'
          title: Categoria
        data_decisao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Decisao
        data_publicacao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Publicacao
        descricao:
          anyOf:
            - type: string
            - type: 'null'
          description: Truncada em 500 caracteres.
          title: Descricao
        moeda:
          anyOf:
            - type: string
            - type: 'null'
          title: Moeda
        status:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Situacao da sancao (ex.: active).'
          title: Status
        tipo:
          const: sancao
          description: Sempre sancao.
          title: Tipo
          type: string
        tipo_sancao:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Tipo da sancao (ex.: debarment).'
          title: Tipo Sancao
        titulo:
          anyOf:
            - type: string
            - type: 'null'
          title: Titulo
        valor:
          anyOf:
            - type: string
            - type: 'null'
          description: Valor da multa como texto decimal.
          title: Valor
      required:
        - tipo
        - tipo_sancao
        - categoria
        - status
        - titulo
        - descricao
        - autoridade
        - data_decisao
        - data_publicacao
        - valor
        - moeda
      title: ItemSancao
      type: object
    ItemWatchlist:
      description: Entrada em lista de observacao (watchlist).
      properties:
        data_inclusao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Inclusao
        data_remocao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Data Remocao
        data_ultima_aparicao:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: Ultima vez visto na lista.
          title: Data Ultima Aparicao
        motivo:
          anyOf:
            - type: string
            - type: 'null'
          description: Truncado em 500 caracteres.
          title: Motivo
        nivel_risco:
          anyOf:
            - type: string
            - type: 'null'
          title: Nivel Risco
        nome_na_fonte:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome como aparece na lista.
          title: Nome Na Fonte
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        tipo:
          const: watchlist
          description: Sempre watchlist.
          title: Tipo
          type: string
        tipo_entrada:
          anyOf:
            - type: string
            - type: 'null'
          title: Tipo Entrada
      required:
        - tipo
        - tipo_entrada
        - status
        - nivel_risco
        - nome_na_fonte
        - data_inclusao
        - data_ultima_aparicao
        - data_remocao
        - motivo
      title: ItemWatchlist
      type: object
    ItemUbo:
      description: Beneficiario final da empresa consultada. Documento sempre mascarado.
      properties:
        ativo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Ativo
        direto:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Se a participacao e direta.
          title: Direto
        documento:
          anyOf:
            - type: string
            - type: 'null'
          description: CPF ou CNPJ do beneficiario, mascarado.
          title: Documento
        fim:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Fim
        inicio:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Inicio
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        percentual:
          anyOf:
            - type: string
            - type: 'null'
          description: Percentual do capital, texto decimal.
          title: Percentual
        percentual_votos:
          anyOf:
            - type: string
            - type: 'null'
          description: Percentual dos votos, texto decimal.
          title: Percentual Votos
        profundidade:
          anyOf:
            - type: integer
            - type: 'null'
          description: Niveis na cadeia de controle.
          title: Profundidade
        tipo_beneficio:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Tipo do beneficio (ex.: ownership).'
          title: Tipo Beneficio
        tipo_controle:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Tipo de controle (ex.: direct).'
          title: Tipo Controle
        tipo_pessoa:
          anyOf:
            - type: string
            - type: 'null'
          description: person, organization etc.
          title: Tipo Pessoa
      required:
        - nome
        - tipo_pessoa
        - documento
        - tipo_beneficio
        - tipo_controle
        - percentual
        - percentual_votos
        - direto
        - profundidade
        - inicio
        - fim
        - ativo
      title: ItemUbo
      type: object
    ItemVinculo:
      description: Vinculo societario direto. Documento da contraparte sempre mascarado.
      properties:
        ativo:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Ativo
        capital:
          anyOf:
            - type: string
            - type: 'null'
          description: Capital integralizado, texto decimal.
          title: Capital
        direcao:
          description: >-
            socio: a contraparte e socia do consultado; participacao: o
            consultado e socio da contraparte.
          enum:
            - socio
            - participacao
          title: Direcao
          type: string
        documento:
          anyOf:
            - type: string
            - type: 'null'
          description: CPF ou CNPJ da contraparte, mascarado.
          title: Documento
        fim:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Fim
        inicio:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          title: Inicio
        moeda:
          anyOf:
            - type: string
            - type: 'null'
          title: Moeda
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome da contraparte.
          title: Nome
        percentual:
          anyOf:
            - type: string
            - type: 'null'
          description: Percentual do capital, texto decimal de 0 a 100.
          title: Percentual
        percentual_votos:
          anyOf:
            - type: string
            - type: 'null'
          description: Percentual dos votos, texto decimal.
          title: Percentual Votos
        qualificacao:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Qualificacao na fonte (ex.: Socio-Administrador).'
          title: Qualificacao
        tipo_participacao:
          anyOf:
            - type: string
            - type: 'null'
          description: 'Tipo da participacao (ex.: shareholder).'
          title: Tipo Participacao
        tipo_pessoa:
          anyOf:
            - type: string
            - type: 'null'
          description: person, organization etc.
          title: Tipo Pessoa
      required:
        - direcao
        - nome
        - tipo_pessoa
        - documento
        - tipo_participacao
        - qualificacao
        - percentual
        - percentual_votos
        - capital
        - moeda
        - inicio
        - fim
        - ativo
      title: ItemVinculo
      type: object
    EnderecoIdentidade:
      description: >-
        Endereco principal. Logradouro, numero, complemento e bairro nao vem
        separados na fonte.
      properties:
        cep:
          anyOf:
            - type: string
            - type: 'null'
          title: Cep
        completo:
          anyOf:
            - type: string
            - type: 'null'
          description: Endereco completo como na fonte, em texto unico.
          title: Completo
        municipio:
          anyOf:
            - type: string
            - type: 'null'
          title: Municipio
        uf:
          anyOf:
            - type: string
            - type: 'null'
          title: Uf
      required:
        - completo
        - municipio
        - uf
        - cep
      title: EnderecoIdentidade
      type: object
    AssuntoProcesso:
      properties:
        codigo:
          title: Codigo
          type: string
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome do assunto na TPU do CNJ, quando conhecido.
          title: Nome
      required:
        - codigo
        - nome
      title: AssuntoProcesso
      type: object
    ClasseProcesso:
      properties:
        codigo:
          title: Codigo
          type: string
        nome:
          anyOf:
            - type: string
            - type: 'null'
          description: Nome da classe na TPU do CNJ, quando conhecido.
          title: Nome
      required:
        - codigo
        - nome
      title: ClasseProcesso
      type: object
    ParteConsulta:
      properties:
        consultada:
          description: True se a parte e o documento consultado.
          title: Consultada
          type: boolean
        documento:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Documento da parte. Nulo quando nao esta disponivel (hoje o dataset
            de processos nao guarda o documento das partes); quando disponivel,
            vem completo para o documento consultado e mascarado para as demais
            partes.
          title: Documento
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        papel:
          anyOf:
            - type: string
            - type: 'null'
          title: Papel
      required:
        - nome
        - documento
        - papel
        - consultada
      title: ParteConsulta
      type: object
    TribunalProcesso:
      properties:
        cidade:
          anyOf:
            - type: string
            - type: 'null'
          title: Cidade
        nome:
          anyOf:
            - type: string
            - type: 'null'
          title: Nome
        uf:
          anyOf:
            - type: string
            - type: 'null'
          title: Uf
      required:
        - nome
        - cidade
        - uf
      title: TribunalProcesso
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.