Dabra Rural API

openapi: 3.2.0
info:
  title: Dabra Rural API
  version: v1
  description: 'API pública Dabra — consulta de dados. Toda conta tem uma chave de teste (`dabra_test_...`) que devolve o exemplo de cada endpoint a custo zero, marcado com o header X-Example: true — a validação de parâmetros é a mesma da produção.'
servers:
- url: https://app.dabradata.com
security:
- ApiKeyAuth: []
tags:
- name: Rural
paths:
  /api/v1/consulta/agricultura-familiar-pf:
    get:
      summary: Agricultura Familiar — PF (CAF)
      description: 'Consulta, pelo CPF, a inscrição de uma pessoa física no Cadastro Nacional da Agricultura Familiar (CAF) — o registro que sucedeu a DAP — trazendo a situação da inscrição, o enquadramento no PRONAF, dados do estabelecimento rural e a composição familiar.


        Quando nada consta para os parâmetros informados, a resposta é `200` com corpo `{"consta": false, "mensagem": "...", "parametros": {...}}` — resultado negativo autoritativo, cobrado normalmente. O `404` fica restrito a recurso inexistente.'
      operationId: agricultura-familiar-pf
      tags:
      - Rural
      parameters:
      - name: cpf
        in: query
        required: true
        description: CPF (somente números, 11 dígitos)
        schema:
          type: string
          format: cpf
        example: SEU_CPF
      - name: comprovante
        in: query
        required: false
        description: Inclui o comprovante da consulta (link válido por 7 dias). Acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue.
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Sucesso (inclui resultado negativo)
          content:
            application/json:
              schema:
                type: object
                properties:
                  comprovante:
                    type: array
                    description: 'Comprovante da consulta: o documento emitido pela fonte, num link aberto para você guardar. Só vem quando você pede com o parâmetro `comprovante` (acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue). O link vale por 7 dias a partir da emissão e o arquivo pode levar alguns segundos para ficar disponível. Chave opcional: leia como ausente quando não vier.'
                    items:
                      type: string
                      format: uri
              example:
                uf: null
                cpf: '***'
                situacao: Não encontrado
                municipio: null
                numeroCaf: null
                cadastrador: null
                dataEmissao: null
                cnpjEntidade: null
                dataValidade: null
                dataInscricao: null
                condicaoPosseUso: null
                ultimaAtualizacao: null
                atividadePrincipal: null
                caracterizacaoUFPA: null
                composicaoFamiliar: []
                formasAssociativas: []
                enquadramentoPRONAF: null
                entidadeResponsavel: null
                numImoveisExplorados: 0
                tamanhoImovelPrincipal: null
                totalEstabelecimentoHA: 0
                totalEstabelecimentoM2: 0
                comprovante:
                - https://arquivos.dabradata.com/comprovantes/cpv_01J8Z3K9X2
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      x-empty-as-negative: true
  /api/v1/consulta/agricultura-familiar-pj:
    get:
      summary: Agricultura Familiar — PJ (CAF)
      description: 'Consulta, pelo CNPJ, a inscrição de uma pessoa jurídica (cooperativa, associação ou empreendimento familiar rural) no Cadastro Nacional da Agricultura Familiar (CAF), com situação do registro, dados constitutivos, composição societária e distribuição de sócios por município.


        Quando nada consta para os parâmetros informados, a resposta é `200` com corpo `{"consta": false, "mensagem": "...", "parametros": {...}}` — resultado negativo autoritativo, cobrado normalmente. O `404` fica restrito a recurso inexistente.'
      operationId: agricultura-familiar-pj
      tags:
      - Rural
      parameters:
      - name: cnpj
        in: query
        required: true
        description: CNPJ (somente números, 14 dígitos)
        schema:
          type: string
          format: cnpj
        example: SEU_CNPJ
      responses:
        '200':
          description: Sucesso (inclui resultado negativo)
          content:
            application/json:
              schema:
                type: object
              example:
                uf: null
                cnpj: '***'
                emissor: null
                situacao: Não encontrado
                municipio: null
                numeroCaf: null
                cadastrador: null
                dataEmissao: null
                razaoSocial: null
                cnpjEntidade: null
                dataValidade: null
                dataInscricao: null
                cpfRepresentante: null
                dataConstituicao: null
                dataUltimoExtrato: null
                ultimaAtualizacao: null
                representanteLegal: null
                sociosPorMunicipio: []
                tipoPessoaJuridica: null
                entidadeResponsavel: null
                composicaoSocietaria: []
                dataUltimoUploadAssociados: null
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      x-empty-as-negative: true
  /api/v1/consulta/apf-rural:
    get:
      summary: Autorização Provisória de Funcionamento Rural
      description: 'Realiza consultas sobre Autorização Provisória de Funcionamento Rural (APF), verificando dados de propriedades agrícolas para conformidade ambiental e análise de risco.


        Obrigatório informar pelo menos um de: cpf ou cnpj.


        Quando nada consta para os parâmetros informados, a resposta é `200` com corpo `{"consta": false, "mensagem": "...", "parametros": {...}}` — resultado negativo autoritativo, cobrado normalmente. O `404` fica restrito a recurso inexistente.'
      operationId: apf-rural
      tags:
      - Rural
      parameters:
      - name: cpf
        in: query
        required: false
        description: CPF (somente números, 11 dígitos)
        schema:
          type: string
          format: cpf
        example: SEU_CPF
      - name: cnpj
        in: query
        required: false
        description: CNPJ (somente números, 14 dígitos)
        schema:
          type: string
          format: cnpj
        example: SEU_CNPJ
      responses:
        '200':
          description: Sucesso (inclui resultado negativo)
          content:
            application/json:
              schema:
                type: object
              example:
                observacoes: Foi encontrado um resultado compatível com a pesquisa.
                autorizacoes:
                - apf: 12345/2021
                  car: MT12345/2019
                  imovel: FAZENDA EXEMPLO DO CERRADO
                  status: REGULAR
                  atividade: Agricultura e Pecuária
                  municipio: Sorriso
                  dataEmissao: 10/05/2021
                  responsavel:
                    nome: JOAO EXEMPLO DE OLIVEIRA
                    documento: 111.111.111-11
                  situacaoCAR: REGULAR
                  dataValidade: 31/12/2027
                  proprietario:
                    nome: AGROPECUARIA EXEMPLO LTDA
                    documento: '11111111000111'
                  informacoesAdicionais:
                    areaTotal: 12.450,3200 ha
                    coordenadas: 'DATUM:SIRGAS 2000 - W: -55,11111111111001 - S: -12,3456789012345678'
                    areaUtilizada: 3.200,1000 ha
                documentoConsultado: 11.111.111/0001-11
                quantidadeAutorizacoes: 1
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      x-one-of-groups:
      - - cpf
        - cnpj
      x-empty-as-negative: true
  /api/v1/consulta/car-ambiental:
    get:
      summary: Cadastro Ambiental Rural (CAR)
      description: Permite consultar informações detalhadas de imóveis rurais no Cadastro Ambiental Rural, incluindo dados sobre áreas de preservação, vegetação nativa e situação ambiental.
      operationId: car-ambiental
      tags:
      - Rural
      parameters:
      - name: numero_car
        in: query
        required: true
        description: 'Número de inscrição do imóvel no Cadastro Ambiental Rural (CAR), no formato UF-código do município-código alfanumérico (ex.: SP-3550308-...).'
        schema:
          type: string
          format: upper
      - name: comprovante
        in: query
        required: false
        description: Inclui o comprovante da consulta (link válido por 7 dias). Acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue.
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  comprovante:
                    type: array
                    description: 'Comprovante da consulta: o documento emitido pela fonte, num link aberto para você guardar. Só vem quando você pede com o parâmetro `comprovante` (acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue). O link vale por 7 dias a partir da emissão e o arquivo pode levar alguns segundos para ficar disponível. Chave opcional: leia como ausente quando não vier.'
                    items:
                      type: string
                      format: uri
              example:
                app:
                  area: string
                  recompor: string
                  ruralConsolidada: string
                  remanescenteVegetacaoNativa: string
                dadosImovel:
                  uf: string
                  area: string
                  latitude: string
                  longitude: string
                  municipio: string
                  dataInscricao: string
                  modulosFiscais: string
                  dataUltimaRetificacao: string
                usoRestrito:
                  area: string
                  recompor: string
                inscricaoCAR: string
                reservaLegal:
                  averbada: string
                  proposta: string
                  recompor: string
                  declarada: string
                  localizacao: string
                  averbadaArt30: string
                  passivoExcedente: string
                  aprovadaNaoAverbada: string
                coberturaSolo:
                  vegetacaoNativa: string
                  ruralConsolidada: string
                  servidaoAdministrativa: string
                condicaoExterna: string
                situacaoCadastro: string
                informacoesAdicionais: []
                comprovante:
                - https://arquivos.dabradata.com/comprovantes/cpv_01J8Z3K9X2
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
  /api/v1/consulta/cafir-imoveis:
    get:
      summary: Cadastro de Imóveis Rurais (CAFIR)
      description: Endpoint para consultar imóveis rurais no cadastro federal. Retorna informações do imóvel, titulares, condôminos e dados cadastrais completos.
      operationId: cafir-imoveis
      tags:
      - Rural
      parameters:
      - name: cib
        in: query
        required: true
        description: Código de Identificação do Imóvel (CIB) no Cadastro de Imóveis Rurais. Aceita com ou sem formatação.
        schema:
          type: string
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
  /api/v1/consulta/incra-ccir:
    get:
      summary: Incra CCIR
      description: 'Emite o CCIR (Certificado de Cadastro de Imóvel Rural) no SNCR/INCRA pelo código do imóvel, município sede e CPF ou CNPJ do declarante: área, classificação fundiária, módulos, registros em cartório, CIB, CAR, titulares e situação da taxa, com o PDF oficial como comprovante.


        Obrigatório informar pelo menos um de: cpf ou cnpj.


        Envie no máximo um de: cpf ou cnpj — cada consulta responde sobre um único documento.'
      operationId: incra-ccir
      tags:
      - Rural
      parameters:
      - name: codigo_imovel
        in: query
        required: true
        description: 'Codigo do imovel rural no SNCR/INCRA, com 13 digitos (ex.: 950.025.574.767-9). Aceita com ou sem pontuacao.'
        schema:
          type: string
          pattern: ^[^0-9]*([0-9][^0-9]*){13}$
      - name: uf
        in: query
        required: true
        description: 'UF do municipio sede do imovel (sigla, ex.: GO).'
        schema:
          type: string
          format: upper
          enum:
          - AC
          - AL
          - AM
          - AP
          - BA
          - CE
          - DF
          - ES
          - GO
          - MA
          - MG
          - MS
          - MT
          - PA
          - PB
          - PE
          - PI
          - PR
          - RJ
          - RN
          - RO
          - RR
          - RS
          - SC
          - SE
          - SP
          - TO
        example: SP
      - name: municipio
        in: query
        required: true
        description: 'Municipio sede do imovel, pelo nome (ex.: Rio Verde). Acentos e maiusculas nao importam.'
        schema:
          type: string
      - name: cpf
        in: query
        required: false
        description: CPF do titular DECLARANTE do imovel. Informe o CPF ou o CNPJ (um dos dois).
        schema:
          type: string
          format: cpf
          pattern: ^[0-9]{11}$
      - name: cnpj
        in: query
        required: false
        description: CNPJ do titular DECLARANTE do imovel (numerico ou alfanumerico). Informe o CPF ou o CNPJ (um dos dois).
        schema:
          type: string
          format: cnpj
        example: SEU_CNPJ
      - name: natureza_juridica
        in: query
        required: false
        description: 'OPCIONAL, so para CNPJ: natureza juridica do titular como na Receita Federal (ex.: Sociedade Empresaria Limitada). Sem ela, resolvemos pelo proprio CNPJ.'
        schema:
          type: string
      - name: comprovante
        in: query
        required: false
        description: Inclui o comprovante da consulta (link válido por 7 dias). Acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue.
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  comprovante:
                    type: array
                    description: 'Comprovante da consulta: o documento emitido pela fonte, num link aberto para você guardar. Só vem quando você pede com o parâmetro `comprovante` (acréscimo de 25% sobre o preço da consulta, cobrado somente quando o comprovante é entregue). O link vale por 7 dias a partir da emissão e o arquivo pode levar alguns segundos para ficar disponível. Chave opcional: leia como ausente quando não vier.'
                    items:
                      type: string
                      format: uri
              example:
                car: GO-5218805-0A1B2C3D4E5F6A7B8C9D0E1F2A3B4C5D
                cib: 1234567-8
                juros: 0.0
                multa: 0.0
                ufSede: GO
                exercicio: '2025'
                registros:
                - areaHa: 486.3021
                  registro: R-4
                  cnsOficio: 02.567-3
                  livroFicha: '2'
                  dataRegistro: 10/05/1998
                  ufMunicipioCartorio: GO/RIO VERDE
                  matriculaTranscricao: '12345'
                titulares:
                - nome: MARIA DA SILVA EXEMPLO
                  condicao: Proprietário ou Posseiro Comum
                  documento: 111.444.777-35
                  detencaoPercentual: 50.0
                - nome: JOÃO DA SILVA EXEMPLO
                  condicao: Proprietário ou Posseiro Comum
                  documento: 222.333.444-05
                  detencaoPercentual: 50.0
                declarante:
                  nome: MARIA DA SILVA EXEMPLO
                  documento: 111.444.777-35
                  nacionalidade: BRASILEIRA
                numeroCcir: '52610123456'
                valorTotal: 38.27
                areaTotalHa: 486.3021
                dataEmissao: 04/11/2026
                denominacao: Fazenda Boa Esperança
                imovelAtivo: true
                observacoes:
                - ESTE DOCUMENTO SÓ TEM VALIDADE APÓS A QUITAÇÃO DA DEVIDA TAXA.
                areaMedidaHa: null
                codigoImovel: 950.000.123.456-7
                situacaoCcir: CCIR Quitado
                valorCobrado: 38.27
                moduloRuralHa: 32.5
                municipioSede: RIO VERDE
                dataLancamento: 15/07/2025
                dataVencimento: null
                emissaoInibida: false
                instrucoesTaxa:
                - O PRESENTE DOCUMENTO SÓ PODERÁ SER PAGO NO BANCO DO BRASIL.
                - O CCIR COM A TAXA DE SERVIÇOS CADASTRAIS NÃO QUITADA ATÉ A DATA DE VENCIMENTO DEVERÁ SER REEMITIDO, PARA ATUALIZAÇÃO DOS CÁLCULOS DE MULTA E JUROS - LEIS 8.022/90, 8.847/94 E 8.383/91.
                - O CCIR SÓ É VÁLIDO COM A QUITAÇÃO DA TAXA.
                moduloFiscalHa: 30.0
                esclarecimentos:
                - ESTE CERTIFICADO É DOCUMENTO INDISPENSÁVEL PARA DESMEMBRAR, ARRENDAR, HIPOTECAR, VENDER OU PROMETER EM VENDA O IMÓVEL RURAL E PARA HOMOLOGAÇÃO DE PARTILHA AMIGÁVEL OU JUDICIAL "SUCESSÃO CAUSA MORTIS", DE ACORDO COM OS PARÁGRAFOS 1º e 2º DO ARTIGO 22 DA LEI 4.947/66.
                - AS INFORMAÇÕES DESTE CERTIFICADO SÃO EXCLUSIVAMENTE CADASTRAIS, NÃO LEGITIMANDO DIREITO DE DOMÍNIO OU POSSE, CONFORME PRECEITUA O ARTIGO 3º DA LEI 5.868/72.
                - ÁREA CERTIFICADA CONFORME DISPOSTO NA LEI 10.267/01 E SUAS ALTERAÇÕES.
                areaRegistradaHa: 486.3021
                areaCertificadaHa: 486.3
                debitosAnteriores: 0.0
                situacaoPagamento: Quitado
                numeroAutenticidade: 12345.67890.12345.67890
                numeroModulosRurais: 14.96
                dataUltimaDeclaracao: 12/03/2024
                numeroModulosFiscais: 16.21
                certificadoDisponivel: true
                indicacoesLocalizacao: ROD GO 174 KM 32, À ESQUERDA 8 KM
                areaPosseJustoTituloHa: 0.0
                classificacaoFundiaria: Média Propriedade Produtiva
                taxaServicosCadastrais: 38.27
                totalPessoasRelacionadas: 2
                areaPosseSimplesOcupacaoHa: 0.0
                classificacaoFundiariaNota: null
                fracaoMinimaParcelamentoHa: 2.0
                comprovante:
                - https://arquivos.dabradata.com/comprovantes/cpv_01J8Z3K9X2
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '402':
          $ref: '#/components/responses/Error402'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
      x-one-of-groups:
      - - cpf
        - cnpj
      x-at-most-one-groups:
      - - cpf
        - cnpj
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Error402:
      description: Saldo insuficiente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error401:
      description: Não autenticado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error400:
      description: Parâmetros inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: Limite de requisições excedido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: Erro interno
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key