0. Criação de compradores

Descrição Geral

A API de Análise de Crédito oferece avaliação de crédito em tempo real e onboarding automatizado de novos compradores na plataforma da Credix. Substituindo processos manuais por um fluxo de análise totalmente automatizado, ela proporciona aos vendedores visibilidade quase imediata sobre a elegibilidade dos compradores e seus limites de crédito. Com essa integração via API, a Credix permite que seus parceiros acelerem o fluxo de negociações, reduzam a carga operacional e escalem a concessão de créd...

Criar Análise de Crédito

POST /v2/credit-limit/request

Inicia a análise de crédito em tempo real e realiza automaticamente o onboarding do comprador, caso ele seja elegível, sem necessidade de configuração adicional de parâmetros.

Request

{
  "buyerTaxId": "51137104000183",
  "sellerTaxId": "33137104000110"
}

Exemplo de Resposta

{
  "id": "e08f01b6-56ae-4aa4-a23d-539596413123",
  "status": "Pending"
}

Consultar Análise de Crédito

Para buscar o resultado da análise, é possível usar o webhook credit-limit.underwrite.finished ou o endpoint GET /v2/credit-limit/request/:requestId. Veja mais detalhes abaixo.

Webhook credit-limit.underwrite.finished

Assim que a análise for finalizada, enviaremos este webhook.

Exemplo de Webhook

{
    "notificationType": "credit-limit.underwrite.finished",
    "notificationData": {
        "organization": {
            "id": "seller-org-id"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "Finished",
        "reason": null,
        "retryAfter": "2024-03-20T10:30:00Z",
        "buyerTaxId": "12345678901234",
        "sellerTaxId": "98765432109876"
    }
}

GET /v2/credit-limit/request/:requestId

Retorna o status de uma solicitação de análise de crédito previamente enviada, para fins de visualização pelo vendedor e uso em polling.

Exemplo de Resposta

{
  "id": "e08f01b6-56ae-4aa4-a23d-539596413123",
  "status": "Failed",
  "reason": "Internal error while running underwriting analysis",
  "retry_after": "2025-05-24T19:30:53.044310"
}

Guia de Status da Análise

Status	Descrição
Created	A solicitação de análise foi recebida, mas ainda não foi iniciada.
Pending	O processo de análise ou onboarding está em andamento.
Finished	A solicitação de análise foi concluída com sucesso.
Failed	O fluxo de análise ou onboarding encontrou um erro.
Rejected	O comprador não é elegível para análise ou onboarding.

Códigos de Motivo (reason) e Política de Retentativa (retry policy)

Status	Reason	Política de Retentativa
Failed	Internal error while running underwriting analysis	retry in 24 hours
Rejected	Buyer is not eligible for underwriting	never

Notas:

Quando aplicável, o campo retry_after indica quando é apropriado tentar novamente a solicitação.
Para status Rejected, a tentativa não deve ser repetida automaticamente.
Para status Failed, recomenda-se nova tentativa após 24 horas, salvo orientação diferente no campo retry_after.