Essa seção descreve como é possível obter o acompanhamento da solicitação criada através dos status ao longo do processo na esteira do produto.
Para efetuar essa consulta é necessário ter uma proposta criada e ter recebido o identificador (proposal_id) dessa solicitação.

Como funciona a esteira de Auto e os retornos do STATUS

Informações sobre o endpoint

Com o endpoint de status é possível acompanhar o andamento da proposta e e obter o detalhamento das condições de crédito aprovado e pagamento da proposta. O response é formado pelas seguintes informações:

Campos do status da proposta	Descrição
`id`	id da proposta
`status`	Status macro da etapa em que a proposta se encontra
`steps`	Informações adicionais da proposta que podem ocorrer de forma cross aos steps ou são informações mais detalhadas de um determinado step
`feeds`	Informações adicionais sobre o andamento nos steps de vistoria, proposta negada e proposta recuperada
`creditAnalysis`	Detalhamento das condições de crédito aprovado
`payment`	Detalhamento das condições do pagamento realizado

Exemplo de Response

{
    "id": "B2B-6FD9C344...",
    "status": "PAID",
    "steps": [...],
    "feeds": [...],
    "creditAnalysis": {...},
    "payment": {...}
}

Detalhamento dos Steps

Os steps correspondem às etapas mais detalhadas da proposta na esteira, à partir dos status (descritos aqui).
Quando a etapa é realizada, o campo retorna como preenchido, contendo data e hora na qual ocorreu. Se a etapa retorna sem vazia, significa que a etapa ainda não foi realizada.

Veja abaixo os possíveis retornos e descrição.

Step	Descrição
`PROPOSAL_CREATED`	A proposta foi criada na Creditas.
`PRE_QUALIFICATION`	Realização de algumas validações iniciais do cliente e do carro para pré-qualificar a proposta, por exemplo: região atendida, dados da garantia e renda informado, score do cliente.
`PROCESSING`	É quando a Creditas precisa coletar mais informações da ficha, necessárias para a análise de crédito.
`LOAN_PROPOSAL_ANALYSIS`	Análise que leva em consideração o perfil de crédito do cliente + condições de empréstimo desejadas. O resultado final das condições comerciais do empréstimo pode variar após a vistoria ou se houver troca da carro, uma vez que o valor do carro poderá ser alterado.
`DOCUMENTS`	Etapa onde é feita a análise dos documentos do cliente e a vistoria do veículo. A vistoria é feita através de uma empresa terceira e, na maioria dos casos, ocorre digitalmente.
`COLLATERAL_INSPECTION`	Em COLLATERAL_INSPECTION é possível consultar o (link de vistoria) para informar ao cliente.
`CONTRACT`	Com todos os processos aprovados e as condições finais da proposta aceita, precisamos da assinatura do contrato. A assinatura é feita de forma digital, o que agiliza o andamento desta etapa.
`LOAN_PAYMENT`	Liberação do recurso na conta do cliente.

Detalhamento dos Feeds

Os feeds são informações adicionais da proposta que podem ocorrer de forma cross aos steps ou são informações mais detalhadas de um determinado step. Veja abaixo os possíveis retornos e descrição:

Feed Name	Descrição
`PROPOSAL_CREATED`	Recebemos a solicitação e a proposta foi criada com sucesso.
`DOCUMENTS_PENDING`	Aguardamos o envio de documentos. Recomendamos que direcione o cliente para conferir a (lista completa dos documentos) necessários para a análise de crédito. É possível enviá-los por e-mail para seu contato na Creditas.
`DOCUMENT_REQUIRED`	Documentos para análise estão pendentes.
`DOCUMENTS_SENT`	Documentos enviados para análise.
`DOCUMENT_FINISHED`	Documentos finalizados.
`INSPECTION_CREATED`	A vistoria do veículo foi iniciada. Pode ocorrer mais de uma vez. Nesse momento é possível consultar o link de vistoria para informar ao cliente.
`INSPECTION_REFUSED`	A vistoria foi recusada pelo time de avaliadores. Pode ocorrer a criação de uma nova vistoria.
`INSPECTION_RETRIED`	Uma nova vistoria do veículo foi iniciada.
`INSPECTION_APPROVED`	A vistoria do veículo foi aprovada.
`INSPECTION_FINALIZED`	A vistoria do veículo finalizada.
`CREDIT_APPROVED`	A proposta foi aprovada em crédito, entraremos em contato com o cliente para confirmar as condições comerciais. A proposta comercial pode ser alterada caso haja alterações na garantia ou que influenciem a capacidade de pagamento, como comprovação de renda do cliente, havendo assim uma nova análise de crédito.
`CONTACT_ATTEMPT_SUCCESS`	Tivemos sucesso no contato com cliente pelo canal <whatsapp, email, chat ou telefone>. Conseguimos falar com o cliente.
`CONTACT_ATTEMPT_WITHOUT_SUCCESS`	Não tivemos sucesso no contato com cliente pelo canal <whatsapp, email, chat ou telefone>. Tentaremos entrar em contato com o cliente novamente.
`AUTO_CONTRACT_SIGNED`	O contrato foi assinado. Em média o desembolso na conta do cliente ocorre em até 2 dias úteis. Se necessário entraremos em contato
`CONTRACT_SENT`	Contrato foi enviado para assinatura. Recomendamos que acompanhe com o cliente se existem eventuais dúvidas
`REJECTED`	A proposta foi negada. Entenda os motivos de rejeição.
`REVIVAL`	A proposta chegou a ser descontinuada na esteira, mas foi reativada.

