Status da Solicitação

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": {...}
}



Tipo de status

Correspondem às etapas macro da proposta na esteira. Veja abaixo os possíveis retornos e descrição:

Status

Descrição

PENDING

A pré-qualificação da proposta ainda não foi executada

REJECTED

A proposta foi rejeitada ao longo da esteira

ONGOING

A proposta foi aprovada na pré-qualificação e segue em andamento na esteira

PAID

A proposta foi paga



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

Comparação com a versão anterior

PROPOSAL_CREATED

Recebemos a solicitação e a proposta foi criada com sucesso

PRE_QUALIFICATION

Foi feita uma pré-qualificação da proposta.

ONGOING

LOAN_PROPOSAL_ANALYSIS

Etapa seguinte à pré-qualificação, indica que a proposta foi aprovada neste step e segue em andamento. Essa etapa é encerrada somente quando a proposta é rejeitada/cliente desiste ou quando a proposta é paga, fora isso, continua como ativa na esteira.

ONGOING

DOCUMENTS

Está habilitado o envio dos documentos principais.

ONGOING

COLLATERAL_INSPECTION

Está habilitada a realização da vistoria do carro.

ONGOING

LOAN_PAYMENT

Ocorreu o desembolso da proposta

PAID



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

Legenda

REJECTED

A proposta foi negada. Entenda os motivos de rejeição.

NEGADA

REVIVAL

A proposta chegou a ser descontinuada na esteira, mas foi reativada

REATIVADA

INSPECTION_CREATED

A vistoria do carro foi iniciada (Pode ocorrer mais de uma vez)

VISTORIA CRIADA

INSPECTION_RETRIED

A vistoria ainda não foi finalizada, uma foto adicional foi solicitada

VISTORIA RETRIADA

INSPECTION_REFUSED

A vistoria foi recusada pelo time de avaliadores (Pode ocorrer a criação de uma nova vistoria)

VISTORIA RECUSADA

INSPECTION_FINALIZED

A vistoria foi aprovada e finalizada

VISTORIA FINALIZADA



Motivos de rejeição

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

Motivo

Descrição

CLOSED_WITH_COMPETITOR

Sem Interesse - Fechou com outro competidor

CONTACT_WITHOUT_SUCCESS

Contato sem sucesso

DROP_OUT

Desistência

OUT_OF_POLICY

Fora da política - Nao elegível

OUT_OF_POLICY_COLLATERAL

Fora da política de inspeção

OUT_OF_POLICY_CREDIT

Fora da política de crédito

OUT_OF_POLICY_VEHICLE_MODEL

Fora da política de modelo de veículo

OUT_OF_POLICY_VEHICLE_YEAR

Fora da política de ano do veículo



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://api.stg.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://api.stg.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

tac

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

tac

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-6FD9C344-7A70-4391-8AB0-C2A6983C4DDC",
    "status": "PAID",
    "steps": [
        {
            "progress": {
                "startedAt": "2021-07-08T13:48:21.328605",
                "finishedAt": "2021-07-08T13:48:22.024574"
            },
            "name": "PROPOSAL_CREATED",
            "order": 0
        },
        {
            "progress": {
                "startedAt": "2021-07-08T13:48:22.936795",
                "finishedAt": "2021-07-08T13:48:24.979890"
            },
            "name": "PRE_QUALIFICATION",
            "order": 1
        },
        {
            "progress": {
                "startedAt": "2021-07-08T13:48:25.039507",
                "finishedAt": "2021-07-08T13:56:24.380311"
            },
            "name": "LOAN_PROPOSAL_ANALYSIS",
            "order": 2
        },
        {
            "progress": {
                "startedAt": "2021-07-08T13:51:01.084284",
                "finishedAt": "2021-07-08T13:55:00.265935"
            },
            "name": "DOCUMENTS",
            "order": 3
        },
        {
            "progress": {},
            "name": "COLLATERAL_INSPECTION",
            "order": 4
        },
        {
            "progress": {
                "startedAt": "2021-07-08T14:56:24.421532",
                "finishedAt": "2021-07-08T14:56:24.421538"
            },
            "name": "LOAN_PAYMENT",
            "order": 5
        }
    ],
    "feeds": [
        {
            "id": "e404062e-549c-4db1-8158-ec9d06ba75af",
            "description": "OUT_OF_POLICY",
            "createdAt": "2021-07-08T13:48:25.039507",
            "name": "REJECTED"
        },
        {
            "id": "b0dad76f-e221-4e02-af04-28aa9bac68c9",
            "description": "PROPOSAL_REVIVAL",
            "createdAt": "2021-07-08T13:49:25.039507",
            "name": "REVIVAL"
        }
    ],
    "creditAnalysis": {
        "approvedAt": "2021-07-08T11:51:01.000000",
        "application": {
            "installment": {
                "value": {
                    "currency": "BRL",
                    "amount": 200.18
                },
                "maturity": 48
            },
            "approvedCredit": {
                "currency": "BRL",
                "amount": 5000.0
            },
            "netValues": {
                "currency": "BRL",
                "amount": 240000.0
            },
            "iof": {
                "currency": "BRL",
                "amount": 175.01
            },
            "tac": {
                "currency": "BRL",
                "amount": 600.0
            },
            "cet": {
                "monthlyPercentage": 2.87,
                "yearlyPercentage": 0.00
            },
            "interestRate": {
                "monthlyPercentage": 2.07,
                "yearlyPercentage": 27.87
            }
        }
    },
    "payment": {
        "paidAt": "2020-08-12T00:00:00.000000",
        "loan": {
            "installment": {
                "value": {
                    "currency": "BRL",
                    "amount": 8572.28
                },
                "maturity": 48
            },
            "paidValue": {
                "currency": "BRL",
                "amount": 5000.0
            },
            "netValues": {
                "currency": "BRL",
                "amount": 411469.44
            },
            "iof": {
                "currency": "BRL",
                "amount": 0.0
            },
            "tac": {
                "currency": "BRL",
                "amount": 600.0
            },
            "cet": {
                "monthlyPercentage": 0.02
            },
            "interestRate": {
                "monthlyPercentage": 0.02
            }
        }
    }
}



Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui