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

# Cadastro

> Consulta gratuita de cadastro e endereço de uma empresa para todos os usuários, inclusive sem saldo.

Grátis


## OpenAPI

````yaml /api-reference/openapi.json post /v3/businesses/registration
openapi: 3.1.2
info:
  title: API Base39
  version: 3.0.0
  description: >-
    Contratos canônicos Base39 compartilhados entre API e MCP. Consultas de
    dados usam POST com identificadores e filtros no corpo JSON. GET lê recursos
    já criados, saldo, extrato e especificação; criação, atualização parcial e
    remoção usam POST, PATCH e DELETE. Campos de negócio em snake_case. Valores
    financeiros em centavos de BRL; montantes de dados consultados são textos
    decimais que preservam a precisão informada. Datas cadastrais usam
    YYYY-MM-DD. As consultas podem debitar o saldo; a repetição equivalente na
    organização é gratuita até meia-noite de São Paulo. O extrato informa o
    consumo. Campos ausentes não significam zero nem aprovação de crédito.
servers:
  - url: https://mcp.base39.com.br
    description: API pública Base39, independente do caminho do protocolo MCP.
security:
  - bearer_auth: []
tags:
  - name: Pessoas
    description: Consultas de pessoas.
  - name: Empresas
    description: Consultas de empresas.
  - name: Processos Judiciais
    description: Consultas de processos judiciais.
  - name: Sanções
    description: Consultas de sanções.
  - name: Crédito
    description: Consultas de crédito.
  - name: Certidões
    description: Consultas de certidões.
  - name: Dados públicos
    description: Consultas de dados públicos.
  - name: Monitoramento e notificações
    description: Monitoramento recorrente e destinos de notificações da organização.
  - name: Modelos de relatórios
    description: Modelos de relatório e seus recursos na organização autenticada.
  - name: Saldo e pagamentos
    description: Saldo e extrato da organização autenticada.
paths:
  /v3/businesses/registration:
    post:
      tags:
        - Empresas
      summary: Cadastro
      description: >-
        Consulta gratuita de cadastro e endereço de uma empresa para todos os
        usuários, inclusive sem saldo.
      operationId: get_business
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/get_business_request'
            examples:
              requisicao:
                summary: Parâmetros da consulta.
                value:
                  document: '19131243000197'
      responses:
        '200':
          description: >-
            Objeto ou página de dados Base39; next_cursor ausente indica o fim
            da coleção.
          headers:
            Request-Id:
              description: Identificador da requisição para suporte e rastreamento.
              schema:
                type: string
              example: req_example
            Cache-Control:
              description: >-
                As respostas autenticadas não devem ser armazenadas por serviços
                HTTP compartilhados.
              schema:
                type: string
                const: no-store
              example: no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_business_response'
              examples:
                resposta:
                  summary: Exemplo de resposta Base39.
                  value:
                    object: business
                    document: '19131243000197'
                    legal_name: Empresa de teste
                    trade_name: Exemplo
                    registration_status: Ativa
                    status_date: '2020-01-02'
                    founded_at: '2020-01-02'
                    legal_nature: Sociedade Empresária Limitada
                    size: Microempresa (ME)
                    capital: '1234.56789'
                    address:
                      street: Rua de teste
                      street_type: RUA
                      number: '0'
                      neighborhood: Centro
                      postal_code: '01001000'
                      city: São Paulo
                      state: SP
                    establishment_type: Matriz
                    main_activity_code: '6201501'
                    secondary_activity_codes:
                      - '6202300'
                    legal_nature_code: '2062'
                    email: contato@example.com
                    phones:
                      - object: phone
                        area_code: '11'
                        number: '30001234'
                        is_fax: false
                    simple_tax_opt_in: false
                    microentrepreneur_opt_in: false
                    personal_data_anonymized: false
                    officers:
                      - object: officer
                        document: '***123456**'
                        name: Pessoa de teste
                        qualification: Sócio
                        joined_at: '2020-01-02'
                        person_type: Pessoa Física
                        age_range: 31 a 40 anos
                        country_code: '105'
                        country: BRASIL
                    updated_at: '2026-11-01T00:00:00Z'
        '400':
          $ref: '#/components/responses/error_400'
        '401':
          $ref: '#/components/responses/error_401'
        '402':
          $ref: '#/components/responses/error_402'
        '403':
          $ref: '#/components/responses/error_403'
        '404':
          $ref: '#/components/responses/error_404'
        '405':
          $ref: '#/components/responses/error_405'
        '409':
          $ref: '#/components/responses/error_409'
        '413':
          $ref: '#/components/responses/error_413'
        '415':
          $ref: '#/components/responses/error_415'
        '422':
          $ref: '#/components/responses/error_422'
        '425':
          $ref: '#/components/responses/error_425'
        '502':
          $ref: '#/components/responses/error_502'
        '503':
          $ref: '#/components/responses/error_503'
        '504':
          $ref: '#/components/responses/error_504'
