Validate Phone Validation (Validar la Validación de Teléfono)

Endpoint

POST /v2/phone-validations/validate

Descripción

Este endpoint valida una contraseña de un solo uso (OTP) enviada al número de teléfono del usuario como parte del proceso de verificación de teléfono. Garantiza que el OTP proporcionado por el usuario sea correcto y actualiza el estado de verificación en consecuencia.

Headers

Header	Type	Required	Description
Content-Type	String	Yes	Set to application/json.
Authorization	String	Yes	Bearer token for API authorization.

Body Parameters

Parameter	Type	Required	Description
project	String	Yes	Unique identifier for the project.
projectFlow	String	Yes	Identifier for the specific project flow.
countryCode	String	Yes	The country code of the phone number (e.g., +507).
phone	String	Yes	The phone number to validate.
validationMethod	String	Yes	The validation method, set to verificationCode.
type	String	Yes	Type of validation, e.g., login.
otp	String	Yes	The one-time password provided by the user.

Request

Node.js

const axios = require('axios');
let data = JSON.stringify({
  "project": "6266193db77ccc8111730c90",
  "projectFlow": "658ed28b0990f300134d7b78",
  "countryCode": "+507",
  "phone": "62617737",
  "validationMethod": "verificationCode",
  "type": "login",
  "otp": "277414"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://app.verifik.co/v2/phone-validations/validate',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer eyJhbGciOiJIUzNj...0w1splt4Cw'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

cURL

curl --location 'https://app.verifik.co/v2/phone-validations/validate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUz6IkpXV...0w1splt4Cw' \
--data '{
    "project": "6266193db77ccc8111730c90",
    "projectFlow": "658ed28b0990f300134d7b78",
    "countryCode": "+507",
    "phone": "62617737",
    "validationMethod": "verificationCode",
    "type": "login",
    "otp": "277414"
}'

Response

200

{
  "data": {
    "_id": "674deff248fb1a857d68341d",
    "status": "validated",
    "countryCode": "+507",
    "phone": "62617737",
    "type": "login",
    "showFaceLivenessRecommendation": true,
    "appLogin": {
      "_id": "674deff248fb1a857d68341e",
      "client": "613375a1eab2fe08527f81e2",
      "name": "",
      "status": "validated",
      "project": "6266193db77ccc8111730c90",
      "projectFlow": "658ed28b0990f300134d7b78",
      "type": "phone",
      "phoneValidation": "674deff248fb1a857d68341d",
      "updatedAt": "2024-12-02T17:43:19.147Z",
      "createdAt": "2024-12-02T17:35:46.689Z",
      "__v": 0
    },
    "token": "eyJhbGciOiJIUzI1NiIsIn..."
  }
}

403

{
    "code": "Forbidden",
    "message": "otp_does_not_match"
}

Response Body

Parameter	Type	Description
_id	String	Unique ID for the phone validation session.
status	String	Status of the validation, e.g., validated.
countryCode	String	Country code of the phone number.
phone	String	The phone number that was validated.
type	String	Type of validation (e.g., login).
showFaceLivenessRecommendation	Boolean	Indicates if face liveness check is recommended.
appLogin._id	String	Unique ID of the login session.
appLogin.client	String	Client identifier.
appLogin.name	String	Name of the user associated with the validation.
appLogin.status	String	Status of the login session, e.g., validated.
token	String	JWT token generated after successful validation.

Notas

• Asegúrate de que el encabezado Authorization contenga un token válido para autenticar las solicitudes a la API.

• Si showFaceLivenessRecommendation es true, guía a los usuarios para completar una verificación de liveness facial.

• Maneja los tokens JWT de manera segura y úsalos solo para la sesión prevista.