Pular para o conteúdo
CorbMaxCorbMaxCorbMax Docs

Quickstart da API

Neste guia, você consulta os convênios disponíveis, qualifica um cliente pelo CPF e simula uma nova condição para uma das oportunidades encontradas.

O que você precisa

Seção intitulada “O que você precisa”
  • A chave de API do parceiro. Veja Obter uma chave.
  • O CPF de um cliente que autorizou a consulta. A API não tem ambiente de testes: toda chamada consulta dados reais.
  • curl ou outro cliente HTTP.

Nos exemplos, troque SUA_CHAVE_DE_API pela sua chave e 12345678909 pelo CPF do cliente. Para não repetir a chave em cada comando, guarde-a numa variável de ambiente:

Janela do terminal
export CORBMAX_API_KEY="SUA_CHAVE_DE_API"

1. Escolha o convênio

Seção intitulada “1. Escolha o convênio”

Liste os convênios disponíveis:

Janela do terminal
curl https://ms-credit-api-az.kemosoft.com.br/v1/catalog/credit-groups/options \
  -H "api-key: $CORBMAX_API_KEY"

A resposta é uma lista. Guarde o slug do convênio do cliente:

[
  {
    "id": "8f1d2c3b-0a9e-4b7c-8d6f-5e4a3b2c1d0e",
    "slug": "inss",
    "name": "INSS",
    "category": "consignado",
    "logoUrl": "https://exemplo.com.br/logos/inss.png"
  }
]

2. Qualifique o cliente

Seção intitulada “2. Qualifique o cliente”

Envie o convênio e o CPF do cliente, com 11 dígitos e sem pontuação:

Janela do terminal
curl -X POST https://ms-credit-api-az.kemosoft.com.br/v1/credit/qualification \
  -H "api-key: $CORBMAX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "creditGroup": "inss",
    "type": "full",
    "clientInfo": { "federalId": "12345678909" }
  }'

type: "full" executa a qualificação completa, a mesma feita pelo painel.

3. Leia o resultado

Seção intitulada “3. Leia o resultado”

Primeiro, confira qualification.status. O valor qualificado indica que o cliente tem oportunidades no convênio. Os outros valores estão em Erros: qualificação.

As oportunidades ficam em creditDetail. A resposta abaixo foi resumida:

{
  "success": true,
  "qualification": {
    "id": "6b0c1f8e-2d4a-4c3b-9e7f-1a2b3c4d5e6f",
    "status": "qualificado",
    "creditGroup": true
  },
  "creditDetail": {
    "creditAmount": 9278.54,
    "availableCredits": [
      {
        "category": "consignado",
        "enrollment": "123456789",
        "totalAmount": 9278.54,
        "opportunities": [
          {
            "type": "margin",
            "productSlug": "consignado_novo",
            "productName": "Consignado novo",
            "productAmount": 9278.54,
            "simulations": [
              {
                "simulationId": "sim-123",
                "bankSlug": "banco-exemplo",
                "bankName": "Banco Exemplo",
                "netAmount": 9278.54,
                "installment": 424.2,
                "term": 84,
                "interest": 1.85,
                "simulationAction": {
                  "opportunityReference": "qopp:v1:Qk7example",
                  "editableFields": ["requestedAmount", "installment", "term"]
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Como ler:

  • availableCredits agrupa as oportunidades por categoria e, quando houver, por matrícula (enrollment).
  • Cada oportunidade lista suas simulações em ordem de recomendação. Use a primeira como oferta principal.
  • Guarde qualification.id e o opportunityReference da simulação escolhida para o próximo passo.

4. Simule uma nova condição

Seção intitulada “4. Simule uma nova condição”

Para recalcular a condição com outra parcela ou outro prazo, envie a referência da simulação e só os campos listados em editableFields:

Janela do terminal
curl -X POST https://ms-credit-api-az.kemosoft.com.br/v1/credit/qualification/6b0c1f8e-2d4a-4c3b-9e7f-1a2b3c4d5e6f/simulate \
  -H "api-key: $CORBMAX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "opportunityReference": "qopp:v1:Qk7example",
    "installment": 350,
    "term": 72
  }'

requestedAmount (valor desejado) e installment (parcela) não podem ser enviados juntos. A resposta traz a nova condição em opportunities e a visão atualizada da qualificação em creditDetail.

Próximos passos

Seção intitulada “Próximos passos”