Status da Solicitação

🚧

Esta funcionalidade será desabilitada para novas integrações!

Orientamos que seja utilizado nosso novo endpoint otimizado para consulta de status v2


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

1253

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

Recebemos a solicitação para criação da proposta. Se a criação ocorrer o step ira finalizar com sucesso, caso houver algum problema, o mesmo será atualizado com motivo de rejeição. Solicitações negadas nesse step não podem ser revividas.

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.

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.

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"
        }
    ]
}


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



Detalhes dos Motivos de Recusa

Para mais detalhes consulte os motivos de recusa aqui.\


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


Campos do response - objeto creditAnalysis

Campo

Tipo

Descrição

approvedAt

date (yyyy-MM-dd'T'HH:mm:ss.SSSSSS)

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'T'HH:mm:ss.SSSSSS)

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": "cd5380c0-e1b5-4524-9795-bb10906244fe",
            "createdAt": "2022-03-21T19:57:40.653651",
            "name": "CREDIT_APPROVED"
        },
        {
            "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