Skip to main content

Validar una Validación de Teléfono

Endpoint

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

Confirma el OTP que recibió el usuario. Verifik busca la Phone Validation más reciente en estado sent (y no expirada) para ese teléfono — incluyendo registros manuales / Smart Tools y registros de flujo de proyecto.

Combínalo con el envío

Los OTPs independientes se crean con POST /v2/phone-validations/manual.

Headers

NombreValor
Content-Typeapplication/json
AuthorizationBearer {YOUR_ACCESS_TOKEN}

Parámetros del body

ParámetroTipoRequeridoDescripción
phonestringMismo número nacional usado al enviar el OTP.
countryCodestringCódigo con +.
otpnumberCódigo numérico recibido.
phoneGatewaystringNosms o whatsapp.
projectstringNoFiltro opcional para registros de flujo.
projectFlowstringNoFiltro opcional de project flow.

Ejemplo

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"
}'

Vigencia del OTP

Los OTP pendientes son válidos durante 10 minutos desde el último envío/reenvío exitoso (expiresAt en la respuesta de creación). Después, este endpoint responde 412 phoneValidation_has_expired. Envía un OTP nuevo (respetando la ventana de ~2 minutos, o usa force: true en el create manual) antes de pedir al usuario que intente de nuevo.

Intentos de OTP

Hoy no hay límite de intentos en el servidor. Un código incorrecto responde 403 otp_does_not_match hasta que expire el registro o se envíe un OTP nuevo. Si necesitan bloqueo o tope de intentos, impleméntenlo en su cliente.

Errores comunes

StatusMensajeCuándo
403otp_does_not_matchEl código no coincide.
412phoneValidation_has_expiredExpiró el TTL del OTP pendiente (~10 minutos).
409otp_send_failedEl último registro falló al enviarse (no es lo mismo que expiración).
409phone_validation_already_validatedEl OTP ya fue validado.
404phone_validation_not_foundNo hay Phone Validation para este teléfono.
409MissingParameterFaltan campos requeridos.