Pular para o conteúdo
CorbMaxCorbMaxCorbMax Docs

Visão geral da API

A API CorbMax é uma API REST que recebe e responde JSON. Ela automatiza as jornadas do painel: consultar o catálogo, qualificar clientes, simular condições e enviar e acompanhar propostas.

URL base

Seção intitulada “URL base”
Ambiente URL base
Produção https://ms-credit-api-az.kemosoft.com.br

Autenticação

Seção intitulada “Autenticação”

Toda requisição envia a chave de API do parceiro no header api-key. Veja Autenticação.

Versões

Seção intitulada “Versões”

A versão faz parte do caminho, como em /v1/credit/qualification e /v2/credit/proposal. A referência indica a versão de cada operação.

  • Propostas: use as operações /v2. As operações de proposta em /v1 estão obsoletas e não fazem parte desta documentação.
  • Catálogo, qualificação e créditos: use as operações /v1.

Requisições

Seção intitulada “Requisições”
  • Envie o corpo em JSON, com o header Content-Type: application/json.
  • O corpo JSON de uma requisição pode ter até 10 MB.
  • Arquivos, como o extrato de consignações, são enviados em multipart/form-data.
  • Envie o CPF com 11 dígitos, sem pontuação.
  • Datas seguem o formato ISO 8601, como 2026-10-11.
  • Nas operações de proposta /v2, campos não reconhecidos são rejeitados.

Respostas

Seção intitulada “Respostas”

O formato de cada resposta está na referência. Para que sua integração continue funcionando à medida que a API evolui:

  • Ignore campos desconhecidos. Novos campos podem ser adicionados às respostas a qualquer momento.
  • Use só campos documentados. Campos fora da referência não fazem parte do contrato e podem mudar sem aviso.
  • Trate valores novos de status. Listas como status e subStatus podem ganhar valores. Trate um valor desconhecido como uma situação que exige acompanhamento, nunca como sucesso.
  • Decida pelo código, não pela mensagem. Mensagens são textos em português para leitura humana e podem mudar. Veja Erros.

Operações tarifáveis

Seção intitulada “Operações tarifáveis”

Qualificação, simulação, criação e consulta de propostas são operações tarifáveis. Quando a cobrança está ativa para a sua rede parceira, cada execução processada consome créditos da carteira do parceiro, inclusive uma qualificação em que o cliente não é qualificado. Uma proposta recusada pelo banco não é cobrada.

Se o saldo for insuficiente, a API responde com HTTP 402. Veja Saldo insuficiente.