Skip to main content

Validar uma Validação de Telefone

Endpoint

PUT https://api.verifik.co/v2/phone-validations

Confirma o OTP que o usuário recebeu. A Verifik busca a Validação de Telefone mais recente enviada (e não expirada) para esse telefone — incluindo registros manuais / Smart Tools e registros de fluxo de projeto.

Combine com o envio

OTPs independentes são criados com POST /v2/phone-validations/manual. OTPs de app registration usam POST /v2/phone-validations/app-registration.

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer {YOUR_ACCESS_TOKEN}

Parâmetros do body

ParameterTypeRequiredDescription
phonestringYesO mesmo número nacional usado ao enviar o OTP.
countryCodestringYesCódigo de discagem começando com +.
otpnumberYesCódigo numérico que o usuário recebeu.
phoneGatewaystringNosms ou whatsapp — restringe a busca quando ambos os canais foram usados.
projectstringNoFiltro opcional de projeto para registros baseados em fluxo.
projectFlowstringNoFiltro opcional de fluxo de projeto (preferencial quando disponível).

Exemplos de requisição

curl -X PUT "https://api.verifik.co/v2/phone-validations" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"phone": "3001234567",
"countryCode": "+57",
"otp": 123456,
"phoneGateway": "whatsapp"
}'

Resposta de sucesso

{
"data": {
"_id": "66f0a1b2c3d4e5f678901234",
"status": "validated",
"countryCode": "+57",
"phone": "3001234567",
"phoneGateway": "whatsapp",
"source": "manual",
"validatedAt": "2026-07-29T22:40:00.000Z"
}
}

Tempo de vida do OTP

OTPs pendentes são válidos por 10 minutos a partir do último envio/reenvio bem-sucedido (expiresAt na resposta de criação). Depois disso, este endpoint retorna 412 phoneValidation_has_expired. Envie um novo OTP (respeitando o intervalo de reenvio de ~2 minutos, ou use force: true na criação manual) antes de pedir ao usuário para tentar novamente.

Tentativas de OTP

Hoje não há limite de tentativas no servidor. Códigos incorretos retornam 403 otp_does_not_match até o registro expirar ou um novo OTP ser enviado. Aplique bloqueio ou limite de tentativas no seu cliente, se necessário.

Erros comuns

StatusMessageWhen
403otp_does_not_matchO código não corresponde ao OTP pendente.
412phoneValidation_has_expiredO TTL do OTP pendente (~10 minutos) expirou.
409otp_send_failedO registro mais recente para este telefone falhou no envio (não é o mesmo que expiração).
409phone_validation_already_validatedO OTP já foi validado.
404phone_validation_not_foundNenhuma Validação de Telefone correspondente para este telefone.
409MissingParameterCampos obrigatórios do body ausentes.

Relacionados