Gerar Relatório Socioambiental

Descrição: Gera um relatório pré-invoice de compliance socioambiental (ESG) a partir de um CAR, de forma síncrona. O relatório é processado por completo e retornado na mesma resposta HTTP, com timeout máximo de 30 segundos.

Endpoint

POST/api/v1/integration/socioambiental

Regras

Atributos	Descrição	Tipo	Obrigatório
car	Código CAR do imóvel	String	Sim
producer_name	Nome do produtor	String	Sim
producer_document	CPF ou CNPJ do produtor	String	Sim

Exemplo de Requisição

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
-d '{
    "car": "MG-3135209-56FC399E093348DDBFECABA544B54904",
    "producer_name": "Nome do Produtor",
    "producer_document": "00000000000"
}'\
"https://homolog.api.merx.tech/api/v1/integration/socioambiental"

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization		String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
car	Código CAR do imóvel	String	Sim
producer_name	Nome do produtor	String	Sim
producer_document	CPF ou CNPJ do produtor	String	Sim

Dicionário de dados

Nome	Descrição	Tipo
status	Status do processamento do relatório. Valores: "GENERATED", "PROCESSING", "GENERATING_REPORT", "UPDATING_CAR", "ERROR", "ERROR_TIMEOUT", "ERROR_UPDATING"	Enum
processing_date	Data de processamento do relatório	DateTime
created_at	Data de criação do relatório	DateTime
report_request_id	Identificador único do relatório gerado	UUID
cooperative_id	ID da cooperativa	UUID
cooperative_name	Nome da cooperativa	String
commitment_id	ID da negociação vinculada (quando aplicável)	UUID
report_integration_id	ID de integração do relatório	UUID
esg_status_summary	Status consolidado de conformidade socioambiental. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"	Enum
esg_status_farms	Status consolidado das fazendas. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"	Enum
is_summary_report	Indica se é um relatório resumido	Boolean
extracted_related_farms	Indica se fazendas relacionadas foram extraídas	Boolean
prodes_source	Fonte do PRODES utilizada. Valores: "AMAZONIA_LEGAL", "BIOMA_AMAZONIA"	Enum
producer_data	Dados do produtor	Object
producer_data.producer_id	ID do produtor	UUID
producer_data.document	CPF ou CNPJ do produtor	String
producer_data.name	Nome do produtor	String
producer_data.dap_code	Código DAP	String
producer_data.caf_code	Código CAF	String
producer_data.ricaf_code	Código RiCAF	String
producer_data_esg	Dados ESG do produtor	Object
producer_data_esg.document	CPF ou CNPJ	String
producer_data_esg.name	Nome do produtor	String
producer_data_esg.total_issues	Total de apontamentos do produtor	Number
producer_data_esg.esg_status	Status ESG do produtor. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"	Enum
layer_data_producer	Camadas de análise do produtor	Array
layer_data_producer.layer_name	Nome da camada/órgão fiscalizador	String
layer_data_producer.esg_status	Status ESG da camada	Enum
layer_data_producer.total_area	Área total afetada	Number
layer_data_producer.total_issues	Total de apontamentos na camada	Number
layer_data_producer.layer_columns	Colunas de dados da camada	Array
layer_data_producer.items	Detalhes dos apontamentos	Array
layer_data_producer.items.item_values	Valores do apontamento (conforme layer_columns)	Array
esg	Lista de resultados por propriedade (CAR)	Array
esg.id_report	ID do relatório da propriedade	UUID
esg.farm_id	ID da fazenda	UUID
esg.property_data	Dados da propriedade	Object
esg.property_data.farm_name	Nome da fazenda	String
esg.property_data.car	Código CAR	String
esg.property_data.area	Área do imóvel (ha)	Number
esg.property_data.geometry	Geometria do imóvel (WKT)	String
esg.property_data.centroid	Centróide da geometria	String
esg.property_data.latitude	Latitude	Number
esg.property_data.longitude	Longitude	Number
esg.property_data.address	Endereço da propriedade	Object
esg.property_data.address.city	Cidade	String
esg.property_data.address.state	Estado	String
esg.property_data.car_status	Status do CAR. Valores: "AT", "CA", "SU", "PE"	Enum
esg.property_data.car_status_updated_at	Data de atualização do status do CAR	DateTime
esg.property_data_esg	Dados ESG da propriedade	Object
esg.property_data_esg.farm_name	Nome da fazenda	String
esg.property_data_esg.car	Código CAR	String
esg.property_data_esg.esg_status	Status ESG da propriedade	Enum
esg.property_data_esg.total_issues	Total de apontamentos da propriedade	Number
esg.car_declaration_sigef	Dados da declaração CAR/SIGEF	Object
esg.car_declaration_sigef.declared_area	Área declarada (ha)	Number
esg.car_declaration_sigef.legal_reserve_area	Área de reserva legal (ha)	Number
esg.car_declaration_sigef.permanent_protection_area	Área de proteção permanente (ha)	Number
esg.car_declaration_sigef.tax_modules	Módulos fiscais	Number
esg.car_declaration_sigef.analysis_date	Data de análise	String
esg.car_declaration_sigef.registration_date	Data de registro	String
esg.car_declaration_sigef.merx_updated_at	Data de atualização MERX	DateTime
esg.layer_data	Camadas de análise da propriedade	Array
esg.layer_data.layer_esg_enum	Identificador da camada	String
esg.layer_data.layer_name	Nome da camada/órgão fiscalizador	String
esg.layer_data.layer_updated_at	Data de atualização da camada	DateTime
esg.layer_data.esg_status	Status ESG da camada	Enum
esg.layer_data.total_area	Área total afetada (ha)	Number
esg.layer_data.total_issues	Total de apontamentos na camada	Number
esg.layer_data.layer_columns	Colunas de dados da camada	Array
esg.layer_data.items	Detalhes dos apontamentos	Array
esg.layer_data.items.item_values	Valores do apontamento (conforme layer_columns)	Array
esg.layer_data.geometries	Geometrias dos apontamentos	Array
esg.layer_data.geometries.geo_json	GeoJSON da geometria	String
esg.layer_data.geometries.area	Área (ha)	Number