Exemplo de Response - objeto Feed

{
    "id": "B2B-96B9ACA1...",
    "status": "REJECTED",
    "steps": [...],
    "feeds": [
        {
            "id": "e404062e-549c-4db1-8158-ec9d06ba75af",
            "description": "OUT_OF_POLICY",
            "createdAt": "2021-09-21T20:52:42.493031",
            "name": "REJECTED"
        }
    ]
}

Motivos de rejeição

Entenda os possíveis motivos de rejeição, eles serão retornados no objeto feed.

Motivo	Descrição
`BACEN_INCOME_COMMITMENT`	Proposta fora da política interna: elevado comprometimento de renda com os valores das parcelas existentes.
`CLOSED_WITH_COMPETITOR`	Fechou com a concorrência.
`CODE_ALLOWED`	Garantia fora da política interna: modelo não aceito.
`CONTACT_ATTEMPT_NOT_SUCCESS`	Contato sem sucesso.
`DROP OUT`	Motivo da desistência não informado.
`DROP_OUT_AUTO_TRANSFER_NAME`	Cliente desistiu da proposta: não quer, ou não consegue transferir o carro para o seu nome.
`DROP_OUT_HIGH_VALUE`	Cliente desistiu por valor alto do empréstimo.
`DROP_OUT_INSUFfICIENT_VALUE`	Cliente desistiu da proposta: valor liberado é insuficiente.
`DROP_OUT_UNINTEREST`	Cliente sem interesse no momento.
`DROP_OUT_UNINTEREST_DONT_WANT_TO_ALIENATE_VEHICLE`	Cliente não quer alienar o carro.
`DROP_OUT_UNINTEREST_GOT_RESOURCE_IN_ANOTHER_WAY`	Cliente desistiu do empréstimo.
`DROP_OUT_UNINTEREST_INSTALLMENTS`	Cliente sem interesse no número de parcelas.
`DROP_OUT_UNINTEREST_LOAN`	Cliente sem interesse no empréstimo.
`DROP_OUT_UNINTEREST_ONLY_EXPLORING`	Cliente estava apenas simulando.
`DROP_OUT_UNINTEREST_VEHICLE_SOLD`	Carro do cliente foi vendido.
`DROP_OUT_UNINTEREST_WANTS_AN_EASIER_PROCESS`	Cliente desejava um processo de empréstimo mais simples.
`EXCLUSION_BY_CLIENT`	Exclusão de dados solicitada pelo cliente.
`EXPIRED_PROPOSAL`	Proposta expirada por falta de atendimento.
`NEWLY_EMPLOYED`	Proposta fora da política interna: cliente possui menos de 6 meses de atuação no ramo.
`OUT_OF_POLICY`	Proposta fora da política interna.
`OUT_OF_POLICY_CAR_CREDIT`	Garantia fora da política interna: débitos em aberto acima do aceito.
`OUT_OF_POLICY_CAR_LIEN`	Garantia fora da política interna: valor liberado é menor que o valor restante do finaciamento do carro em garantia.
`OUT_OF_POLICY_CLIENT_LIMIT_AGE`	Proposta fora da política interna: idade máxima, incluindo prazo de empréstimo, deve ser 75 anos.
`OUT_OF_POLICY_CONTACT_CONSULTANT`	Garantia fora da política interna: motivo não pode ser aberto. Fale com seu ponto de contato na Creditas para mais informações.
`OUT_OF_POLICY_CREDIT`	Proposta fora da política interna: cliente possui débitos em aberto acima do aceito.
`OUT_OF_POLICY_DATA_NOT_PROVEN`	Proposta fora da política interna: não foi possível confirmar os dados do cliente.
`OUT_OF_POLICY_DOCUMENTS`	Proposta fora da política interna: problemas com a documentação do cliente.
`OUT_OF_POLICY_DOESNT_HAVE_A_CAR`	Proposta fora da política interna: cliente não possui carro.
`OUT_OF_POLICY_INCOME_LOW_CREDIT`	Proposta fora da politica interna: renda abaixo do valor aceito.
`OUT_OF_POLICY_LOW_INCOME`	Proposta fora da política interna: score abaixo do valor aceito.
`OUT_OF_POLICY_NOT_DETERMINED`	Proposta fora da política interna: motivo não pode ser aberto.
`OUT_OF_POLICY_VEHICLE_AUCTION`	Garantia fora da política interna: carro de leilão com nível de sucateamento acima do aceito.
`OUT_OF_POLICY_VEHICLE_DEBT`	Garantia fora da política interna: carros possui débitos em aberto acima do aceito.
`OUT_OF_POLICY_VEHICLE_IN_BEHALF_OF_PJ`	Garantia fora da política interna: carro em nome de pessoa jurídica.
`OUT_OF_POLICY_VEHICLE_MODEL`	Garantia fora da política interna: modelo de carro não aceito.
`OUT_OF_POLICY_VEHICLE_REGISTERED_TO_THIRD_PART`	Garantia fora da política interna: carro em nome de terceiros.
`OUT_OF_POLICY_VEHICLE_YEAR`	Garantia fora da política interna:aceitamos carros com até 15 anos do ano de fabricação.
`SCORE`	Proposta fora da política interna: score abaixo do valor aceito.
`VEHICLE_IQ`	Proposta fora da política interna: valor pré-aprovado insuficiente para quitar a dívida do carro em garantia.

