Documentação API

Callbacks opcionais

São requisições que faremos em determinados pontos no processo de assinatura para evitar chamadas desnecessárias de consulta via API. Para configurar o callback é necessário entrar em contato conosco.

Mudança no status da parte:

Descrição: Toda vez que o status da parte for alterado, o sistema faz callback para os clientes que possuam algum documento vinculado a esta parte.

PAYLOAD enviado via REQUEST:

Estrutura Json:

{
    "id_externo": "c1e13e5354b64bd98bc87153099539fa",
    "id_status_parte": "1"
}
    

Parte assinou documento:

Descrição: Quando a parte assinar o documento pela plataforma, o sistema faz callback para alertar que a parte assinou o documento.

PAYLOAD enviado via REQUEST:

Estrutura Json:

{
    "id_externo_documento": "a06d7d0ad11f4c3bb2da997712b15453",
    "id_externo_contato": "75363f53c34947bc86045f2aacfaa994",
    "identificador_assinatura": "0443c7a6-885b-4d24-a6ad-c053f063a7c6"
}
    

Parte recusou assinar documento:

Descrição: Quando a parte se recusar a assinar o documento pela plataforma, o sistema faz callback para alertar. No payload vai o motivo que a parte deve obrigatoriamente escolher e uma descrição se ela quiser preencher. O ato de recusar assinar um documento não invalida de forma alguma o documento ou a parte, ela pode recusar e depois assinar se quiser, isso funciona apenas como um alerta para o solicitante do documento.

PAYLOAD enviado via REQUEST:

Estrutura Json:

{
    "id_externo_documento": "a06d7d0ad11f4c3bb2da997712b15453",
    "id_externo_contato": "75363f53c34947bc86045f2aacfaa994",
    "motivo_recusa": "motivo selecionado pela parte ao recusar assinatura",
    "descricao": "descrição escrita pelo usuário"
}
    

Documento Assinado:

Descrição: Quando a última parte assinar o documento e este estiver assinado por todas as partes, o sistema faz callback alertando que o documento foi assinado por todas as partes com sucesso. No payload é informado o ID_EXTERNO do documento assinado, além de um Array com todas as partes e os dados de suas respectivas assinaturas.

PAYLOAD enviado via REQUEST:

Estrutura Json:

{
    'dados': {
        'documento': {
            'id_externo': 'd80e42797d594236a52f623e2b73be02'
        }
        'partes': Array< AssinaturaParte >
    }
}
    

Documento invalidado:

Descrição: Se o documento for invalidado pela plataforma, o sistema faz callback alertando que o documento foi invalidado e com um motivo pelo qual isso aconteceu.

PAYLOAD enviado via REQUEST:

Estrutura Json:

{
    'dados': {
        'documento': {
            'id_externo': 'ID do documento',
            'motivo': 'descrição do motivo'
        }
    }
}