Pular para o conteúdo principal

Gerar Relatório EUDR

Descrição: Gera um relatório pré-invoice de compliance EUDR (Regulamento de Desmatamento da União Europeia) 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/eudr

Regras

AtributosDescriçãoTipoObrigatórioValidações
carCódigo CAR do imóvelStringSim
producer_nameNome do produtorStringSim
producer_documentCPF ou CNPJ do produtorStringSimCom ou sem pontuação

Exemplo de Requisição

curl -X POST \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"car": "MT-5107925-A1B2C3D4E5F6",
"producer_name": "Nome do Produtor",
"producer_document": "00000000000"
}' \
"https://api.merx.tech/api/v1/integration/eudr"

Parâmetros

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim
Content-Typeapplication/jsonStringSim

Parâmetros do Corpo

NomeDescriçãoTipoObrigatórioValidações
carCódigo CAR do imóvelStringSim
producer_nameNome do produtorStringSim
producer_documentCPF ou CNPJ do produtorStringSimCom ou sem pontuação

Dicionário de dados

NomeDescriçãoTipo
statusStatus do processamento do relatório. Valores: "PROCESSING", "UPDATING_CAR", "ERROR_UPDATING", "GENERATING_REPORT", "GENERATED", "ERROR_TIMEOUT", "ERROR"Enum
processing_dateData de processamento do relatórioNumber (epoch s)
created_atData de criação do relatórioNumber (epoch ms)
report_request_idIdentificador único do relatório geradoUUID
cooperative_idID da cooperativaUUID
cooperative_nameNome da cooperativaString
external_idIdentificador externo do relatório (não-anonimizado), utilizado para compartilhamento públicoUUID
eu_status_summaryStatus consolidado de conformidade EUDR. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"Enum
eu_status_farmsStatus consolidado das fazendas. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"Enum
prodes_sourceFonte do PRODES utilizada. Valores: "AMAZONIA_LEGAL", "BIOMA_AMAZONIA"Enum
anonimyzedIndica se o relatório foi gerado de forma anonimizada (sempre presente)Boolean
forest_loss_dataDados de perda florestalObject
forest_loss_data.total_areaÁrea total desmatada (ha)Number
producer_dataDados do produtorObject
producer_data.documentCPF ou CNPJ do produtorString
producer_data.nameNome do produtorString
producer_data_euDados EUDR do produtorObject
producer_data_eu.documentCPF ou CNPJString
producer_data_eu.nameNome do produtorString
euLista de resultados por propriedade (CAR)Array
eu[].farm_idID da fazendaUUID
eu[].property_dataDados da propriedadeObject
eu[].property_data.farm_nameNome da fazendaString
eu[].property_data.carCódigo CARString
eu[].property_data.areaÁrea do imóvel (ha)Number
eu[].property_data.legal_reserve_areaÁrea de reserva legal do imóvel (ha)Number
eu[].property_data.permanent_protection_areaÁrea de preservação permanente do imóvel (ha)Number
eu[].property_data.consolidated_areaÁrea consolidada do imóvel (ha)Number
eu[].property_data.mod_fiscaisNúmero de módulos fiscais do imóvelNumber
eu[].property_data.geometryGeometria do imóvel (GeoJSON)String
eu[].property_data.centroidCentróide da geometriaString
eu[].property_data.latitudeLatitudeNumber
eu[].property_data.longitudeLongitudeNumber
eu[].property_data.addressEndereço da propriedadeObject
eu[].property_data.address.streetLogradouroString
eu[].property_data.address.numberNúmeroString
eu[].property_data.address.complementComplementoString
eu[].property_data.address.neighborhoodBairroString
eu[].property_data.address.zip_codeCEPString
eu[].property_data.address.cityCidadeString
eu[].property_data.address.stateEstadoString
eu[].property_data.address.countryPaísString
eu[].property_data.state_subscriptionInscrição estadual do imóvelString
eu[].property_data.car_statusStatus do CAR. Valores: "AT", "CA", "SU", "PE"Enum
eu[].property_data.car_status_updated_atData de atualização do status do CARNumber (epoch s)
eu[].property_data.created_atData de criação do CAR na base do SICARNumber (epoch s)
eu[].property_data.updated_atData da última atualização do CAR na base do SICARNumber (epoch s)
eu[].property_data_euDados EUDR da propriedadeObject
eu[].property_data_eu.farm_nameNome da fazendaString
eu[].property_data_eu.carCódigo CARString
eu[].property_data_eu.eu_statusStatus EUDR da propriedade. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"Enum
eu[].property_data_eu.total_issuesTotal de apontamentos da propriedadeNumber
eu[].car_declaration_sigefDados da declaração CAR/SIGEFObject
eu[].car_declaration_sigef.declared_areaÁrea declarada (ha)Number
eu[].car_declaration_sigef.legal_reserve_areaÁrea de reserva legal (ha)Number
eu[].car_declaration_sigef.permanent_protection_areaÁrea de proteção permanente (ha)Number
eu[].car_declaration_sigef.tax_modulesMódulos fiscaisNumber
eu[].car_declaration_sigef.analysis_dateData de análiseString
eu[].car_declaration_sigef.registration_dateData de registroString
eu[].car_declaration_sigef.rectification_dateData de retificaçãoString
eu[].car_declaration_sigef.merx_updated_atData de atualização no MerxNumber (epoch s)
eu[].layer_dataCamadas de análise EUDR da propriedadeArray
eu[].layer_data[].layer_esg_enumIdentificador da camadaString
eu[].layer_data[].layer_nameNome da camada/órgão fiscalizadorString
eu[].layer_data[].layer_colorCor da camada para renderização (hexadecimal)String
eu[].layer_data[].layer_questionPergunta associada à camadaString
eu[].layer_data[].layer_updated_atData de atualização da camadaNumber (epoch s)
eu[].layer_data[].esg_statusStatus EUDR da camada. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"Enum
eu[].layer_data[].total_areaÁrea total afetada (ha)Number
eu[].layer_data[].total_issuesTotal de apontamentos na camada (sempre presente, inclusive 0)Number
eu[].layer_data[].layer_columnsNomes das colunas correspondentes a cada posição de items[].item_valuesArray
eu[].layer_data[].itemsApontamentos encontrados na camadaArray
eu[].layer_data[].items[].item_valuesValores do apontamento, na ordem de layer_columnsArray
eu[].layer_data[].geometriesGeometrias dos apontamentos da camadaArray
eu[].layer_data[].geometries[].geo_jsonGeometria em formato GeoJSONString
eu[].layer_data[].geometries[].areaÁrea da geometria (ha)Number
eu[].layer_data[].eu_deforestation_layerIndica se a camada é considerada camada de desmatamento para EUDRBoolean
eu[].layer_data[].source_linkLink da fonte oficial do dado da camadaString
eu[].prodes_layer_dataCamadas PRODES de análise de desmatamento (mesma estrutura de eu[].layer_data)Array

