Skip to main content

Valider une Phone Validation

Endpoint

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

Confirme l'OTP reçu par l'utilisateur. Verifik recherche la dernière Phone Validation envoyée (et non expirée) pour ce téléphone — y compris les enregistrements manuels / Smart Tools et ceux des flux de projet.

Associer à l'envoi

Les OTP autonomes sont créés avec POST /v2/phone-validations/manual. Les OTP d'app registration utilisent POST /v2/phone-validations/app-registration.

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer {YOUR_ACCESS_TOKEN}

Body parameters

ParameterTypeRequiredDescription
phonestringYesMême numéro national que lors de l'envoi de l'OTP.
countryCodestringYesIndicatif commençant par +.
otpnumberYesCode numérique reçu par l'utilisateur.
phoneGatewaystringNosms ou whatsapp — affine la recherche lorsque les deux canaux ont été utilisés.
projectstringNoFiltre projet optionnel pour les enregistrements basés sur un flux.
projectFlowstringNoFiltre project-flow optionnel (préféré lorsqu'il est disponible).

Exemples de requête

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

Réponse de succès

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

Durée de vie de l'OTP

Les OTP en attente sont valides pendant 10 minutes à partir du dernier envoi/renvoi réussi (expiresAt dans la réponse de création). Après cela, cet endpoint renvoie 412 phoneValidation_has_expired. Envoyez un nouvel OTP (en respectant le délai de renvoi d'environ 2 minutes, ou utilisez force: true sur la création manuelle) avant de demander à l'utilisateur de réessayer.

Tentatives OTP

Il n'y a aucune limite de tentatives côté serveur aujourd'hui. Les codes incorrects renvoient 403 otp_does_not_match jusqu'à l'expiration de l'enregistrement ou l'envoi d'un nouvel OTP. Appliquez un verrouillage ou un plafond de tentatives dans votre client si nécessaire.

Erreurs courantes

StatusMessageWhen
403otp_does_not_matchLe code ne correspond pas à l'OTP en attente.
412phoneValidation_has_expiredLe TTL de l'OTP en attente (~10 minutes) est écoulé.
409otp_send_failedLe dernier enregistrement pour ce téléphone a échoué à l'envoi (différent de l'expiration).
409phone_validation_already_validatedL'OTP a déjà été validé.
404phone_validation_not_foundAucune Phone Validation correspondante pour ce téléphone.
409MissingParameterChamps de corps requis manquants.

Associés