OpenAPI (Swagger)

O OpenAPI da API também está disponível em api.cnpjs.dev/openapi.yml.

openapi: "3.0.0"
info:
  version: 1.0.0
  title: API HTTP para consulta de CNPJ - cnpjs.dev
servers:
  - url: https://api.cnpjs.dev
paths:
  /v1/{cnpj}:
    get:
      summary: Consulta um CNPJ
      parameters:
        - name: cnpj
          in: path
          description: CNPJ da empresa.
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Informações da empresa registrada no CNPJ informado.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Empresa"

components:
  schemas:
    Empresa:
      type: object
      required:
        - cnpj
        - razao_social
        - natureza_juridica
        - qualificacao_responsavel
        - capital_social
        - situacao_cadastral
        - data_situacao_cadastral
        - endereco
        - cnae_fiscal_principal
        - telefone1
      properties:
        cnpj:
          description: CNPJ
          type: string
          example: "33000167100246"
        razao_social:
          description: Razão social
          type: string
          example: PETROLEO BRASILEIRO S A PETROBRAS
        nome_fantasia:
          description: Nome fantasia
          type: string
          example: PETROBRAS
        natureza_juridica:
          description: Natureza jurídica
          type: string
          example: Sociedade de Economia Mista
        qualificacao_responsavel:
          description: Qualificação do responsável
          type: string
          example: Diretor
        capital_social:
          description: Capital social em reais (R$)
          type: number
          example: 205431960000
        porte:
          description: Porte da empresa
          type: string
          example: ""
        ente_federativo_responsavel:
          description: Ente federativo responsável
          type: string
          example: null
        situacao_cadastral:
          description: Situação cadastral
          type: string
          example: Ativa
        data_inicio_atividade:
          description: Data de início da atividade
          type: string
          format: date
          example: "1977-05-03"
        data_situacao_cadastral:
          description: Data da situação cadastral
          type: string
          format: date
          example: "2005-11-03"
        motivo_situacao_cadastral:
          description: Motivo da situação cadastral
          type: string
          example: "SEM MOTIVO"
        nome_da_cidade_no_exterior:
          description: Nome da cidade no exterior.
          type: string
          example: null
        pais:
          description: País.
          type: string
          example: null
        endereco:
          $ref: "#/components/schemas/Endereco"
        cnae_fiscal_principal:
          $ref: "#/components/schemas/Cnae"
        cnae_fiscal_secundaria:
          type: array
          items:
            $ref: "#/components/schemas/Cnae"
        telefone1:
          description: Telefone 1
          type: string
          example: "2132244446"
        telefone2:
          description: Telefone 2
          type: string
          example: "00"
        telefone_faz:
          description: Telefone FAX
          type: string
          example: "00"
        email:
          description: Endereço de e-mail
          type: string
          example: [email protected]
        situacao_especial:
          description: Situação especial
          type: string
          example: null
        data_situacao_especial:
          description: Data da situação especial
          type: string
          format: date
          example: null
        socios:
          type: array
          items:
            $ref: "#/components/schemas/Socio"

    Socio:
      type: object
      required:
        - tipo
      properties:
        tipo:
          description: Tipo
          type: string
          example: Pessoa física
        nome:
          description: Nome
          type: string
          example: SALVADOR DAHAN
        doc:
          description: Documento
          type: string
          example: "***672828**"
        qualificacao:
          description: Tipo
          type: string
          example: Diretor
        data_entrada:
          description: Data de entrada
          type: string
          format: date
          example: "2021-04-22"
        pais:
          description: País
          type: string
          example: ""
        faixa_etaria:
          description: Tipo
          type: string
          example: "41 a 50 anos"
        representante_legal:
          type: object
          required:
            - nome
            - doc
            - qualificacao
          properties:
            nome:
              description: Nome
              type: string
              example: ""
            doc:
              description: Documento
              type: string
              example: "***000000**"
            qualificacao:
              description: Tipo
              type: string
              example: "Não informada"

    Cnae:
      type: object
      required:
        - codigo
        - nome
      properties:
        codigo:
          description: Código CNAE
          type: number
          example: 4681801
        nome:
          description: Descrição da atividade econômica
          type: string
          example: Comércio atacadista de álcool carburante, biodiesel, gasolina e demais derivados de petróleo, exceto lubrificantes, não realizado por transportador re

    Endereco:
      type: object
      required:
        - tipo_logradouro
      properties:
        tipo_logradouro:
          description: Tipo do logradouro
          type: string
          example: AVENIDA
        logradouro:
          description: Logradouro
          type: string
          example: CORONEL SANTA RITA
        numero:
          description: Número
          type: string
          example: S N
        complemento:
          description: Complemento
          type: string
          example: CAIS DOS INFLAMAVEL
        bairro:
          description: Bairro
          type: string
          example: CENTRO
        cep:
          description: CEP
          type: string
          example: "83203210"
        uf:
          description: Unidade Federativa (Estado)
          type: string
          example: PR
        municipio:
          description: Município
          type: string
          example: PARANAGUA