Verificação de assinatura

O passo do tipo assinatura pode ser usado para verificar assinatura no Portal do Cliente, Portal Empresa e Backoffice

Parâmetros de configuração

• Tipo de assinatura - Pode ser operador ou cliente;
• Permissão - Pode ser aprovador, financeiro ou backoffice.
• Exigir oferta atual - Com essa opção ativada, a assinatura será verificada somente se a oferta atual for igual a do momento da assinatura.

Exemplos

Averbação do RH

Quando o passo está pendendo, um botão de “Averbar” será exibido no Porta da Empresa. Também é possível executar a assinatura por API.

Configurar averbação do RH

Pela API

Para solicitar averbação do RH, configure o passo da seguinte forma:

curl --request POST \
    --url https://api.base39.io/v1/products/<id> \
    --header 'authorization: Basic <sua-api-key>' \
    --data '
    {
        "settings": {
            "steps": {
                "averbacao": {
                    "title": "Averbação"
                    "type": "signature",
                    "methodData": {
                        "type": "operator",
                        "role": "approver"
                    },
                },
                // ...
            }
        }
    }
    '

Pelo Console

Consultar empréstimos disponíveis para averbação

Pelo Portal da Empresa

Uma lista de empréstimos para averbar sempre é exibida da página de empréstimos acima de todos os outros empréstimos.

Pela API

Para verificar se uma proposta está disponível para ser averbada, consulte o endpoint Listar etapas do empréstimo da API de Empréstimos.

curl --request GET \
    --url 'https://api.base39.io/v1/steps?status=in_progress&type=signature'

Filtre a resposta pelo methodData.type = "operator" e methodData.role = "approver". Se houver um passo com essas características, a proposta está disponível para ser averbada.

{
    "status": "in_progress",
    "type": "signature",
    "methodData": {
        "type": "operator",
        "role": "approver"
    }
    // ...
}

Pelo Webhook

Para monitorar as propostas disponíveis para averbação, assine o evento step.marked_in_progress e filtre os eventos que atendam esses parâmetros:

{
    "status": "in_progress",
    "type": "signature",
    "methodData": {
        "type": "operator",
        "role": "approver"
    }
    // ...
}

É importante monitorar outros eventos que podem impedir a averbação ou representam o resultado da averbação ou recusa:

• step.marked_failed - o operador da empresa recusou a averbação;
• step.marked_completed - o operador da empresa averbou o empréstimo;
• loan.canceled - o empréstimo foi cancelado;
• loan.expired - o empréstimo expirou;
• loan.void - o empréstimo foi anulado.

Consulte todos os parâmetros do objeto Step na referência da API.

Averbar um empréstimo

Pelo Portal da Empresa

O botão de averbar é exibido quando o passo está pendente e se o usuário logado tem a permissão configurada, nesse caso “aprovador”.

Pela API

Para verificar se uma proposta está disponível para ser averbada, consulte o endpoint Listar etapas do empréstimo da API de Empréstimos.

curl --request GET \
    --url 'https://api.base39.io/v1/steps?status=in_progress&type=signature'

Filtre a resposta pelo methodData.type = "operator" e methodData.role = "approver". Se houver um passo com essas características, a proposta está disponível para ser averbada.

{
    "status": "in_progress",
    "type": "signature",
    "methodData": {
        "type": "operator",
        "role": "approver"
    }
    // ...
}

Para fazer a averbação, utilize o endpoint Assinar empréstimo da API de Empréstimos para averbar um empréstimo.

curl --request POST \
    --url 'https://api.base39.io/v1/loans/<id>/sign'

Quando a assinatura é feita por um operador com a permissão configurada, nesse caso approver, o passo será concluído.