Consultar Consentimento de Análise de Crédito

Descrição: Consulta o status de consentimento do produtor para análise de crédito.

Endpoint

GET/api/v1/integration/financial/analysis-credit/consent

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
identity	CPF do produtor	String	Sim	Apenas CPF, com dígito verificador válido. CNPJ ou CPF inválido é recusado pelo serviço financeiro com 400 message.identity.invalid-format.
personType	Tipo de pessoa	String	Sim	Enum: NATURAL (pessoa física) ou LEGAL (pessoa jurídica). Valor fora da lista é recusado pelo serviço financeiro com 400.
corporateIdentity	CNPJ da empresa (se PJ)	String	Não	Quando informado, precisa ser um CNPJ com dígito verificador válido. CNPJ inválido é recusado pelo serviço financeiro com 400 message.corporate-identity.invalid-format.

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/financial/analysis-credit/consent?identity=12345678909&personType=NATURAL"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/financial/analysis-credit/consent?identity=12345678909&personType=NATURAL"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .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 params = new URLSearchParams({ identity: '12345678909', personType: 'NATURAL' });
const response = await fetch(
  `https://api.merx.tech/api/v1/integration/financial/analysis-credit/consent?${params}`,
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

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

headers = {
    "Authorization": "{SUA_API_KEY}",
}

params = {
    "identity": "12345678909",
    "personType": "NATURAL"
}

response = requests.get(url, params=params, headers=headers)
print(response.json())

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;

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

// corporateIdentity opcional (null para pessoa fisica)
var consent = merx.financial().checkConsentStatus("12345678909", "NATURAL", null);

Parâmetros

Parâmetros de Query:

Nome	Descrição	Tipo	Obrigatório
identity	CPF do produtor	String	Sim
personType	Tipo de pessoa: NATURAL ou LEGAL	String	Sim
corporateIdentity	CNPJ da empresa (se PJ)	String	Não

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim

Respostas

• 200 - Ok

{
    "status": "string",
    "consent_date": 1709837511.870898
}

consent_date 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: um produtor sem consentimento registrado volta sem a chave consent_date.

• 400 - Bad Request

Parâmetro de query obrigatório ausente. A mensagem é o texto do Spring, não uma chave de tradução:

{
  "messages": ["Required String parameter 'identity' is not present"]
}

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"]
}