Respostas

200 - Ok

{
    "status": "GENERATED",
    "processing_date": "2026-03-11T14:30:00-03:00",
    "created_at": "2026-03-11T14:30:00.000+00:00",
    "report_request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "cooperative_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cooperative_name": "Cooperativa Exemplo",
    "commitment_id": null,
    "report_integration_id": "b2c3d4e5-f678-9012-abcd-ef3456789012",
    "esg_status_summary": "NAO_CONFORME",
    "esg_status_farms": "NAO_CONFORME",
    "is_summary_report": false,
    "extracted_related_farms": false,
    "prodes_source": "BIOMA_AMAZONIA",
    "anonimyzed": false,
    "producer_data": {
        "producer_id": null,
        "document": "00000000000",
        "name": "Nome do Produtor",
        "dap_code": null,
        "caf_code": null,
        "ricaf_code": null
    },
    "producer_data_esg": {
        "document": "00000000000",
        "name": "Nome do Produtor",
        "total_issues": 0,
        "esg_status": "CONFORME"
    },
    "layer_data_producer": [
        {
            "layer_esg_enum": "IBAMA_PRODUTOR",
            "layer_name": "IBAMA - EMBARGOS",
            "esg_status": "CONFORME",
            "total_area": 0.0,
            "total_issues": 0,
            "layer_columns": ["Nome", "CPF/CNPJ", "Data", "Estado", "Cidade", "Descrição infração", "Auto de infração"],
            "items": [],
            "geometries": []
        },
        {
            "layer_esg_enum": "LISTA_SUJA_MPT",
            "layer_name": "LISTA SUJA - MPT",
            "esg_status": "CONFORME",
            "total_area": 0.0,
            "total_issues": 0,
            "layer_columns": ["Empregador", "Trabalhador envolvido", "Estabelecimento", "Inclusão"],
            "items": [],
            "geometries": []
        }
    ],
    "esg": [
        {
            "id_report": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "farm_id": null,
            "property_data": {
                "farm_name": null,
                "car": "MG-3135209-56FC399E093348DDBFECABA544B54904",
                "area": 4.743,
                "geometry": "MULTIPOLYGON((...))",
                "centroid": "POINT(-44.123 -15.456)",
                "latitude": -15.456,
                "longitude": -44.123,
                "address": {
                    "city": "Januária",
                    "state": "MG"
                },
                "car_status": "AT",
                "car_status_updated_at": "2025-02-20T00:00:00Z"
            },
            "property_data_esg": {
                "farm_name": null,
                "car": "MG-3135209-56FC399E093348DDBFECABA544B54904",
                "esg_status": "NAO_CONFORME",
                "total_issues": 2
            },
            "car_declaration_sigef": {
                "declared_area": 4.743,
                "legal_reserve_area": 0.95,
                "permanent_protection_area": 0.48,
                "tax_modules": 0.15,
                "analysis_date": "2024-01-15",
                "registration_date": "2020-06-10",
                "merx_updated_at": "2025-02-20T00:00:00Z"
            },
            "layer_data": [
                {
                    "layer_esg_enum": "IBAMA_PROPRIEDADE",
                    "layer_name": "IBAMA - EMBARGOS",
                    "layer_updated_at": "2025-02-20T00:00:00Z",
                    "esg_status": "CONFORME",
                    "total_area": 0.0,
                    "total_issues": 0,
                    "layer_columns": ["Nome", "Data", "Termo de Apreensão e Depósito", "Município/UF", "Área (ha)", "Descrição Infração"],
                    "items": [],
                    "geometries": []
                },
                {
                    "layer_esg_enum": "UNIDADE_CONSERVACAO",
                    "layer_name": "ICMBIO - UNIDADES DE CONSERVAÇÃO",
                    "layer_updated_at": "2025-02-20T00:00:00Z",
                    "esg_status": "NAO_CONFORME",
                    "total_area": 4.743,
                    "total_issues": 1,
                    "layer_columns": ["Nome", "Sigla", "Categoria", "Cidade", "Estado", "Área (ha)", "Bioma"],
                    "items": [
                        {
                            "item_values": ["ÁREA DE PROTEÇÃO AMBIENTAL CAVERNAS DO PERUAÇU", "APA", "US", "Não informado", "MG", "4,74", "CERRADO"]
                        }
                    ],
                    "geometries": [
                        {
                            "geo_json": "{\"type\":\"Polygon\",\"coordinates\":[...]}",
                            "area": 4.743
                        }
                    ]
                },
                {
                    "layer_esg_enum": "PRODES_CAATINGA",
                    "layer_name": "INPE - PRODES CAATINGA",
                    "layer_updated_at": "2025-02-20T00:00:00Z",
                    "esg_status": "NAO_CONFORME",
                    "total_area": 0.319,
                    "total_issues": 1,
                    "layer_columns": ["State", "Date", "Area (ha)", "Class"],
                    "items": [
                        {
                            "item_values": ["MG", "06/10/2020", "0,32", "desmatamento"]
                        }
                    ],
                    "geometries": []
                },
                {
                    "layer_esg_enum": "TERRAS_INDIGENAS",
                    "layer_name": "FUNAI - TERRAS INDIGENAS",
                    "esg_status": "CONFORME",
                    "total_area": 0.0,
                    "total_issues": 0,
                    "layer_columns": ["Nome", "Etnia", "Cidade", "Estado", "Modalidade", "Area (ha)", "Fase"],
                    "items": [],
                    "geometries": []
                }
            ],
            "sigef_portions": null,
            "related_farms": null,
            "state_information": null
        }
    ]
}

400 - Bad Request

{
    "timestamp": "string (date-time)",
    "status": "integer (int32)",
    "error": "string"
}

401 - Unauthorized
404 - NotFound

Gerar Relatório Socioambiental

Endpoint​

Regras​

Exemplo de Requisição​

Parâmetros​

Parâmetros de Cabeçalho​

Parâmetros do Corpo​

Dicionário de dados​

Respostas​