Sessão de Assinatura
Enviar código de verificação MFA
Inicia a verificação em duas etapas, enviando um código para o e-mail ou SMS do signatário.
POST
Enviar código de verificação MFA
Inicia a verificação em duas etapas (MFA), enviando um código de 6 dígitos para o e-mail ou SMS do signatário. O canal (e-mail ou SMS) depende do tipo de assinatura configurado no envelope.
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.
string
required
CPF do signatário (com ou sem máscara), confirmando sua identidade antes de enviar o código.
Respostas
enum
Canal de entrega do código:
email ou sms.string
Endereço de destino parcialmente mascarado, ex.:
e***@gmail.com ou ***9876.string
Timestamp (ISO 8601) de quando o código expira (válido por 10 minutos).
Erros
Veja Autenticação e erros.- 400: CPF inválido ou diferente do signatário registrado na sessão.
- 404: Sessão não encontrada.
- 410: Session token expirado.
- 409: Tipo de assinatura não exige MFA, ou código já foi enviado e validado, ou faltam dados (ex.: sem número de celular para SMS).
- 429: Código solicitado há pouco; reenvio só após 60 segundos.
- 503: Provedor de SMS não está configurado (apenas para tipos SMS).
Exemplo
Importante
- Código de 6 dígitos: válido por 10 minutos.
- Reenvio: o código pode ser solicitado de novo, mas com mínimo de 60 segundos de intervalo entre tentativas.
- Apenas para MFA: esta chamada só é necessária se o tipo de assinatura do signatário exigir
MFA_EMAILouMFA_SMS(ou variações com liveness). - CPF obrigatório: confirma identidade antes de enviar o código.
Próximas etapas
- Código enviado para
destination. - Signatário recebe e digita os 6 dígitos.
- Chame
POST .../verification/confirmcom o código.
Relacionado
POST .../verification/confirm— confirmar o códigoGET /signer/v1/sign/:sessionToken— obter estado da sessão (incluirequirements.mfa)POST /signer/v1/sign/:sessionToken/sign— assinar (depois de MFA confirmado)