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.
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.
PAYLOAD enviado via REQUEST:
Estrutura Json:
{
"dados": {
"documento": {
"id_externo": "ID documento"
}
"partes": [
{
"dt_criado": "DD/MM/YYYY HH:MI:SS",
"dt_visualizado": "DD/MM/YYYY HH:MI:SS",
"dt_assinado": "DD/MM/YYYY HH:MI:SS",
"id_externo": "ID da parte",
"identificador_assinatura": "Identificador único da assinatura da parte no documento"
}
]
}
}
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": "ID documento",
"id_status_parte": "ID status parte"
}
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 documento",
"motivo": "descrição do motivo"
}
}
}
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": "ID documento",
"id_externo_contato": "ID contato",
"identificador_assinatura": "identificador assinatura"
}
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": "ID documento",
"id_externo_contato": "ID contato",
"motivo_recusa": "motivo selecionado pela parte ao recusar assinatura",
"descricao": "descrição escrita pelo usuário"
}
Parte preencheu dados
Descrição:
Quando a parte preencher os dados na plataforma (CPF e data de nascimento), o sistema faz callback para alertar e enviar os dados preenchidos.
PAYLOAD enviado via REQUEST:
Estrutura Json:
{
"id_externo": "ID documento",
"cpf": "cpf parte assinante",
"dt_nascimento": "DD/MM/YYYY",
"descricao": "descrição"
}
Parte delegou assinatura
Descrição:
Quando a parte delegar sua assinatura para outra parte durante o processo de assinatura, o sistema faz callback para alertar e enviar os dados da delegação.
PAYLOAD enviado via REQUEST:
Estrutura Json:
{
"id_externo_documento": "ID documento",
"id_externo_delegador": "ID delegador",
"id_externo_delegado": "ID delegado",
"parte_delegado": {
"nome": "nome delegado",
"cpf": "cpf delegado",
"email": "e-mail delegado",
"ddd": "ddd delegado",
"telefone": "telefone delegado"
"id_externo_slot": "ID slot"
"identificacao_parte": "identificação parte"
}
}
Parte visualizou o documento
Descrição:
Quando a parte visualizou o documento, o sistema faz callback alertando que o documento foi visualizado por pela parte com sucesso.
PAYLOAD enviado via REQUEST:
Estrutura Json:
{
"id_externo_documento": "ID documento",
"id_externo_contato": "ID contato",
"dt_visualizado": "DD/MM/YYYY HH:MI:SS"
}
Parte enviou anexo
Descrição:
Quando a parte enviar um arquivo de anexo durante o processo de assinatura, o sistema faz callback para alertar e enviar os dados do anexo.
PAYLOAD enviado via REQUEST:
Estrutura Json:
{
"id_externo_documento": "ID documento",
"id_externo_contato": "ID contato",
"anexo": [
{
"identificacao": "Identificacao simples do anexo.",
"label": "Texto que aparecerá para o usuário explicando o que deve ser enviado. ",
"obrigatorio": "Se o anexo deve ser enviado obrigatoriamente, o parâmetro deve ser 1. O padrão é 0, ou seja, não obrigatorio.",
"posicao": "Vide tabela anexos_posicao.",
"limite_arquivos": "Quantidade de arquivos que podem ser enviados por anexo.",
"arquivos": [
{
"id_documento_parte_anexo": "ID documento parte anexo",
"id_documento_parte": "ID parte",
"id_doc_config_anexo": "ID documento configuração anexo",
"id_status_doc_anexo": "ID status documento",
"nome_arquivo": "nome arquivo",
"caminho_arquivo": "caminho arquivo",
"dt_criacao": "DD/MM/YYYY HH:MI:SS",
"descricao_status_documento_anexo": "descrição do status documento anexo"
}
]
}
]
}