Solicitud OTP - Teléfono

Métodos usados para hacer ingreso con una cuenta que ya se encuentre generada en Verifik, importante realizar este procedimiento dado que todas las consultas requieren un Access Token que solo se genera al hacer Login en la página de Verifik.

Estos servicios crean una petición de OTP (One Time Password) el cual es necesario para validar que el teléfono o correo son de un cliente de Verifik.

Implementación

POST - <https://api.verifik.co/v2/projects/phone-login>

Parámetros a enviar el body

{
  "countryCode": "string",
  "phone": 0,
  "type": "login"
}

Respuesta exitosa (OTP Enviado a Teléfono)

{
    "data": {
        "client": "613375a1eab2fe08527f81e2",
        "project": "6266193db77ccc8111730c90",
        "projectFlow": "658ed28b0990f300134d7b78",
        "status": "sent",
        "countryCode": "+1",
        "phone": "1234566663",
        "phoneGateway": "whatsapp",
        "otp": "$2a$10$fdoxDgtv6J7E4nnZoCORSOiUbpCGOOE5JWghrvAUNZIoX5h81zJLq",
        "expiresAt": "2024-05-29T03:51:26.000Z",
        "phoneData": {
            "title": "Verifik Client"
        },
        "type": "login",
        "redirectUrl": "<https://verifik.co>",
        "requires2FA": false,
        "language": "en",
        "_id": "6656a3e6eb43abfd7146abb6",
        "updatedAt": "2024-05-29T03:41:27.009Z",
        "createdAt": "2024-05-29T03:41:27.009Z",
        "__v": 0,
        "new": true,
        "providerConfirmation": {}
    },
    "signature": {
        "dateTime": "May 29, 2024 3:41 AM",
        "message": "Certified by Verifik.co"
    },
    "id": "Y0628"
}

Confirmación OTP - Teléfono

Los servicios para confirmar el OTP tienen como finalidad generar un “ingreso” a la cuenta de Verifik validando que el OTP enviado coincida con el que fue enviado al teléfono, como respuesta se obtiene el access token con el que el usuario podrá hacer consultas.

Implementación

POST - <https://api.verifik.co/v2/projects/phone-login/confirm>

Parámetros a enviar el body (Teléfono)

{
  "countryCode": "string",
  "phone": 0,
  "otp": "string"
}

Respuesta exitosa (OTP validado correctamente)

{
    "data": {
        "accessToken": "eyJhbGcpXVCJ9.eyJjbGllbnR...JZCIYiUzNjEaIWxYShWeBaRs",
        "tokenType": "bearer"
    }
}

Nota: Un token generado por este medio tendrá una vigencia de 30 días a partir del momento que se recibe la respuesta exitosa, Verifik no se hace responsable del manejo del Access Token. Se recomienda tener mucho cuidado al determinar quién o qué lo utiliza para evitar posibles problemas de consumo.