Skip to main content
POST
/
otps
Enviar OTP
curl --request POST \
  --url https://api.example.com/otps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": "<string>",
  "context": "<string>"
}
'
{
  "otpId": "019525fe-8f80-7afa-f2be-0c2d4e6a8b0e"
}
Envia uma senha de uso unico para o endereco de email do destinatario. O otpId retornado e usado nas etapas subsequentes de validacao e conclusao. 
curl -X POST https://api.awsales.io/studio/otps \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "user@example.com",
    "context": "MAGIC_AUTH"
  }'

​
Corpo da Requisicao

​
recipient
string
required
O endereco de email ou numero de telefone do destinatario.
​
context
string
required
O contexto do OTP. Um de: EMAIL_VERIFICATION, MAGIC_AUTH, RESET_PASSWORD.

​
Resposta

​
otpId
string
Identificador unico para a solicitacao OTP. Usado na validacao subsequente.
{
  "otpId": "019525fe-8f80-7afa-f2be-0c2d4e6a8b0e"
}

​
Contextos

ContextoUso
EMAIL_VERIFICATIONVerificar email apos sign-up (tambem usado para reenvio)
MAGIC_AUTHLogin sem senha
RESET_PASSWORDFluxo de redefinicao de senha

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
403auth.method_not_allowedMetodo de autenticacao nao permitido pela organizacao
409auth.email_already_verifiedEmail ja foi verificado
500internal_server_errorOcorreu um erro inesperado