---
title: "Simulation CAAS"
method: POST
path: "/caas/simulation"
tags: ["CAAS"]
---

# Simulation CAAS

`POST /caas/simulation`

# Simulation CAAS
>* Insira os dados da requisição para que a simulação possa ser feita.
>* NOTE: The simulation is done according to the type of product.
>>* Enter the request data so that the simulation can be carried out.
>>* OBS: A simulação é feita de acordo com o tipo do produto.

## Request body

- SimulationCaas — Simulação Velotax, Antecipação de salário e Loan
  - `personType` string — Pessoa física ou jurídica
  - `tax_number` string — CPF ou CNPJ
  - `value` integer — Valor solicitado
  - `onlySimulation` boolean — Somente simulação
  - `product_id` integer — ID do produto
  - `release_date` string — Data da solicitação
  - `due_date` string — Data de vencimento
  - `monthlyTax` integer — Taxa mensal
  - `installments` integer — Número de parcelas

## Response `201`

Pipeline

- Pipeline
  - `id` string — ID do processo
  - `status` 'SIGNUP_ANALISIS' | 'SIGNUP_COMPLETED' | 'SIGNUP_DENIED' | 'PROPOSAL_ANALISIS' | 'PROPOSAL_CREATED' | 'PROPOSAL_DENIED' — Status do processo
  - `cpf` integer — CPF do usuario
  - `name` string — Nome do usuario
  - `dateCreated` string — Data criação do processo
  - `lastUpdated` string — Ultima atualização do processo
  - `matches` Matches[]
    - union
      - MatchLoan
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `minValue` integer — Valor minimo do empréstimo
        - `maxValue` integer — Valor máximo do empréstimo
        - `minInstallment` integer — Quantidade minima de parcelas
        - `maxInstallment` integer — Quantidade máxima de parcelas
        - `monthlyTax` number — Taxa de juros mensal
      - MatchCard
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `annuity` number — Valor da anuidade
        - `network` 'VISA' | 'MASTERCARD' | 'ELO' — Bandeira do Cartão de crédito
      - MatchAuto
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `minValue` integer — Valor minimo do empréstimo
        - `maxValue` integer — Valor máximo do empréstimo
        - `minInstallment` integer — Quantidade minima de parcelas
        - `maxInstallment` integer — Quantidade máxima de parcelas
        - `monthlyTax` number — Taxa de juros mensal
      - MatchHome
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `minValue` integer — Valor minimo do empréstimo
        - `maxValue` integer — Valor máximo do empréstimo
        - `minInstallment` integer — Quantidade minima de parcelas
        - `maxInstallment` integer — Quantidade máxima de parcelas
        - `monthlyTax` number — Taxa de juros mensal
      - MatchFinancingAuto
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `minValue` integer — Valor minimo do empréstimo
        - `maxValue` integer — Valor máximo do empréstimo
        - `minInstallment` integer — Quantidade minima de parcelas
        - `maxInstallment` integer — Quantidade máxima de parcelas
        - `monthlyTax` number — Taxa de juros mensal
      - MatchDebt
        - `product_id` integer — Id do produto
        - `name` string — Nome do produto
        - `logo` string — Logo do produtoMatchs
        - `minValue` integer — Valor minimo do empréstimo
        - `maxValue` integer — Valor máximo do empréstimo
        - `minInstallment` integer — Quantidade minima de parcelas
        - `maxInstallment` integer — Quantidade máxima de parcelas
        - `monthlyTax` number — Taxa de juros mensal
  - `proposals` Proposals[]
    - union
      - Loan
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `value` number, required — Valor do empréstimo
        - `installments` integer, required — Número de parcelas
        - `monthlyTax` number, required — Taxa de juros mensal
        - `installmentsValue` number — Valor da parcela
        - `iofValue` number — Valor do IOF
        - `grossValue` number — Valor financiado
        - `firstPaymentDate` string — Data da primeira parcela
        - `cet` number — Custo efetivo total anual
        - `releasedDate` string — Data da Liberação do empréstimo
      - Card
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `international` boolean — Internacional
        - `annuity` number — Valor da anuidade
        - `network` 'VISA' | 'MASTERCARD' | 'ELO' — Bandeira do Cartão de crédito
        - `prepaid` boolean — Cartão pré pago
        - `digitalAccount` boolean — Conta Digital
      - Auto
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `value` number, required — Valor do empréstimo
        - `installments` integer, required — Número de parcelas
        - `monthlyTax` number, required — Taxa de juros mensal
        - `installmentsValue` number — Valor da parcela
        - `iofValue` number — Valor do IOF
        - `grossValue` number — Valor financiado
        - `firstPaymentDate` string — Data da primeira parcela
        - `cet` number — Custo efetivo total anual
        - `releasedDate` string — Data da Liberação do empréstimo
      - Home
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `value` number, required — Valor do empréstimo
        - `installments` integer, required — Número de parcelas
        - `monthlyTax` number, required — Taxa de juros mensal
        - `installmentsValue` number — Valor da parcela
        - `iofValue` number — Valor do IOF
        - `grossValue` number — Valor financiado
        - `firstPaymentDate` string — Data da primeira parcela
        - `cet` number — Custo efetivo total anual
        - `releasedDate` string — Data da Liberação do empréstimo
      - FinancingAuto
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `value` number, required — Valor do empréstimo
        - `installments` integer, required — Número de parcelas
        - `monthlyTax` number, required — Taxa de juros mensal
        - `installmentsValue` number — Valor da parcela
        - `iofValue` number — Valor do IOF
        - `grossValue` number — Valor financiado
        - `firstPaymentDate` string — Data da primeira parcela
        - `cet` number — Custo efetivo total anual
        - `releasedDate` string — Data da Liberação do empréstimo
      - Debt
        - `customerServiceNumber` string, required — Número de serviço da solicitação
        - `type` 'LOAN' | 'CARD' | 'REFINANCING_AUTO' | 'REFINANCING_HOME' | 'FINANCING_AUTO' | 'CAAS' | 'WORKING_CAPITAL' | 'DEBT', required — Tipos de produtos disponíveis para o usuário
        - `product` string, required — Nome do produto
        - `product_id` integer, required — Id do produto
        - `hasDocuments` boolean, required — Informa se a proposta já possui os documentos
        - `hasContracts` boolean, required — Informa se a proposta já possui os contrato a ser assinado
        - `logo` string, required — Logo do produto
        - `lastStatus` 'PRE_PROCESSAMENTO' | 'PRE_APROVADO' | 'PENDENTE' | 'AGUARDANDO_DOCUMENTOS' | 'EM_ANALISE_MANUAL' | 'EM_ANALISE_OPERACIONAL' | 'EM_ANALISE_DOCUMENTAL' | 'CONTRATADO' | 'LIBERADO' | 'REPROVADO' | 'ESTORNO' | 'EXPIRADO' | 'APROVADO', required — Estados de análise
        - `pendentDocuments` PendentDocuments[]
        - `dateCreated` string, required — Data da criação da proposta
        - `lastUpdated` string, required — Data da última atualização da proposta
        - `value` number, required — Valor do empréstimo
        - `installments` integer, required — Número de parcelas
        - `monthlyTax` number, required — Taxa de juros mensal
        - `installmentsValue` number — Valor da parcela
        - `iofValue` number — Valor do IOF
        - `grossValue` number — Valor financiado
        - `firstPaymentDate` string — Data da primeira parcela
        - `cet` number — Custo efetivo total anual
        - `releasedDate` string — Data da Liberação do empréstimo

## Other responses

- `400` — Data validation error
- `401` — Unauthorized
- `403` — Forbidden
- `404` — The specified resource was not found
- `409` — Conflict - request can't be executed for user

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/versions/f94d262a8f58/schema)