Status ESG por CAR

Descrição: Trazer informações resumidas sobre o status de elegibilidade/compliance de uma propriedade/fazenda a partir de um código CAR (Cadastro Ambiental Rural) específico.

Qual endpoint usar: este retorna apenas as camadas habilitadas no template ESG da sua cooperativa — o array issues varia conforme esse template. O consolidado com todas as camadas de análise, com um campo fixo por camada, é devolvido por outro endpoint.

Endpoint

GET/api/v1/integration/environmental-embargoes/status-esg/property

Regras

Atributos	Descrição	Tipo	Obrigatório
property_code	Código CAR do imóvel	string	Sim

Importante: não envie o header cooperative-id. Ele é injetado automaticamente pelo API gateway (Kong + plugin merx-custom-auth) resolvendo o owner do token. Qualquer valor enviado pelo cliente é ignorado ou sobrescrito.

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/environmental-embargoes/status-esg/property?property_code=MT-5107925-A1B2C3D4E5F6"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/environmental-embargoes/status-esg/property?property_code=MT-5107925-A1B2C3D4E5F6"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/environmental-embargoes/status-esg/property?property_code=MT-5107925-A1B2C3D4E5F6',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/environmental-embargoes/status-esg/property"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

params = {
    "property_code": "MT-5107925-A1B2C3D4E5F6",
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

O SDK Java não cobre este endpoint — os métodos de merx.esg() atendem o resumo ESG consolidado, que é outra rota. Para este, faça a chamada HTTP direta como nos exemplos acima.

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Parâmetros de Query

Nome	Descrição	Tipo	Obrigatório
property_code	Código CAR do imóvel	String	Sim

Dicionário de dados

Nome	Descrição	Tipo
cooperative_id	ID da cooperativa	UUID
property_code	Código CAR do imóvel consultado	String
issues	Lista de apontamentos agrupados por tipo de embargo	Array
issues[].embargo_type	Tipo do embargo/camada de análise	String
issues[].total_issues	Total de apontamentos para o tipo de embargo	Number
total_issues	Total geral de apontamentos da propriedade	Number
esg_status	Status consolidado de conformidade socioambiental. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"	Enum
area	Área do imóvel (ha)	Number
city	Município do imóvel	String
state	UF do imóvel	String
car_status	Situação do CAR. Valores: "AT" (Ativo), "CA" (Cancelado), "SU" (Suspenso), "PE" (Pendente)	Enum
car_status_updated_at	Data da última atualização da situação do CAR, em epoch com segundos decimais	Number

Respostas

• 200 - Ok

{
  "cooperative_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "property_code": "MT-5107925-A1B2C3D4E5F6",
  "issues": [
    {
      "embargo_type": "PRODES",
      "total_issues": 0
    }
  ],
  "total_issues": 0,
  "esg_status": "CONFORME",
  "area": 259.48,
  "city": "Sorriso",
  "state": "MT",
  "car_status": "AT",
  "car_status_updated_at": 1714532400.000000000
}

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized

• 404 - NotFound