API
Completar autorização QR Code VIDaaS
Conclui o fluxo de QR Code trocando o código de autorização do VIDaaS por uma sessão autorizada.
POST
Completar autorização QR Code VIDaaS
Conclui o fluxo de autorização por QR Code no VIDaaS. Após o signatário ler o QR Code com o aplicativo VIDaaS, o provedor o redireciona de volta para a sua aplicação com um código de autorização — passe-o aqui para trocar por uma autorização confirmada.
Esta chamada verifica o dono do certificado (valida o CPF/CNPJ) e armazena a autorização para que
POST /signer/v1/sign/:sessionToken/sign possa usá-la.
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
Código de autorização devolvido pelo VIDaaS na volta do QR Code. O VIDaaS devolve este código como parâmetro
code na URL de redirecionamento (ex: https://seu-app.com/callback?code=AUTH_CODE&state=...).Respostas
string
required
Sempre
authorized quando a resposta é bem-sucedida.string
required
Nome do titular do certificado autorizado.
string
required
CPF/CNPJ do titular do certificado autorizado.
string
required
Vencimento da autorização em ISO-8601.
Erros
Veja Autenticação e erros.- 400:
codeinválido, expirado ou validação falhou. - 403: O certificado autorizado pertence a outro CPF/CNPJ (o dono do certificado não corresponde ao signatário).
- 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. - Validação do dono: este endpoint verifica que o CPF/CNPJ do certificado autorizado corresponde ao do signatário da sessão. Se não corresponder, retorna 403.
- Código com prazo: o
codedevolvido pelo VIDaaS tem um prazo (tipicamente alguns minutos) — complete esta chamada logo após o redirecionamento. - Autorização com prazo: a autorização, quando concedida, expira em um prazo — use
POST /signer/v1/sign/:sessionToken/signlogo após antes de expirar.
Próximas etapas
Quando a autorização é concluída com sucesso:- Chame
POST /signer/v1/sign/:sessionToken/signpara assinar usando o certificado VIDaaS autorizado.
code for inválido ou expirado:
- Comece um novo fluxo de autorização com
POST /signer/v1/sign/:sessionToken/vidaas/authorization.
- Avise ao signatário que precisa usar um certificado no seu próprio nome.