Respostas

  • 200 - Ok
{
"status": "GENERATED",
"processing_date": 1773239400.000000000,
"created_at": 1773239400000,
"report_request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"cooperative_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cooperative_name": "Cooperativa Exemplo",
"external_id": "f6a7b8c9-0123-4567-8901-234567890123",
"eu_status_summary": "NAO_CONFORME",
"eu_status_farms": "NAO_CONFORME",
"prodes_source": "BIOMA_AMAZONIA",
"anonimyzed": false,
"forest_loss_data": {
"total_area": 0.319
},
"producer_data": {
"document": "00000000000",
"name": "Nome do Produtor"
},
"producer_data_eu": {
"document": "00000000000",
"name": "Nome do Produtor"
},
"eu": [
{
"farm_id": "6f2b1d10-6f4e-4a54-9f0e-2a0f3c1b7e55",
"property_data": {
"farm_name": "Fazenda São José",
"car": "MT-5107925-A1B2C3D4E5F6",
"area": 259.48,
"legal_reserve_area": 90.12,
"permanent_protection_area": 12.4,
"consolidated_area": 140.2,
"mod_fiscais": 3.5,
"address": {
"city": "Sorriso",
"state": "MT"
},
"car_status": "AT",
"car_status_updated_at": 1740009600.000000000,
"created_at": 1592179200.000000000,
"updated_at": 1705276800.000000000
},
"property_data_eu": {
"farm_name": "Fazenda São José",
"car": "MT-5107925-A1B2C3D4E5F6",
"eu_status": "NAO_CONFORME",
"total_issues": 2
},
"car_declaration_sigef": {
"declared_area": 259.48,
"legal_reserve_area": 90.12,
"permanent_protection_area": 12.4,
"tax_modules": 3.5,
"analysis_date": "2024-01-01",
"registration_date": "2020-06-15",
"rectification_date": "2023-08-22",
"merx_updated_at": 1705315800.000000000
},
"layer_data": [
{
"layer_esg_enum": "IBAMA_PROPRIEDADE",
"layer_name": "IBAMA - EMBARGOS",
"layer_color": "#D32D1F",
"layer_updated_at": 1740009600.000000000,
"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": [],
"eu_deforestation_layer": false,
"source_link": "https://www.gov.br/ibama"
}
],
"prodes_layer_data": [
{
"layer_esg_enum": "PRODES",
"layer_name": "INPE - PRODES - AMAZÔNIA",
"layer_color": "#335690",
"layer_updated_at": 1740009600.000000000,
"esg_status": "NAO_CONFORME",
"total_area": 0.319,
"total_issues": 2,
"layer_columns": ["State", "Date", "Area (ha)", "Class"],
"items": [
{ "item_values": ["MT", "2023", "0.319", "d2023"] }
],
"geometries": [
{ "geo_json": "{\"type\":\"Polygon\",\"coordinates\":[...]}", "area": 0.319 }
],
"eu_deforestation_layer": true,
"source_link": "http://terrabrasilis.dpi.inpe.br"
}
]
}
]
}
  • 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

  • 404 - NotFound