Skip to main content
POST
/
otps
/
{otpId}
Validar OTP
curl --request POST \
  --url https://api.example.com/otps/{otpId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": "<string>",
  "context": "<string>",
  "code": "<string>"
}
'
// No content — OTP validated successfully
Valida um codigo de senha de uso unico. Apos validacao bem-sucedida, prossiga para o endpoint de conclusao apropriado baseado no contexto do OTP. 
curl -X POST https://api.awsales.io/studio/otps/019525fe-8f80-7afa-f2be-0c2d4e6a8b0e \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "user@example.com",
    "context": "MAGIC_AUTH",
    "code": "123456"
  }'

​
Parametros de Rota

​
otpId
string
required
O identificador da solicitacao OTP retornado por Enviar OTP.

​
Corpo da Requisicao

​
recipient
string
required
O endereco de email ou numero de telefone do destinatario. Must match the one used in Send OTP.
​
context
string
required
Deve corresponder ao contexto usado no envio. Um de: EMAIL_VERIFICATION, MAGIC_AUTH, RESET_PASSWORD.
​
code
string
required
O codigo OTP recebido pelo destinatario.

​
Resposta

// No content — OTP validated successfully

​
Proximos Passos

Apos validacao bem-sucedida, chame o endpoint apropriado para completar o fluxo:
ContextoProximo Endpoint
EMAIL_VERIFICATIONVerificacao de Email
MAGIC_AUTHSign In Magic Auth
RESET_PASSWORDRedefinir Senha

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
400auth.invalid_codeCodigo OTP invalido ou expirado
500internal_server_errorOcorreu um erro inesperado

​
Respostas Especiais 403

A verificacao de OTP pode retornar 403 com sub-codigos especificos que requerem acao adicional:
CodigoDescricaoAcao Necessaria
auth.organization_selection_requiredUsuario pertence a multiplas organizacoesChame Trocar Organizacao
auth.method_not_allowedMetodo de autenticacao nao permitido pela organizacaoUse the correct auth flow