Status da Solicitação

🚧
Esta funcionalidade será desabilitada para novas integrações!
Orientamos que seja utilizado nosso novo endpoint otimizado para consulta de status 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](/docs/criacao-da-proposta-com-garantia-imovel) e ter recebido o **identificador** (proposal_id) dessa 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](/docs/criacao-da-proposta-com-garantia-imovel) e ter recebido o **identificador** (proposal_id) dessa solicitação.

Como funciona a esteira de Home 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

Detalhamento dos Steps

Os steps correspondem às etapas mais detalhadas da proposta na esteira, a 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 vazia, significa que a etapa ainda não foi realizada.
Veja abaixo os possíveis retornos e descrição.

Step	Descrição
`PROPOSAL_CREATED`	Recebemos 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_QUALIFICATION`	Foi feita uma pré-qualificação da proposta.
`PROCESSES_AND_DOCUMENTS`	Etapa 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_ANALYSIS`	Etapa 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_INSPECTION`	Momento 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_ANALYSIS`	Essa 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.
`CONTRACT`	Etapa 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_REGISTRATION`	Etapa seguinte a 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_PAYMENT`	Apó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.

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
`PROPOSAL_QUALIFIED`	Proposta aprovada na pré-qualificação. Confira aqui a lista completa dos documentos necessários para acelerar a análise de crédito.
`LEAD_CONTACT_ATTEMPT`	Tentativa de contato sem sucesso. Entraremos em contato novamente.
`UNDER_NEGOTIATION`	Proposta em negociação. Estamos em contato para tirar dúvidas e então seguir para as próximas etapas.
`AWAITING_DOCUMENTATION`	Aguardando envio de documentos. Confira aqui a lista completa dos documentos necessários para a análise de crédito.
`CREDIT_ANALYSIS_IN_PROGRESS`	Proposta em análise de crédito. O prazo para conclusão é de até 3 úteis, podendo ser alterado em caso de pendências de documentação.
`CREDIT_ANALYSIS_APPROVED`	Proposta aprovada em crédito. Entraremos em contato para aprovar as condições comerciais. A proposta pode ser alterada após a vistoria do imóvel.
`INSPECTION_IN_PROGRESS`	Aguardando vistoria do imóvel. A avaliação do imóvel (laudo) será feita por uma empresa terceira.
`LEGAL_ANALYSIS_IN_PROGRESS`	Proposta em análise jurídica. Confira aqui a lista completa dos documentos necessários para a análise jurídica.
`CONTRACT_ISSUED`	Aguardando emissão do contrato. O contrato será enviado para avaliação do bancarizador e enviado para assinatura em até 24 horas.
`CONTRACT_WAITING_TO_SIGN`	Aguardando assinatura.

Detalhes dos Motivos de Recusa

Para mais detalhes consulte os motivos de recusa aqui.

Como consultar o status do lead

Request HTTP GET

Tipo da Requisição	URL	Exemplo
`GET`	{{url_base}}/proposals/:proposalId/status	https://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.

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.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "id": "B2B-CE4F0A3B-XXXX-4BB6-XXXX-48B04FE20FDC",
    "status": "PAID",
    "steps": [
        {
            "progress": {
                "startedAt": "2021-11-22T13:34:52.539416",
                "finishedAt": "2021-11-22T13:34:52.539420"
            },
            "name": "PROPOSAL_CREATED"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T13:39:49.076619",
                "finishedAt": "2021-11-22T13:40:20.038128"
            },
            "name": "PRE_QUALIFICATION"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:37:10.161219",
                "finishedAt": "2021-11-22T14:37:39.266181"
            },
            "name": "PROCESSES_AND_DOCUMENTS"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:37:39.274782",
                "finishedAt": "2021-11-22T14:39:05.176878"
            },
            "name": "CREDIT_ANALYSIS"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:39:30.547949",
                "finishedAt": "2021-11-22T14:39:58.028870"
            },
            "name": "COLLATERAL_INSPECTION"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:39:58.040238",
                "finishedAt": "2021-11-22T14:41:35.388756"
            },
            "name": "LEGAL_ANALYSIS"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:41:35.397416",
                "finishedAt": "2021-11-22T14:42:00.078357"
            },
            "name": "CONTRACT"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:42:21.286775",
                "finishedAt": "2021-11-22T14:42:51.404396"
            },
            "name": "CONTRACT_REGISTRATION"
        },
        {
            "progress": {
                "startedAt": "2021-11-22T14:42:51.410400",
                "finishedAt": "2021-11-22T14:42:51.410403"
            },
            "name": "LOAN_PAYMENT"
        }
    ],
    "feeds": [
        {
            "id": "97634d6d-f168-42b8-847b-2b341fb24d60",
            "createdAt": "2021-11-22T14:41:35.406032",
            "name": "CONTRACT_ISSUED"
        },
        {
            "id": "92995592-733c-491a-8f30-6485560eeb66",
            "createdAt": "2021-11-22T14:39:05.181306",
            "name": "CREDIT_ANALYSIS_APPROVED"
        },
        {
            "id": "cf07ffe3-4752-43d5-95f1-79e6dbdd45be",
            "createdAt": "2021-11-22T14:42:21.292321",
            "name": "CONTRACT_SIGNED"
        },
        {
            "id": "fe8d3083-737b-4dee-bb83-2a6a44633265",
            "createdAt": "2021-11-22T14:39:30.746433",
            "name": "INSPECTION_IN_PROGRESS"
        },
        {
            "id": "c5cecee5-5a91-441a-81d0-53661169525c",
            "createdAt": "2021-11-22T14:39:58.050527",
            "name": "LEGAL_ANALYSIS_IN_PROGRESS"
        },
        {
            "id": "f54325ea-24a8-4fd1-a424-a33ddad18e30",
            "createdAt": "2021-11-22T13:40:20.153414",
            "name": "PROPOSAL_QUALIFIED"
        },
        {
            "id": "c8e0d89a-9e25-468b-8237-6d6a115b02c0",
            "createdAt": "2021-11-22T14:42:00.091198",
            "name": "CONTRACT_WAITING_TO_SIGN"
        },
        {
            "id": "3e8e2c7f-3802-436c-a9e1-4e18bb8ef713",
            "createdAt": "2021-11-22T14:37:39.282442",
            "name": "CREDIT_ANALYSIS_IN_PROGRESS"
        }
    ]
}

Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui