Send Reset Phone OTP - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/customer/otps/reset-phone \ --header 'Content-Type: application/json' \ --data ' { "phoneIso": "BR", "phoneDdi": "55", "phoneNumber": "11987654321" } '

{ "otpId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "code": "<string>", "recipient": "<string>", "expiresAt": "2023-11-07T05:31:56Z", "usedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z" }

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation.

Body

application/json

Request RESET_PHONE OTP.

phoneIso

string

required

Phone ISO country code.

Example:

"BR"

phoneDdi

string

required

International dialing code.

Example:

"55"

phoneNumber

string

required

Phone number without country code.

Example:

"11987654321"

Response

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