Skip to main content
POST
Send Reset Phone OTP

Body

application/json

Reset phone OTP request.

phoneIso
string
required

Phone country ISO code.

Example:

"BR"

phoneDdi
string
required

Phone country calling code.

Example:

"55"

phoneNumber
string
required

Phone number without country code.

Example:

"11999999999"

Response

OK

Códigos de uso único para fluxos de verificação

otpId
string<uuid>
required

Identificador único

userId
string<uuid>
required

Referência ao usuário

code
string
required

Credencial protegida do código OTP (nunca armazenado em texto puro)

context
enum<string>
required

Contexto de uso do código

Available options:
RESET_PASSWORD,
RESET_PHONE,
RESET_EMAIL
recipient
string
required

Destinatário da entrega (telefone do usuário)

expiresAt
string<date-time>
required

Data de expiração do código

usedAt
string<date-time> | null
required

Data em que o código foi utilizado

createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

createdAt
string<date-time>
required

Data de criação

updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

updatedAt
string<date-time>
required

Data da última atualização