Criar Análise de Credit Score

Descrição: Solicita a geração de um relatório de credit score para um produtor.

Endpoint

POST/api/v1/integration/financial/credit-score

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
name	Nome do produtor	String	Sim	-
social_id	CPF/CNPJ do produtor	String	Sim	Validado como CPF ou CNPJ, com dígitos verificadores, pelo serviço financeiro. Documento inválido é recusado com 400.
car_list	Lista de CARs do produtor	Array[String]	Não	-
sigef_list	Lista de registros SIGEF	Array[String]	Não	-
reports	Tipos de relatórios solicitados	Array[String]	Sim	Obrigatório apenas no sentido de estar presente: a validação é de não-nulo, não de não-vazio — uma lista vazia ([]) passa. Cada item é um enum: CPR, BNDES, SCR, AGRO, SIGEF ou DISSOLVE. Valor fora da lista é recusado pelo serviço financeiro com 400 message.malformed-request.

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João da Silva",
    "social_id": "12345678909",
    "car_list": ["MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX"],
    "sigef_list": [],
    "reports": ["AGRO"]
  }' \
  "https://api.merx.tech/api/v1/integration/financial/credit-score"

Java

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

String body = "{"
    + "\"name\": \"João da Silva\","
    + "\"social_id\": \"12345678909\","
    + "\"car_list\": [\"MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX\"],"
    + "\"sigef_list\": [],"
    + "\"reports\": [\"AGRO\"]"
    + "}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/financial/credit-score"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .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/financial/credit-score',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'João da Silva',
      social_id: '12345678909',
      car_list: ['MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX'],
      sigef_list: [],
      reports: ['AGRO'],
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/financial/credit-score"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "name": "João da Silva",
    "social_id": "12345678909",
    "car_list": ["MT-5107909-XXXXXXXXXXXXXXXXXXXXXXXX"],
    "sigef_list": [],
    "reports": ["AGRO"]
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.financial.CreditScoreRequest;
import java.util.List;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

var score = merx.financial().generateCreditScore(CreditScoreRequest.builder()
    .name("Fulano de Tal")
    .socialId("12345678909")
    .reports(List.of("AGRO", "SIGEF"))
    .build());

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
Content-Type	application/json	String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
name	Nome do produtor	String	Sim
social_id	CPF/CNPJ do produtor	String	Sim
car_list	Lista de CARs do produtor	Array[String]	Não
sigef_list	Lista de registros SIGEF	Array[String]	Não
reports	Tipos de relatórios solicitados (aceita lista vazia): CPR, BNDES, SCR, AGRO, SIGEF ou DISSOLVE	Array[String]	Sim

Respostas

• 200 - Ok

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "identity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "cooperative_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "social_id": "string",
    "type": "string",
    "created_at": 1709837511.870898
}

created_at vem em epoch com segundos decimais (segundos desde 1970-01-01 UTC, com a fração após o ponto), e não em texto ISO-8601. Campos nulos são omitidos da resposta.

• 400 - Bad Request

Campo obrigatório ausente ou vazio no corpo:

{
  "messages": ["message.name.mandatory"]
}

{
  "messages": ["message.social-id.mandatory"]
}

{
  "messages": ["message.reports.mandatory"]
}

Erros vindos do serviço financeiro. Este endpoint é um repasse para o serviço financeiro da Merx. Quando o erro nasce lá, a API devolve o status HTTP original do serviço financeiro e o corpo cru da resposta dele, sem reescrever no formato {"messages": [...]}. Trate as respostas de erro deste endpoint em dois casos:

1. Erro de validação da própria integração — corpo no formato {"messages": ["chave.i18n"]}.
2. Erro repassado do serviço financeiro — status e corpo definidos pelo serviço de origem; o formato pode ser qualquer um, inclusive um JSON com estrutura diferente. Não faça o parsing assumindo a chave messages.

• 401 - Unauthorized

Devolvido pelo gateway quando o Authorization está ausente ou inválido — nesse caso a resposta traz corpo, no formato {"data": [], "error": {...}}. A mensagem dentro de error varia conforme o plugin de autenticação da rota, então não programe em cima do texto. Um 401 repassado do serviço financeiro, esse sim, vem sem corpo.

• 404 - Not Found

• 502 - Bad Gateway

O serviço financeiro está indisponível ou recusou a conexão:

{
  "messages": ["message.integration.connection.refused"]
}