Skip to main content
POST
Consultar status da autorização push VIDaaS
Consulta o status de uma autorização por push iniciada em POST /signer/v1/sign/:sessionToken/vidaas/authorization com mode: push. Use esta chamada repetidamente até que a autorização seja aprovada ou expire. Autenticação: use apenas o sessionToken na URL — nenhum header de autenticação é necessário.

Parâmetros

string
required
Token único da sessão do signatário (obtido em POST /signer/v1/envelopes ou POST /signer/v1/templates/:uuid/envelopes).
string
required
Handle devolvido ao abrir a autorização por push (campo pushCode). Identifica qual autorização você está consultando.

Respostas

string
required
Estado da autorização:
  • pending: a notificação foi enviada mas o signatário ainda não aprovou no aplicativo — situação normal, não é erro. Faça polling novamente após alguns segundos.
  • authorized: a autorização foi concluída com sucesso. Agora você pode chamar POST /signer/v1/sign/:sessionToken/sign.
string
Nome do titular do certificado autorizado. Presente apenas quando status = authorized.
string
CPF/CNPJ do titular do certificado autorizado. Presente apenas quando status = authorized.
string
Vencimento da autorização em ISO-8601. Presente apenas quando status = authorized.

Erros

Veja Autenticação e erros.
  • 400: pushCode inválido ou validação falhou.
  • 410: Session token expirado (envelope expirou ou foi deletado).
  • 502: O VIDaaS não respondeu ou respondeu com erro.
  • 503: Integração VIDaaS não configurada no ambiente.

Exemplo

Importante

  • Sem autenticação por header: o sessionToken é toda a autenticação necessária.
  • Polling: status: pending não é erro — significa que o signatário ainda não aprovou. Implemente polling com intervalo apropriado (ex: a cada 2-5 segundos) e timeout (ex: 5 minutos).
  • Autorização com prazo: a autorização, quando concedida, expira em um prazo — use POST /signer/v1/sign/:sessionToken/sign logo após antes de expirar.

Próximas etapas

Quando status = authorized:
  1. Chame POST /signer/v1/sign/:sessionToken/sign para assinar usando o certificado VIDaaS autorizado.
Se a autorização expirar ou o signatário rejeitar:
  1. Comece um novo fluxo de autorização com POST /signer/v1/sign/:sessionToken/vidaas/authorization.