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

# Vínculos societários

> Sócios do documento e participações dele em empresas.

Vínculos societários diretos do documento. Retorna até 50 itens: primeiro os sócios (`direcao: socio`), depois as participações dele (`direcao: participacao`). O documento da contraparte vem sempre mascarado. Envie `"datasets": ["vinculos"]`; a chave precisa do escopo `dados:vinculos`.


## OpenAPI

````yaml dados/ref/vinculos.openapi.yaml POST /dados/consultar
openapi: 3.1.0
info:
  description: API de dados por documento (CPF/CNPJ).
  title: NL Labs API de Dados
  version: 0.1.0
servers:
  - url: https://api.nlbs.ai
security: []
paths:
  /dados/consultar:
    post:
      tags:
        - dados
      summary: Consultar Vínculos societários
      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:
            example:
              datasets:
                - vinculos
              documento: '11222333000181'
            schema:
              $ref: '#/components/schemas/ConsultaRequisicao'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                com_dados:
                  summary: Com dados
                  value:
                    consultado_em: '2026-01-15T12:00:00Z'
                    datasets:
                      vinculos:
                        encontrado: true
                        itens:
                          - ativo: true
                            capital: '1000.00'
                            direcao: socio
                            documento: '***.982.***-**'
                            fim: null
                            inicio: '2020-01-01'
                            moeda: BRL
                            nome: Fulano de Tal
                            percentual: '50.00'
                            percentual_votos: null
                            qualificacao: Socio-Administrador
                            tipo_participacao: shareholder
                            tipo_pessoa: person
                    documento: '11222333000181'
                    encontrado: true
                    tipo: cnpj
                sem_dados:
                  summary: Sem dados
                  value:
                    consultado_em: '2026-01-15T12:00:00Z'
                    datasets:
                      vinculos:
                        encontrado: false
                        itens: []
                    documento: '11222333000181'
                    encontrado: false
                    tipo: cnpj
              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:
          default:
            - vinculos
          description: Sempre ["vinculos"] nesta página.
          items:
            enum:
              - vinculos
            type: string
          maxItems: 1
          minItems: 1
          title: Datasets
          type: array
        documento:
          description: CPF ou CNPJ, com ou sem pontuacao.
          title: Documento
          type: string
      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:
          properties:
            vinculos:
              $ref: '#/components/schemas/DatasetVinculos'
          required:
            - vinculos
          title: Datasets
          type: object
        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
    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
    ErroDetalhe:
      properties:
        codigo:
          title: Codigo
          type: string
        mensagem:
          title: Mensagem
          type: string
      required:
        - codigo
        - mensagem
      title: ErroDetalhe
      type: object
    ItemVinculo:
      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
  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.