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

Tipo da RequisiçãoURLExemplo
GET{{url_base}}/proposals/:proposalId/statushttps://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.
É 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

PathObrigatórioDescrição
:proposalIdSimId 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

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:

Query param
?includes=linkshttps://stg-api.creditas.io/b2b/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/status?includes=links

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. O response é formado pelas seguintes informações:


Detalhamento nível steps, links e metadata

Campos do status da propostaRetornoDescrição
stepsObrigatórioLista de etapas referentes ao detalhamento da proposta.
linksOpcionalCaso haja alguma informação adicional habilitada para a proposta, retornará dentro de uma lista junto com o verbo http.
Esse campo pode ser requerido passando por query string.
metadataOpcionalCaso haja alguma metadata habilitado para a proposta, retornará no atributo metadata na response

Detalhamento do objeto de retorno

Campos de stepsRetornoDescrição
steps - nameObrigatórioNome da etapa.
Observação:
1 - Possíveis etapas no detalhamento abaixo.
steps -startedAtObrigatórioData e hora que a etapa foi iniciada.
steps - finishedAtOpcionalData e hora que a etapa foi finalizada.
Observação:
1 - Será preenchido o valor quando a etapa for finalizada.
steps - rejectionReasonOpcionalMotivo de rejeição da proposta.
Observações:
1 - Será preenchido valor quando a proposta for negada.
2 - Caso algum step possua esse campo a proposta, como um todo, está rejeitada
3 - Para mais detalhes consulte os motivos de recusa .
links - relOpcionalInformação do link referente ao recurso adicional que poderá ser consultado.

Ex: credit-approved
links - typeOpcionalInformação do método referente ao recurso adicional que poderá ser consultado.

Ex: GET
metadataOpcionalObjeto enviado pelo próprio parceiro na criação da proposta, caso exista um ele ira ser retornado OBS: esse objeto é totalmente custom dependendo sobre o que é enviado pelo parceiro


Detalhamento dos Steps

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

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

StepDescrição
PROPOSAL_CREATEDRecebemos 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_QUALIFICATIONRealizaçã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_ANALYSISAná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.
DOCUMENTSEtapa onde é feita a análise dos documentos do cliente; ela pode acontecer paralelamente à vistoria do veículo.
COLLATERAL_INSPECTIONNessa etapa, o veículo será inspecionado e, caso possua link para vistoria, será disponibilizado através dos links. A vistoria é feita digitalmente, por uma empresa terceira.
CONTRACTCom 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_PAYMENTLiberação do recurso na conta do cliente.


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.

StepDescrição
credit-approved
GET		Link para consulta do detalhamento de condições de crédito aprovado
payment-approved
GET		Link para consulta do detalhamento do pagamento aprovado
inspections
GET		Link para consulta do link de vistória do veículo
documents
POST		Link para envio de documentos


Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui

Updated 3 months ago