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

# Certidões

> Consulta uma das 20 certidões disponíveis. Para municipal_debt, informe municipality e municipal_registration; state_court exige state e type; federal_court exige court e type; labor_court e mpt exigem court; sintegra exige state; criminal_state exige state e identity_number. Os demais parâmetros dependem da certidão e do documento; uma resposta em processamento não comprova regularidade.



## OpenAPI

````yaml /api-reference/openapi.json post /v3/queries/get_certificate
openapi: 3.1.2
info:
  title: API Base39
  version: 3.0.0
  description: >-
    Contratos canônicos Base39 compartilhados entre API e MCP. 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: Consultas
    description: Consultas canônicas de dados.
  - 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/queries/get_certificate:
    post:
      tags:
        - Consultas
      summary: Certidões
      description: >-
        Consulta uma das 20 certidões disponíveis. Para municipal_debt, informe
        municipality e municipal_registration; state_court exige state e type;
        federal_court exige court e type; labor_court e mpt exigem court;
        sintegra exige state; criminal_state exige state e identity_number. Os
        demais parâmetros dependem da certidão e do documento; uma resposta em
        processamento não comprova regularidade.
      operationId: get_certificate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/get_certificate_request'
            examples:
              requisicao:
                summary: Parâmetros da consulta.
                value:
                  document: '00000000000191'
                  certificate: tst
      responses:
        '200':
          description: >-
            Objeto ou coleção Base39; coleções integrais não possuem
            next_cursor.
          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_certificate_response'
              examples:
                resposta:
                  summary: Exemplo de resposta Base39.
                  value:
                    object: list
                    data:
                      - id: certificate_621317f5571c23137977f637
                        object: certificate
                        document: '00000000000191'
                        certificate_type: tst
                        status: NAO CONSTA
                        number: CERT-EXAMPLE
                        expires_at: '2027-04-26'
        '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_certificate_request:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        document:
          description: CPF ou CNPJ completo, com ou sem pontuação.
          title: CPF ou CNPJ
          type: string
          pattern: >-
            ^(?:\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2}|[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})$
        certificate:
          type: string
          enum:
            - cnpj
            - sit
            - tst
            - fgts
            - pgfn
            - state_debt_absence
            - municipal_debt
            - state_court
            - federal_court
            - labor_court
            - mpt
            - criminal_federal
            - criminal_state
            - ibama_negative
            - ibama_embargo
            - ibama_regularity
            - comex
            - siproquim
            - cgu
            - sintegra
          title: Certidão
          description: >-
            Tipo de certidão a consultar; a disponibilidade depende de CPF ou
            CNPJ.
        parameters:
          default: {}
          description: Parâmetros adicionais exigidos pela certidão selecionada.
          type: object
          properties:
            state:
              description: Sigla da unidade federativa, com duas letras maiúsculas.
              type: string
              pattern: ^[A-Z]{2}$
            city:
              description: Nome do município usado na consulta da certidão.
              type: string
              minLength: 1
              maxLength: 120
            name:
              description: Nome completo da pessoa ou razão social da empresa consultada.
              type: string
              minLength: 1
              maxLength: 200
            birth_date:
              description: Data de nascimento no formato exigido pela certidão selecionada.
              type: string
              maxLength: 10
            mother_name:
              description: Nome completo da mãe.
              type: string
              maxLength: 200
            father_name:
              description: Nome completo do pai.
              type: string
              maxLength: 200
            gender:
              description: Gênero conforme os valores aceitos pela certidão selecionada.
              type: string
              maxLength: 30
            identity_issue_state:
              description: Sigla da UF de emissão do documento de identidade.
              type: string
              pattern: ^[A-Z]{2}$
            identity_issue_agency:
              description: Órgão emissor do documento de identidade.
              type: string
              maxLength: 40
            identity_issued_at:
              description: >-
                Data de emissão do documento de identidade no formato exigido
                pela certidão.
              type: string
              maxLength: 10
            birth_place:
              description: Local de nascimento informado no documento de identidade.
              type: string
              maxLength: 120
            date_format:
              description: Formato usado nas datas informadas para a certidão.
              type: string
              maxLength: 30
            municipality:
              type: string
              maxLength: 140
              description: 'Município-UF, por exemplo: São Paulo-SP.'
            municipal_registration:
              description: >-
                Número da inscrição municipal; exigido na certidão
                municipal_debt.
              type: string
              maxLength: 40
            address_state:
              description: Sigla da UF do endereço da pessoa ou empresa consultada.
              type: string
              pattern: ^[A-Z]{2}$
            active_debt:
              description: >-
                Opção de consulta à dívida ativa aceita pela certidão; aplicável
                ao estado de São Paulo.
              type: string
              maxLength: 20
            identity_number:
              description: >-
                Número do documento de identidade; exigido na certidão
                criminal_state.
              type: string
              maxLength: 30
            state_registration:
              description: Número da inscrição estadual da empresa.
              type: string
              maxLength: 30
            court:
              description: Tribunal ou região exigido pela certidão selecionada.
              type: string
              maxLength: 50
            type:
              description: >-
                Modalidade da certidão, conforme os valores aceitos pelo
                tribunal selecionado.
              type: string
              maxLength: 80
            zip_code:
              description: CEP do endereço consultado.
              type: string
              maxLength: 9
            street:
              description: Nome do logradouro, sem o número.
              type: string
              maxLength: 200
            street_type:
              description: Tipo do logradouro, como rua ou avenida.
              type: string
              maxLength: 40
            number:
              description: Número do imóvel no endereço consultado.
              type: string
              maxLength: 30
            neighborhood:
              description: Bairro do endereço consultado.
              type: string
              maxLength: 120
          additionalProperties: false
      required:
        - document
        - certificate
      additionalProperties: false
      allOf:
        - if:
            properties:
              certificate:
                const: municipal_debt
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - municipality
                  - municipal_registration
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: state_court
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - state
                  - type
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: federal_court
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - court
                  - type
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: labor_court
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - court
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: mpt
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - court
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: sintegra
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - state
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
        - if:
            properties:
              certificate:
                const: criminal_state
                description: Modalidade selecionada de certidão.
            required:
              - certificate
          then:
            properties:
              parameters:
                required:
                  - state
                  - identity_number
                description: Parâmetros obrigatórios para a modalidade selecionada.
            required:
              - parameters
    get_certificate_response:
      $schema: https://json-schema.org/draft/2020-12/schema
      anyOf:
        - $ref: '#/components/schemas/get_company_response'
        - type: object
          properties:
            id:
              type: string
              minLength: 1
              description: Identificador opaco e estável do objeto Base39.
            object:
              type: string
              const: certificate
              description: 'Tipo do objeto: certidão.'
            document:
              type: string
              minLength: 1
              description: CPF ou CNPJ informado pela fonte; pode estar mascarado.
            certificate_type:
              type: string
              description: Identificador da modalidade de certidão solicitada.
            status:
              type: string
              description: Situação textual informada na certidão.
            number:
              type: string
              description: Número ou protocolo da certidão.
            issued_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 emissão, em YYYY-MM-DD.
            expires_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 validade, em YYYY-MM-DD.
            has_occurrences:
              type: boolean
              description: Indicação de ocorrências na certidão.
            has_lawsuits:
              type: boolean
              description: Indicação de processos na certidão.
            validation_code:
              type: string
              description: Código de validação informado pela fonte.
          required:
            - id
            - object
            - document
            - certificate_type
          additionalProperties: false
        - type: object
          properties:
            object:
              type: string
              const: list
              description: Coleção de objetos Base39.
            data:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    description: Identificador opaco e estável do objeto Base39.
                  object:
                    type: string
                    const: certificate
                    description: 'Tipo do objeto: certidão.'
                  document:
                    type: string
                    minLength: 1
                    description: CPF ou CNPJ informado pela fonte; pode estar mascarado.
                  certificate_type:
                    type: string
                    description: Identificador da modalidade de certidão solicitada.
                  status:
                    type: string
                    description: Situação textual informada na certidão.
                  number:
                    type: string
                    description: Número ou protocolo da certidão.
                  issued_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 emissão, em YYYY-MM-DD.
                  expires_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 validade, em YYYY-MM-DD.
                  has_occurrences:
                    type: boolean
                    description: Indicação de ocorrências na certidão.
                  has_lawsuits:
                    type: boolean
                    description: Indicação de processos na certidão.
                  validation_code:
                    type: string
                    description: Código de validação informado pela fonte.
                required:
                  - id
                  - object
                  - document
                  - certificate_type
                additionalProperties: false
              description: Objetos da coleção.
            next_cursor:
              description: Cursor opaco da próxima página; ausente ao final.
              type: string
          required:
            - object
            - data
          additionalProperties: false
      type: object
    get_company_response:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        id:
          type: string
          minLength: 1
          description: Identificador opaco e estável do objeto Base39.
        object:
          type: string
          const: company
          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
      required:
        - id
        - object
        - document
        - legal_name
      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.