Guia: Financeiro

Fluxos para consultar credit score e solicitar análise de crédito. A identificação do produtor é feita por documento (CPF/CNPJ), não por ID interno.

Sequência recomendada

Observações:

• O consentimento é consultado via GET (não criado via POST). A plataforma controla o status internamente.
• Credit score e análise de crédito são independentes: você pode solicitar um sem o outro, mas a prática recomendada é consultar o score antes de abrir a análise.

1. Consultar consentimento

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

Verifica se o produtor já autorizou a consulta de dados financeiros. Parâmetros via query string.

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

Parâmetro	Descrição	Obrigatório
identity	CPF/CNPJ do produtor	Sim
personType	PF ou PJ	Sim
corporateIdentity	CNPJ da empresa (quando PJ vinculada a PF)	Não

Response: {"status": "...", "consent_date": "2024-01-01T00:00:00Z"}. Detalhes em Consultar Consentimento.

2. Solicitar credit score

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

É uma operação POST que solicita a geração do relatório — não um GET por path.

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

Campos obrigatórios: name, social_id (CPF/CNPJ), reports (array). car_list e sigef_list são opcionais e melhoram a análise quando informados.

Response: {"id": "...", "identity_id": "...", "cooperative_id": "...", "name": "...", "social_id": "...", "type": "...", "created_at": "..."}. Detalhes em Criar Credit Score.

3. Solicitar análise de crédito

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

A análise é vinculada a um solicitante (requester_*) e a um produtor analisado (name + identity).

curl -X POST \
  https://api.merx.tech/api/v1/integration/financial/analysis-credit \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "requester_id": "{user_id}",
    "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"
  }'

Campo	Descrição	Obrigatório
requester_id	UUID do usuário solicitante	Sim
requester_name	Nome do solicitante	Sim
requester_email	Email do solicitante	Sim
name	Nome do produtor analisado	Sim
identity	CPF/CNPJ do produtor analisado	Sim
auth_type	Tipo de autenticação para consentimento	Sim
person_type	PF ou PJ	Sim
period_consult	Período de consulta (meses)	Sim
email / phone	Contato do produtor	Não
corporate_name / corporate_identity	Razão social / CNPJ (quando PJ)	Não

Response: {"id": "uuid-da-análise"}. Detalhes em Criar Análise de Crédito.

4. Consultar análise existente

curl -X GET \
  https://api.merx.tech/api/v1/integration/financial/analysis-credit/{id} \
  -H "Authorization: {SUA_API_KEY}"

Ver também: Consultar Análise e Listar relatórios de credit score.