Pular para conteúdo

Verificando o processo de assinatura de um arquivo

O ID do arquivo deverá ser enviado na URL, como descrito abaixo.

URN:

/documento/arquivo/{arquivo}/verificar-assinatura

Método:

GET

Headers:

{
    "Accept": "application/json",
    "Authorization": "Token XXXXXXXXXXXXXXXX"
}

Retorno:

Em solicitações efetuadas com sucesso, o retorno será:

{
    "msg": "Processo de assinatura encontrado com sucesso",
    "status": "sucesso",
    "data": {
        "data_solicitado": "2024-08-06 17:34:28",
        "info": "Documento concluído",
        "status": 3,
        "data_concluido": "2024-08-06 17:40:09"
    }
}
  • data_solicitacao: É a data e horário em que o arquivo foi enviado para o processo de assinatura.
  • info: É a descrição do status.
  • status": É o código que define a situação do processo de assinatura.
  • data_conclusao: Quando o processo estiver concluído, esta chave virá preenchida com data e hora em que o processo foi concluído.

Em casos onde o processo de assinatura não estiver concluído, a chave data_concluido virá com o valor null conforme abaixo:

{
    "msg": "Processo de assinatura encontrado com sucesso",
    "status": "sucesso",
    "data": {
        "data_solicitado": "2024-08-07 08:58:58",
        "info": "Arquivo enviado para o GSign",
        "status": 1,
        "data_concluido": null
    }
}

Lista de status:

Lista de status com suas respectivas descrições:

  • Status: 1
    • Arquivo enviado para o GSign
  • Status: 2
    • Processo de assinatura iniciada
  • Status: 3
    • Documento concluído
  • Status: 4
    • Documento Cancelado

Retorno de erro:

Em solicitações que retornarem erro, a chave "status" vem com o valor "erro" e a causa do erro virá na chave "msg" como abaixo:

{
    "msg": "Arquivo não encontrado",
    "status": "erro",
    "data": []
}

Outro exemplo seria a falta de alguma permissão necessária para efetuar a consulta, como abaixo:

{
    "msg": "Grupo de usuário não tem permissão de consultar dados de assinatura deste modelo",
    "status": "erro",
    "data": []
}