Documentação B2B
Start typing to search…

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**

Query Params Opcional

Para habilitar o retorno de informações complementares relacionadas a proposta.

Para habilitar o retorno de informações complementares relacionadas a proposta, fornecemos o recurso adicional de metadata, com esse parâmetro adicionado é possível obter o retorno do campo metadata na response quando ele existir.

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

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

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

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

Exemplo de Request e Response

curl --location --request GET '{{url_base}}/proposals/{{proposalId}}/status' \
--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"
        }
    ]
}
{
    "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. O response é formado pelas seguintes informações:


Detalhamento nível steps

Campos do status da proposta Retorno Descrição

steps

Obrigatório

Lista de etapas referentes ao detalhamento da proposta.

Detalhamento do objeto de retorno

Campos de steps Retorno Descrição

steps - name

Obrigatório

Nome da etapa.
Observação:
1 - Possíveis etapas no detalhamento abaixo.

steps -startedAt

Obrigatório

Data e hora que a etapa foi iniciada.

steps - finishedAt

Opcional

Data e hora que a etapa foi finalizada.
Observação:
1 - Será preenchido o valor quando a etapa for finalizada.

steps - rejectionReason

Opcional

Motivo 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.

metadata

Opcional

Objeto 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.

StatusDescriçã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_QUALIFICATIONFoi feita uma pré-qualificação da proposta.
PROCESSES_AND_DOCUMENTSEtapa seguinte à pré-qualificação, quando a Creditas confirma as informações com o cliente, tira dúvidas e recebe a documentação necessária para a análise de crédito.
CREDIT_ANALYSISEtapa onde é realizada a análise de crédito considerando o perfil de crédito do cliente + condições de empréstimo desejadas. O resultado final das condições comerciais do empréstimo é apresentado após a vistoria do imóvel, quando teremos o valor exato da garantia.
COLLATERAL_INSPECTIONMomento em que é realizado o laudo para avaliar o imóvel colocado como garantia. Após essa etapa teremos o valor final do imóvel, podendo ocorrer variação no valor liberado na análise de crédito.
LEGAL_ANALYSISEssa etapa é um compilado de toda a análise da proposta, (cliente + imóvel), podendo ser necessário mais documentos para prosseguir com a proposta. Sendo a análise jurídica aprovada, faremos a confirmação dos valores para emissão do contrato.
CONTRACTEtapa onde todos os processos e condições finais da proposta foram aprovadas e precisamos da assinatura do contrato. A assinatura pode ser feita de forma digital, o que agiliza o andamento da etapa.
CONTRACT_REGISTRATIONEtapa seguinte à coleta de assinatura, o contrato é protocolado em cartório para registro. O prazo aqui pode sofrer variação de 15/30 dias, se não houver pendências e é de responsabilidade do cartório.
LOAN_PAYMENTApós registro do contrato, faz-se a quitação das dívidas condicionadas (se houver) e seguimos para a liberação do desembolso da proposta na conta do cliente.

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui

Updated 25 days ago