Como consultar o status do lead

Request HTTP GET

Tipo da Requisição	URL	Exemplo
`GET`	{{url_base}}/proposals/:proposalId/status	https://stg-api.creditas.io/b2b/proposals/:proposalId/status

Request Headers

Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.

Request Path com Id da proposta

Path	Obrigatório	Descrição
`:proposalId`	Sim	Id da proposta que deseja consultar. Ex: `B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0` O id deve ser preenchido como path da url. Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/status

Path

Obrigatório

Descrição

:proposalId

Sim

Id da proposta que deseja consultar.
Ex: B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0

O id deve ser preenchido como path da url.
Ex: https://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/status

Campos do response - objeto creditAnalysis

Campo	Tipo	Descrição
`approvedAt`	date (YYYY-MM-DD)	Data da aprovação de crédito
`installment.value`	`currency`: string `amount`: double	Valor de cada parcela do empréstimo
`installment.maturity`	double	Quantidade de parcelas
`approvedCredit`	`currency`: string `amount`: double	Valor total do crédito aprovado
`netValues`	`currency`: string `amount`: double	Valor total a ser pago (maturity * value)
`iof`	`currency`: string `amount`: double	Imposto sobre operações financeiras
`registrationFee`	`currency`: string `amount`: double	Taxa de abertura de crédito
`cet`	`monthlyPercentage`: double `yearlyPercentage`: double	Custo efetivo total
`interestRate`	`monthlyPercentage`: double `yearlyPercentage`: double	Taxa de juros

Campos do response - objeto payment

Campo	Tipo	Descrição
`paidAt`	date (YYYY-MM-DD)	Data do desembolso do crédito
`installment.value`	`currency`: string `amount`: double	Valor de cada parcela do empréstimo
`installment.maturity`	double	Quantidade de parcelas
`paidValue`	`currency`: string `amount`: double	Valor total do desembolso
`netValues`	`currency`: string `amount`: double	Valor total a ser pago (maturity * value)
`iof`	`currency`: string `amount`: double	Imposto sobre operações financeiras
`registrationFee`	`currency`: string `amount`: double	Taxa de abertura de crédito
`cet`	`monthlyPercentage`: double	Custo efetivo total
`interestRate`	`monthlyPercentage`: double	Taxa de juros

Exemplo de Request e Response

curl --location --request GET '{{url_base}}/proposals/{{proposalId}}/status' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "id": "B2B-8B690D16-7904-49CE-A409-1813FF27C2D2",
    "status": "PAID",
    "steps": [
        {
            "progress": {
                "startedAt": "2022-03-21T19:44:26.035360",
                "finishedAt": "2022-03-21T19:44:26.035362"
            },
            "name": "PROPOSAL_CREATED"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T19:44:29.105658",
                "finishedAt": "2022-03-21T19:44:34.611584"
            },
            "name": "PRE_QUALIFICATION"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T19:44:34.612501",
                "finishedAt": "2022-03-21T19:49:07.834178"
            },
            "name": "PROCESSING"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T19:49:07.836133",
                "finishedAt": "2022-03-21T19:57:40.670115"
            },
            "name": "LOAN_PROPOSAL_ANALYSIS"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T19:57:40.666732",
                "finishedAt": "2022-03-21T20:28:17.556491"
            },
            "name": "DOCUMENTS"
        },
        {
            "progress": {},
            "name": "COLLATERAL_INSPECTION"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T20:28:17.558093",
                "finishedAt": "2022-03-21T20:34:06.787396"
            },
            "name": "CONTRACT"
        },
        {
            "progress": {
                "startedAt": "2022-03-21T20:34:06.789213",
                "finishedAt": "2022-03-21T20:34:06.789216"
            },
            "name": "LOAN_PAYMENT"
        }
    ],
    "feeds": [
        {
            "id": "0caeffa2-d7be-4d85-a5db-43ec85919bdb",
            "description": "CONTACT_PHONE",
            "createdAt": "2022-03-21T19:59:47.658887",
            "name": "CONTACT_ATTEMPT_SUCCESS"
        },
        {
            "id": "cd5380c0-e1b5-4524-9795-bb10906244fe",
            "createdAt": "2022-03-21T19:57:40.653651",
            "name": "CREDIT_APPROVED"
        },
        {
            "id": "c45b2077-38f0-41d8-b6b2-0ab2fd1941a7",
            "description": "CONTACT_WHATSAPP",
            "createdAt": "2022-03-21T20:00:12.600781",
            "name": "CONTACT_ATTEMPT_WITHOUT_SUCCESS"
        },
        {
            "id": "cf566b59-409f-4b3a-847d-6769d637268d",
            "createdAt": "2022-03-21T20:29:09.559413",
            "name": "AUTO_CONTRACT_SIGNED"
        },
        {
            "id": "65afd64e-2592-4fdd-a477-97b24c1070e2",
            "createdAt": "2022-03-21T20:24:22.051416",
            "name": "CONTRACT_SENT"
        }
    ],
    "creditAnalysis": {
        "approvedAt": "2022-03-21T17:26:55.000000",
        "application": {
            "installment": {
                "value": {
                    "currency": "BRL",
                    "amount": 2080.95
                },
                "maturity": 48
            },
            "approvedCredit": {
                "currency": "BRL",
                "amount": 50000.0
            },
            "netValues": {
                "currency": "BRL",
                "amount": 99885.59999999999
            },
            "iof": {
                "currency": "BRL",
                "amount": 1562.27
            },
            "registrationFee": {
                "currency": "BRL",
                "amount": 2000.0
            },
            "cet": {
                "monthlyPercentage": 3.06,
                "yearlyPercentage": 0.00
            },
            "interestRate": {
                "monthlyPercentage": 2.74,
                "yearlyPercentage": 38.32
            }
        }
    },
    "payment": {
        "paidAt": "2021-03-22T00:00:00.000000",
        "loan": {
            "installment": {
                "value": {
                    "currency": "BRL",
                    "amount": 414.05
                },
                "maturity": 48
            },
            "paidValue": {
                "currency": "BRL",
                "amount": 50000.0
            },
            "netValues": {
                "currency": "BRL",
                "amount": 19874.398
            },
            "iof": {
                "currency": "BRL",
                "amount": 469.74
            },
            "registrationFee": {
                "currency": "BRL",
                "amount": 2000.0
            },
            "cet": {
                "monthlyPercentage": 0.02
            },
            "interestRate": {
                "monthlyPercentage": 0.03
            }
        }
    }
}

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui