Pular para o conteúdo principal

Status ESG por Produtor

Descrição: Trazer informações resumidas sobre o status de elegibilidade/compliance de um produtor/proprietário a partir de um CPF ou CNPJ 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/producer

Regras​

AtributosDescriçãoTipoObrigatório
producer_documentCPF ou CNPJ do produtorstringSim

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 -X GET \
-H "Authorization: {SUA_API_KEY}" \
"https://api.merx.tech/api/v1/integration/environmental-embargoes/status-esg/producer?producer_document=00000000000"

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​

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

Parâmetros de Query​

NomeDescriçãoTipoObrigatório
producer_documentCPF ou CNPJ do produtorStringSim

Dicionário de dados​

NomeDescriçãoTipo
cooperative_idID da cooperativaUUID
documentCPF ou CNPJ do produtor consultadoString
issuesLista de apontamentos agrupados por tipo de embargoArray
issues[].embargo_typeTipo do embargo/camada de análiseString
issues[].total_issuesTotal de apontamentos para o tipo de embargoNumber
total_issuesTotal geral de apontamentos do produtorNumber
esg_statusStatus consolidado de conformidade socioambiental. Valores: "CONFORME", "NAO_CONFORME", "NAO_ENCONTRADO", "PROCESSANDO"Enum

Respostas​

  • 200 - Ok
{
"cooperative_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document": "00000000000",
"issues": [
{
"embargo_type": "IBAMA",
"total_issues": 0
}
],
"total_issues": 0,
"esg_status": "CONFORME"
}
  • 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

  • 404 - NotFound