Consultar propostas

GET

/v2/credit/proposal

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal?federalId=068.320.924-82&proposal=1234567890&bank=banco-exemplo"),
    Headers =
    {
        { "api-key", "<api-key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal?federalId=068.320.924-82&proposal=1234567890&bank=banco-exemplo"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("api-key", "<api-key>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal?federalId=068.320.924-82&proposal=1234567890&bank=banco-exemplo"))
    .header("api-key", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal?federalId=068.320.924-82&proposal=1234567890&bank=banco-exemplo';
const options = {method: 'GET', headers: {'api-key': '<api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal?federalId=068.320.924-82&proposal=1234567890&bank=banco-exemplo' \
  --header 'api-key: <api-key>'

Retorna o status atual das propostas do parceiro. Busque uma proposta pelo id ou pelo número (proposal), sempre com bank, ou todas as propostas de um CPF com federalId.

Operação tarifável: quando a cobrança está ativa para a sua rede parceira, cada execução processada consome créditos da carteira do parceiro.

Autorizações

Api-Key

Parâmetros

Parâmetros de consulta

federalId

string

Exemplo

068.320.924-82

CPF do cliente, com ou sem pontuação. Pode retornar várias propostas.

proposal

string

Exemplo

1234567890

Número atual ou original da proposta no banco. Exige bank.

string formato: uuid

ID da proposta no CorbMax. Exige bank.

bank

string

Exemplo

banco-exemplo

Slug do banco. Obrigatório com id ou proposal; filtro opcional com federalId.

Respostas

200

Propostas encontradas. A busca por id ou proposal retorna no máximo um item.

application/json

Array<object>

object

statusAt

obrigatório

Data/hora em que o status foi observado ou persistido.

string formato: date-time

proposal

obrigatório

Número atual da proposta.

string

status

obrigatório

Status canônico atual da proposta.

string

Valores permitidos: faltando-info info-invalida digitada assinatura em-analise em-andamento pendente pago com-restricao cancelado rejeitado pendente-cancelamento nao-mapeado erro-api

subStatus

Detalhe do status atual, quando disponível.

string

aceita null

Valores permitidos: aprovada pendente-assinatura pendente-selfie pendente-documentos documento-invalido aguardando-prazo-loas ted-devolvida aguardando-averbacao

creditCondition

Condição de crédito persistida para a proposta.

object

interestCode

string

interestTable

string

grossAmount

number

loanAmount

number

tacFee

number

iofFee

number

insuranceFee

number

creditAmount

number

balanceDue

number

netAmount

number

lastPayment

string

firstPayment

string

simulationGracePeriod

number

installment

number

term

number

requiredCardLimit

number

originalTerm

number

cet

number

interest

number

anticipatedAmounts

Array<object>

object

dueDate

obrigatório

string

amount

obrigatório

number

iofFee

number

cardCondition

object

creditLimit

obrigatório

number

cashLimit

obrigatório

number

cashRate

number

message

string

simulationType

string

originalContracts

Array<object>

object

contractNumber

obrigatório

string

bankNo

obrigatório

string

bankName

obrigatório

string

installment

obrigatório

number

term

obrigatório

number

paidInstallments

obrigatório

number

remainingInstallments

obrigatório

number

balanceDue

obrigatório

number

balanceDuePort

number

installmentPort

number

interest

obrigatório

number

startDate

obrigatório

string

commission

number

maxRefinInterestRate

number

formalizationLink

Link para a formalização, quando disponível.

string

aceita null

notes

Observação ou mensagem associada ao status.

string

aceita null

originalProposal

Número original da proposta, quando diferente do atual.

string

aceita null

obrigatório

ID local da proposta.

string

bank

obrigatório

Slug do banco da proposta.

string

Exemplo

[
  {
    "status": "faltando-info",
    "subStatus": "aprovada"
  }
]