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/CNPJ do produtor	String	Sim	-
personType	Tipo de pessoa (PF ou PJ)	String	Sim	-
corporateIdentity	CNPJ da empresa (se PJ)	String	Não	-

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=12345678901&personType=PF"

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=12345678901&personType=PF"))
    .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: '12345678901', personType: 'PF' });
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": "12345678901",
    "personType": "PF"
}

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

Parâmetros

Parâmetros de Query:

Nome	Descrição	Tipo	Obrigatório
identity	CPF/CNPJ do produtor	String	Sim
personType	Tipo de pessoa (PF ou PJ)	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": "2024-01-01T00:00:00Z"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound