Criar proposta

POST

/v2/credit/proposal

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal"),
    Headers =
    {
        { "api-key", "<api-key>" },
    },
    Content = new StringContent("{ \"creditGroup\": \"inss\", \"product\": \"consignado_novo\", \"opportunityInfo\": { \"simulationId\": \"sim-123\" }, \"client\": { \"name\": \"Maria Exemplo da Silva\", \"federalId\": \"12345678909\", \"birthDate\": \"1960-05-20\", \"phone\": \"11999990000\", \"email\": \"maria@exemplo.com.br\", \"address\": { \"street\": \"Rua Exemplo\", \"number\": \"100\", \"district\": \"Centro\", \"city\": \"São Paulo\", \"state\": \"SP\", \"postalCode\": \"01001000\" }, \"bankAccount\": { \"bankCode\": \"001\", \"branchNumber\": \"1234\", \"accountNumber\": \"567890\", \"accountDigit\": \"1\", \"accountType\": \"checking\" } } }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal"

  payload := strings.NewReader("{ \"creditGroup\": \"inss\", \"product\": \"consignado_novo\", \"opportunityInfo\": { \"simulationId\": \"sim-123\" }, \"client\": { \"name\": \"Maria Exemplo da Silva\", \"federalId\": \"12345678909\", \"birthDate\": \"1960-05-20\", \"phone\": \"11999990000\", \"email\": \"maria@exemplo.com.br\", \"address\": { \"street\": \"Rua Exemplo\", \"number\": \"100\", \"district\": \"Centro\", \"city\": \"São Paulo\", \"state\": \"SP\", \"postalCode\": \"01001000\" }, \"bankAccount\": { \"bankCode\": \"001\", \"branchNumber\": \"1234\", \"accountNumber\": \"567890\", \"accountDigit\": \"1\", \"accountType\": \"checking\" } } }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("api-key", "<api-key>")
  req.Header.Add("Content-Type", "application/json")

  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"))
    .header("api-key", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"creditGroup\": \"inss\", \"product\": \"consignado_novo\", \"opportunityInfo\": { \"simulationId\": \"sim-123\" }, \"client\": { \"name\": \"Maria Exemplo da Silva\", \"federalId\": \"12345678909\", \"birthDate\": \"1960-05-20\", \"phone\": \"11999990000\", \"email\": \"maria@exemplo.com.br\", \"address\": { \"street\": \"Rua Exemplo\", \"number\": \"100\", \"district\": \"Centro\", \"city\": \"São Paulo\", \"state\": \"SP\", \"postalCode\": \"01001000\" }, \"bankAccount\": { \"bankCode\": \"001\", \"branchNumber\": \"1234\", \"accountNumber\": \"567890\", \"accountDigit\": \"1\", \"accountType\": \"checking\" } } }"))
    .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';
const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: '{"creditGroup":"inss","product":"consignado_novo","opportunityInfo":{"simulationId":"sim-123"},"client":{"name":"Maria Exemplo da Silva","federalId":"12345678909","birthDate":"1960-05-20","phone":"11999990000","email":"maria@exemplo.com.br","address":{"street":"Rua Exemplo","number":"100","district":"Centro","city":"São Paulo","state":"SP","postalCode":"01001000"},"bankAccount":{"bankCode":"001","branchNumber":"1234","accountNumber":"567890","accountDigit":"1","accountType":"checking"}}}'
};

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

curl --request POST \
  --url https://ms-credit-api-az.kemosoft.com.br/v2/credit/proposal \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{ "creditGroup": "inss", "product": "consignado_novo", "opportunityInfo": { "simulationId": "sim-123" }, "client": { "name": "Maria Exemplo da Silva", "federalId": "12345678909", "birthDate": "1960-05-20", "phone": "11999990000", "email": "maria@exemplo.com.br", "address": { "street": "Rua Exemplo", "number": "100", "district": "Centro", "city": "São Paulo", "state": "SP", "postalCode": "01001000" }, "bankAccount": { "bankCode": "001", "branchNumber": "1234", "accountNumber": "567890", "accountDigit": "1", "accountType": "checking" } } }'

Envia uma proposta ao banco e responde com o resultado do envio na mesma requisição. Quando o envio puder demorar, prefira Criar proposta assíncrona.

Informe a condição escolhida em opportunityInfo. Quando a condição vier de uma simulação, envie opportunityInfo.simulationId; sem ele, bank é obrigatório.

Campos não reconhecidos são rejeitados.

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

Corpo da requisição^obrigatório

application/json

object

creditGroup

obrigatório

string

product

obrigatório

string

bank

Obrigatório quando opportunityInfo.simulationId não for informado.

string

notes

Observação opcional do solicitante para o atendimento operacional.

string

<= 600 caracteres

opportunityInfo

obrigatório

object

grossAmount

number

loanAmount

number

tacFee

number

iofFee

number

insuranceIncluded

boolean

insuranceFee

number

creditAmount

number

balanceDue

number

netAmount

number

firstPaymentDate

string

lastPaymentDate

string

gracePeriodDays

number

installmentAmount

number

term

number

originalTerm

number

cet

number

monthlyInterestRate

number

requiredCardLimit

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

originalContracts

Array<object>

object

contractNumber

obrigatório

string

bankCode

obrigatório

string

bankName

string

installmentAmount

obrigatório

number

term

obrigatório

number

paidInstallments

number

remainingInstallments

obrigatório

number

balanceDue

obrigatório

number

portabilityBalanceDue

number

portabilityInstallmentAmount

number

balanceDueAt

string

nextDueDate

string

monthlyInterestRate

number

startDate

string

interestCode

Seleção comercial opcional. O ERP configurado pela rede pode exigir o código da tabela, um comentário ou DECIDA_POR_MIM para consignado_novo.

string

<= 255 caracteres

simulationId

string

client

obrigatório

object

name

obrigatório

string

federalId

obrigatório

string

/^\d{11}$/

birthDate

obrigatório

string formato: date

phone

obrigatório

string

email

string

motherName

string

fatherName

string

spouseName

string

gender

string

Valores permitidos: male female other not-informed

monthlyIncome

number

maritalStatus

string

Valores permitidos: single married divorced widowed separated

educationLevel

string

publicPerson

boolean

nationality

string

Valores permitidos: brazilian foreign

birthPlace

object

city

obrigatório

string

state

obrigatório

string

propertyValue

Estimativa monetária em BRL do patrimônio do cliente.

number

unableToSign

boolean

signatureRepresentative

object

name

obrigatório

string

federalId

obrigatório

string

signatureWitness

object

name

obrigatório

string

federalId

obrigatório

string

otherIncome

object

amount

obrigatório

number

type

obrigatório

string

identityDocument

object

type

obrigatório

string

Valores permitidos: rg cnh ctps

number

obrigatório

string

issueDate

string formato: date

issuingAgency

string

issuingState

string

address

object

street

obrigatório

string

number

obrigatório

string

district

obrigatório

string

city

obrigatório

string

state

obrigatório

string

postalCode

obrigatório

string

complement

string

bankAccount

object

bankCode

obrigatório

string

branchNumber

obrigatório

string

branchDigit

string

accountNumber

obrigatório

string

accountDigit

string

accountType

obrigatório

string

Valores permitidos: checking savings salary payment

accountTenureMonths

number

pix

object

type

obrigatório

string

Valores permitidos: federal-id email phone random

key

obrigatório

string

employment

object

employer

object

code

obrigatório

string

federalId

string

humanResourcesPhone

string

enrollment

string

startDate

string formato: date

occupation

object

code

string

title

string

departmentCode

string

organizationUnit

string

pisPasep

string

benefitType

string

creditType

string

legalRepresentative

object

name

obrigatório

string

federalId

obrigatório

string

creditCard

object

lastFourDigits

string

holderName

string

references

Array<object>

object

name

obrigatório

string

phone

obrigatório

string

relationship

obrigatório

string

Valores permitidos: relative friend neighbor acquaintance client

clientDocuments

Array<object>

object

type

obrigatório

string

Valores permitidos: identity identity-front identity-back paycheck proof-of-residence bank-statement bank-account-proof citizen-portal-proof credit-card-front credit-card-selfie

url

obrigatório

URL HTTPS do documento. O download é protegido contra SSRF no consumidor que declarar essa capacidade.

string

Exemplo

{
  "creditGroup": "inss",
  "product": "consignado_novo",
  "opportunityInfo": {
    "simulationId": "sim-123"
  },
  "client": {
    "name": "Maria Exemplo da Silva",
    "federalId": "12345678909",
    "birthDate": "1960-05-20",
    "phone": "11999990000",
    "email": "maria@exemplo.com.br",
    "address": {
      "street": "Rua Exemplo",
      "number": "100",
      "district": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "postalCode": "01001000"
    },
    "bankAccount": {
      "bankCode": "001",
      "branchNumber": "1234",
      "accountNumber": "567890",
      "accountDigit": "1",
      "accountType": "checking"
    }
  }
}

Respostas

200

Resultado do envio. Consulte outcome.status e, quando houver, nextAction.

application/json

object

requestId

obrigatório

string

proposal

object

obrigatório

string

number

obrigatório

string

originalNumber

string

issueDate

string

status

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

string

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

formalizationUrl

string

creditCondition

object

grossAmount

number

loanAmount

number

tacFee

number

iofFee

number

insuranceIncluded

boolean

insuranceFee

number

creditAmount

number

balanceDue

number

netAmount

number

firstPaymentDate

string

lastPaymentDate

string

gracePeriodDays

number

installmentAmount

number

term

number

originalTerm

number

cet

number

monthlyInterestRate

number

requiredCardLimit

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

originalContracts

Array<object>

object

contractNumber

obrigatório

string

bankCode

obrigatório

string

bankName

string

installmentAmount

obrigatório

number

term

obrigatório

number

paidInstallments

number

remainingInstallments

obrigatório

number

balanceDue

obrigatório

number

portabilityBalanceDue

number

portabilityInstallmentAmount

number

balanceDueAt

string

nextDueDate

string

monthlyInterestRate

number

startDate

string

outcome

obrigatório

object

status

obrigatório

string

Valores permitidos: created processing action-required manual-review rejected failed

code

string

message

string

wrongFields

Array<object>

object

path

obrigatório

string

code

obrigatório

string

message

obrigatório

string

nextAction

object

type

obrigatório

string

Valores permitidos: authorize-open-finance authorize-bank submit-documents sign wait-analysis contact-support

message

string

url

string

expiresAt

string

institutionCode

string

deadline

string

Exemplo

{
  "proposal": {
    "status": "faltando-info",
    "subStatus": "aprovada"
  },
  "outcome": {
    "status": "created"
  },
  "nextAction": {
    "type": "authorize-open-finance"
  }
}

Criar proposta

Autorizações

Corpo da requisiçãoobrigatório

Exemplo

Respostas

200

Exemplo

Corpo da requisição^obrigatório