components:
  schemas:
    get_business_request:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        document:
          description: CNPJ completo, com ou sem pontuação.
          title: CNPJ
          type: string
          pattern: >-
            ^(?:[0-9A-Za-z]{12}\d{2}|[0-9A-Za-z]{2}\.[0-9A-Za-z]{3}\.[0-9A-Za-z]{3}\/[0-9A-Za-z]{4}-\d{2})$
      required:
        - document
      additionalProperties: false
    get_business_response:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        object:
          type: string
          const: business
          description: 'Tipo do objeto: empresa.'
        document:
          type: string
          minLength: 1
          description: CPF ou CNPJ informado pela fonte; pode estar mascarado.
        legal_name:
          type: string
          minLength: 1
          description: Razão social.
        trade_name:
          type: string
          description: Nome fantasia.
        registration_status:
          type: string
          description: Situação cadastral, preservada conforme a fonte.
        status_date:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data da situação cadastral, em YYYY-MM-DD.
        founded_at:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data de abertura, em YYYY-MM-DD.
        legal_nature:
          type: string
          description: Natureza jurídica.
        size:
          type: string
          description: Porte da empresa.
        capital:
          type: string
          pattern: ^-?\d+(?:\.\d+)?$
          description: >-
            Capital social em reais, como texto decimal, preservando a precisão
            informada.
        main_activity:
          type: string
          description: Atividade econômica principal.
        address:
          description: Endereço cadastral, quando informado.
          type: object
          properties:
            street:
              type: string
              description: Logradouro.
            street_type:
              type: string
              description: Tipo de logradouro.
            number:
              type: string
              description: Número do endereço.
            complement:
              type: string
              description: Complemento do endereço.
            neighborhood:
              type: string
              description: Bairro.
            postal_code:
              type: string
              description: Código postal.
            city:
              type: string
              description: Município.
            state:
              type: string
              description: Unidade federativa.
            country:
              type: string
              description: País informado pela fonte.
            active:
              type: boolean
              description: Indica se o endereço está ativo na fonte.
          additionalProperties: false
        establishment_type:
          type: string
          description: Indica matriz ou filial.
        main_activity_code:
          type: string
          description: Código CNAE da atividade principal.
        secondary_activity_codes:
          type: array
          items:
            type: string
          description: Códigos CNAE das atividades secundárias.
        legal_nature_code:
          type: string
          description: Código da natureza jurídica.
        email:
          type: string
          description: Endereço de e-mail.
        phones:
          type: array
          items:
            type: object
            properties:
              object:
                type: string
                const: phone
                description: Tipo do objeto Base39.
              area_code:
                type: string
                description: Código de área do telefone.
              number:
                type: string
                description: Número de identificação.
              is_fax:
                type: boolean
                description: Indica telefone de fax.
            required:
              - object
              - is_fax
            additionalProperties: false
          description: Telefones informados.
        simple_tax_opt_in:
          type: boolean
          description: Opção pelo Simples Nacional, conforme informada.
        simple_tax_opted_at:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data da opção pelo Simples Nacional.
        microentrepreneur_opt_in:
          type: boolean
          description: Opção pelo MEI, conforme informada.
        microentrepreneur_opted_at:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data da opção pelo MEI.
        personal_data_anonymized:
          type: boolean
          description: Indica anonimização de campos pessoais a pedido do titular (LGPD).
        officers:
          type: array
          items:
            type: object
            properties:
              object:
                type: string
                const: officer
                description: 'Tipo do objeto: sócio ou administrador.'
              document:
                type: string
                minLength: 1
                description: CPF ou CNPJ informado pela fonte; pode estar mascarado.
              name:
                type: string
                description: Nome do sócio ou administrador.
              qualification:
                type: string
                description: Qualificação societária.
              joined_at:
                type: string
                format: date
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                description: Data de entrada na sociedade, em YYYY-MM-DD.
              ownership_percent:
                type: number
                description: Participação percentual informada pela fonte.
              person_type:
                type: string
                description: Tipo de pessoa do sócio.
              age_range:
                type: string
                description: Faixa etária do sócio.
              country_code:
                type: string
                description: Código do país do sócio.
              country:
                type: string
                description: País do sócio.
              representative_document:
                type: string
                description: >-
                  Documento mascarado do representante legal, conforme
                  publicado.
              representative_name:
                type: string
                description: Nome do representante legal.
              representative_qualification:
                type: object
                properties:
                  object:
                    type: string
                    const: code_description
                    description: Tipo do objeto Base39.
                  code:
                    type: string
                    description: Código de identificação.
                  description:
                    type: string
                    description: Descrição informada.
                required:
                  - object
                additionalProperties: false
                description: Qualificação do representante legal.
            required:
              - object
            additionalProperties: false
          description: Sócios e administradores, com CPF mascarado para pessoas físicas.
        city_code:
          type: string
          description: Código do município cadastral.
        country_code:
          type: string
          description: Código do país cadastral.
        activities:
          type: array
          items:
            type: object
            properties:
              object:
                type: string
                const: business_activity
                description: Tipo do objeto Base39.
              code:
                type: string
                description: Código de identificação.
              description:
                type: string
                description: Descrição informada.
              is_primary:
                type: boolean
                description: Indica a atividade econômica principal.
            required:
              - object
            additionalProperties: false
          description: >-
            Atividades econômicas com código, descrição e indicação da atividade
            principal.
        responsible_qualification:
          type: object
          properties:
            object:
              type: string
              const: code_description
              description: Tipo do objeto Base39.
            code:
              type: string
              description: Código de identificação.
            description:
              type: string
              description: Descrição informada.
          required:
            - object
          additionalProperties: false
          description: Qualificação do responsável pela empresa.
        federative_entity:
          type: string
          description: Ente federativo responsável.
        simple_tax_excluded_at:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data de exclusão do Simples Nacional.
        microentrepreneur_excluded_at:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data de exclusão do MEI.
        registration_status_reason:
          type: object
          properties:
            object:
              type: string
              const: code_description
              description: Tipo do objeto Base39.
            code:
              type: string
              description: Código de identificação.
            description:
              type: string
              description: Descrição informada.
          required:
            - object
          additionalProperties: false
          description: Motivo da situação cadastral.
        foreign_city:
          type: string
          description: Nome da cidade no exterior.
        special_status:
          type: string
          description: Situação especial informada no cadastro.
        special_status_date:
          type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: Data da situação especial.
        updated_at:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          description: Data e hora da última atualização publicada, em ISO 8601.
      required:
        - object
        - document
        - legal_name
        - updated_at
      additionalProperties: false
    error:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - balance_error
                - api_error
              description: Categoria estável da falha.
            code:
              type: string
              pattern: ^[a-z][a-z0-9_]*$
              description: Código estável da falha para tratamento pela aplicação.
            message:
              type: string
              description: Descrição da falha em português brasileiro.
            param:
              description: Parâmetro relacionado à falha, quando aplicável.
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
          description: Falha que impediu a operação.
      required:
        - error
      additionalProperties: false
  responses:
    error_400:
      description: Parâmetros inválidos.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Parâmetros inválidos.
              value:
                error:
                  type: invalid_request_error
                  code: invalid_request
                  message: Revise os parâmetros da requisição.
    error_401:
      description: Autenticação ausente ou inválida.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Autenticação ausente ou inválida.
              value:
                error:
                  type: authentication_error
                  code: unauthorized
                  message: Autenticação necessária.
    error_402:
      description: Saldo insuficiente para a consulta.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Saldo insuficiente para a consulta.
              value:
                error:
                  type: balance_error
                  code: insufficient_balance
                  message: Saldo insuficiente para realizar a consulta.
    error_403:
      description: Acesso não permitido.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Acesso não permitido.
              value:
                error:
                  type: permission_error
                  code: forbidden
                  message: Acesso não permitido.
    error_404:
      description: Operação ou resultado não encontrado.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Operação ou resultado não encontrado.
              value:
                error:
                  type: invalid_request_error
                  code: resource_not_found
                  message: Nenhum registro encontrado.
    error_405:
      description: Método HTTP não permitido.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Método HTTP não permitido.
              value:
                error:
                  type: invalid_request_error
                  code: method_not_allowed
                  message: Método HTTP não permitido para esta operação.
    error_409:
      description: Consulta equivalente em andamento.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
        Retry-After:
          description: Tempo em segundos antes de uma nova tentativa.
          schema:
            type: integer
            minimum: 1
          example: 2
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Consulta equivalente em andamento.
              value:
                error:
                  type: invalid_request_error
                  code: query_in_progress
                  message: Uma consulta equivalente está em andamento.
    error_413:
      description: Corpo da requisição acima do limite permitido para a operação.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Corpo da requisição acima do limite permitido para a operação.
              value:
                error:
                  type: invalid_request_error
                  code: request_too_large
                  message: A requisição excedeu o limite permitido.
    error_415:
      description: O corpo deve usar application/json.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: O corpo deve usar application/json.
              value:
                error:
                  type: invalid_request_error
                  code: unsupported_media_type
                  message: Envie o corpo como application/json.
    error_422:
      description: Integração ou parâmetros específicos indisponíveis.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Integração ou parâmetros específicos indisponíveis.
              value:
                error:
                  type: invalid_request_error
                  code: integration_not_configured
                  message: A integração necessária não está configurada na organização.
    error_425:
      description: Resultado temporariamente indisponível para leitura.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
        Retry-After:
          description: Tempo em segundos antes de uma nova tentativa.
          schema:
            type: integer
            minimum: 1
          example: 2
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Resultado temporariamente indisponível para leitura.
              value:
                error:
                  type: invalid_request_error
                  code: cache_propagating
                  message: O resultado está sendo disponibilizado. Tente novamente.
    error_502:
      description: Resposta inválida ao executar a consulta.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Resposta inválida ao executar a consulta.
              value:
                error:
                  type: api_error
                  code: query_unavailable
                  message: Não foi possível concluir a consulta.
    error_503:
      description: Serviço temporariamente indisponível.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
        Retry-After:
          description: Tempo em segundos antes de uma nova tentativa.
          schema:
            type: integer
            minimum: 1
          example: 2
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Serviço temporariamente indisponível.
              value:
                error:
                  type: api_error
                  code: query_unavailable
                  message: Não foi possível concluir a consulta.
    error_504:
      description: Prazo de execução excedido.
      headers:
        Request-Id:
          description: Identificador da requisição para suporte e rastreamento.
          schema:
            type: string
          example: req_example
        Cache-Control:
          description: >-
            As respostas autenticadas não devem ser armazenadas por serviços
            HTTP compartilhados.
          schema:
            type: string
            const: no-store
          example: no-store
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            erro:
              summary: Prazo de execução excedido.
              value:
                error:
                  type: api_error
                  code: query_timeout
                  message: A consulta excedeu o prazo de execução.
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Credencial OAuth da Base39 com os escopos profile e user:org:read, ou
        chave de API pertencente à organização. A organização e o autor são
        obtidos da autenticação.

````

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