Status da Solicitação 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 consultar o status do lead v2

Request HTTP GET

Request Headers

Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.
É necessária a utilização do header: Accept: application/vnd.creditas.v2+json

📘

Atenção

Para utilizar corretamente essa versão é necessário seguir o header conforme a informação acima ⬆️

Request Path com Id da proposta

Query Params Opcional

Para habilitar o retorno de informações complementares relacionadas a proposta, fornecemos o recurso adicional de links, com esse parâmetro adicionado é possível obter informações adicionais quando estiver disponíveis de acordo com o andamento da proposta.

No endpoint será necessário adicionar o parâmetro includes, veja o exemplo:

Exemplo de Request e Response

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

{
    "steps": [
        {
            "startedAt": "2022-03-03T18:28:57.920968",
            "finishedAt": "2022-03-03T18:28:57.920968",
            "name": "PROPOSAL_CREATED"
        },
        {
            "startedAt": "2022-03-03T18:28:58.920968",
            "finishedAt": "2022-03-03T18:28:57.920968",
            "name": "LOAN_PROPOSAL_ANALYSIS"
        },
        {
            "startedAt": "2022-03-04T18:28:58.920968",
            "finishedAt": "2022-03-03T18:28:57.920968",
            "name": "LOAN_PAYMENT"
        }
    ],
    "links": [
        {
            "rel": "credit-approved",
            "type": "GET"
        },
        {
            "rel": "payment-approved",
            "type": "GET"
        }
    ]
}

{
    "steps": [
        {
            "startedAt": "2022-12-12T10:37:21.195178",
            "finishedAt": "2022-12-12T10:37:21.195179",
            "name": "PROPOSAL_CREATED"
        },
        {
            "rejectionReason": "OUT_OF_POLICY",
            "startedAt": "2022-12-12T10:37:21.195182",
            "finishedAt": "2022-12-12T10:37:26.267538",
            "name": "PRE_QUALIFICATION"
        }
    ]
}

Informações sobre o endpoint

Com o endpoint de status v2 é possível acompanhar o andamento da proposta e entender quais links estão disponíveis.

❗️

Atenção

Este endpoint está sujeito a um rate limit de até 15 requisições diárias por lead. Requisições adicionais serão bloqueadas após esse limite, retornando erro com o código TOO_MANY_REQUESTS_ERROR.

O response é formado pelas seguintes informações:

Detalhamento nível steps, links e metadata

Detalhamento do objeto de retorno

Detalhamento dos Steps

Os steps correspondem às informações mais detalhadas da proposta na esteira.

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

Detalhamento dos Links Disponíves

Os links correspondem às informações complementares que podem ser consultadas de acordo com cada situação.

Veja abaixo os possíveis retornos e link do detalhamento.

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui