Criar Análise de Crédito

Descrição: Solicita a criação de uma análise de crédito para um produtor.

Endpoint

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

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
requester_id	UUID do solicitante	UUID	Sim	-
requester_name	Nome do solicitante	String	Sim	-
requester_email	E-mail do solicitante	String	Sim	Formato e-mail válido
name	Nome do produtor	String	Sim	-
identity	CPF/CNPJ do produtor	String	Sim	-
auth_type	Tipo de autenticação	String	Sim	-
person_type	Tipo de pessoa (PF ou PJ)	String	Sim	-
period_consult	Período de consulta	String	Sim	-
email	E-mail do produtor	String	Não	Formato e-mail válido
phone	Telefone do produtor	String	Não	-
corporate_name	Nome da empresa (se PJ)	String	Não	-
corporate_identity	CNPJ da empresa (se PJ)	String	Não	-

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "requester_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requester_name": "Cooperativa Exemplo",
    "requester_email": "cooperativa@exemplo.com",
    "name": "João da Silva",
    "identity": "12345678901",
    "auth_type": "EMAIL",
    "person_type": "PF",
    "period_consult": "12"
  }' \
  "https://api.merx.tech/api/v1/integration/financial/analysis-credit"

Java

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

String body = "{"
    + "\"requester_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\","
    + "\"requester_name\": \"Cooperativa Exemplo\","
    + "\"requester_email\": \"cooperativa@exemplo.com\","
    + "\"name\": \"João da Silva\","
    + "\"identity\": \"12345678901\","
    + "\"auth_type\": \"EMAIL\","
    + "\"person_type\": \"PF\","
    + "\"period_consult\": \"12\""
    + "}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/financial/analysis-credit"))
    .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/analysis-credit',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      requester_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
      requester_name: 'Cooperativa Exemplo',
      requester_email: 'cooperativa@exemplo.com',
      name: 'João da Silva',
      identity: '12345678901',
      auth_type: 'EMAIL',
      person_type: 'PF',
      period_consult: '12',
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

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

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

payload = {
    "requester_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requester_name": "Cooperativa Exemplo",
    "requester_email": "cooperativa@exemplo.com",
    "name": "João da Silva",
    "identity": "12345678901",
    "auth_type": "EMAIL",
    "person_type": "PF",
    "period_consult": "12"
}

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

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
requester_id	UUID do solicitante	UUID	Sim
requester_name	Nome do solicitante	String	Sim
requester_email	E-mail do solicitante	String	Sim
name	Nome do produtor	String	Sim
identity	CPF/CNPJ do produtor	String	Sim
auth_type	Tipo de autenticação	String	Sim
person_type	Tipo de pessoa (PF ou PJ)	String	Sim
period_consult	Período de consulta	String	Sim
email	E-mail do produtor	String	Não
phone	Telefone do produtor	String	Não
corporate_name	Nome da empresa (se PJ)	String	Não
corporate_identity	CNPJ da empresa (se PJ)	String	Não

Respostas

• 200 - Ok

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound