Status da Solicitação

Essa seção descreve como você pode obter o status da solicitação criada.
Para efetuar essa consulta você precisa ter criado uma solicitação e ter recebido o identificador (lead_id) dessa solicitação.



Tipo de status

Status

Descrição

PENDING

Lead está em pré-análise de crédito

REJECTED

Lead foi rejeitado em algum momento ao longo do processo

ONGOING

Lead foi pré-aprovado e está em andamento

PAID

Lead foi pago



Detalhamento dos Steps

Para uma proposta ser paga precisamos de alguns passos. Para dar feedback para o cliente final disponibilizamos os passos que precisam e foram feitos durante o processo. Quando uma etapa for feita, retornaremos o campo com a data e hora na qual ela foi feita. Se estiver sem data preenchida a etapa não foi feita ainda.

Step

Descrição

Comparação com a versão anterior

PROPOSAL_CREATED

Recebemos a solicitação e o proposta foi criado com sucesso.

PRE_QUALIFICATION

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

PENDING

LOAN_PROPOSAL_ANALYSIS

Etapa seguinte à pré-qualificação, indica que a proposta está em andamento. Essa etapa é encerrada somente quando a proposta é rejeitada/cliente desiste ou quando a proposta é paga

ONGOING

LOAN_PAYMENT

Ocorreu o desembolso da proposta

PAID



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


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-A7472554-CF14-41AD-8F25-3D734D72E886",
    "status": "ONGOING",
    "steps": [
        {
            "rejectionReason": "",
            "progress": {
                "startedAt": "2021-04-27T12:38:12.771767",
                "finishedAt": "2021-04-27T12:38:12.771773"
            },
            "name": "PROPOSAL_CREATED",
            "order": 0
        },
        {
            "rejectionReason": "",
            "progress": {
                "startedAt": "2021-04-27T12:38:12.870347",
                "finishedAt": "2021-04-27T12:38:16.052381"
            },
            "name": "PRE_QUALIFICATION",
            "order": 2
        },
        {
            "rejectionReason": "",
            "progress": {
                "startedAt": "2021-04-27T12:38:16.075969",
                "finishedAt": null
            },
            "name": "LOAN_PROPOSAL_ANALYSIS",
            "order": 3
        },
        {
            "rejectionReason": "",
            "progress": {
                "startedAt": null,
                "finishedAt": null
            },
            "name": "LOAN_PAYMENT",
            "order": 5
        }
    ]
}



Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui