Email Authentication

OTP Request - Email

Methods used for logging in with an already generated account in Verifik. This procedure is important because all queries require an Access Token, which is only generated upon login to the Verifik page.

These services create an OTP (One Time Password) request necessary to validate that the phone or email belongs to a Verifik client.

Implementation

POST - https://api.verifik.co/v2/projects/email-login

Parameters to send in the body

{
  "email": "string",
  "type": "login"
}

Successful response (EmailValidation creation)

{
  "data": {
       "client": "613375a1eab2fe08527f81e2",
        "project": "6266193db77ccc8111730c90",
        "projectFlow": "658ed28b0990f300134d7b78",
        "status": "sent",
        "validationMethod": "verificationCode",
        "email": "[e-mail]",
        "emailData": {
            "firstName": "User name here",
            "title": "Verifik Client App",
            "projectName": "Verifik Client App",
            "contactEmail": "[e-mail]",
            "logo": "<https://cdn.verifik.co/access/verifikprojectlogo.png>"
        },
        "otp": "$2a$10$wM660nUDywMOtP8bYjQNGOQuZQJq2uNc2Wn2z4gD/JVegkPZ4vu5q",
        "expiresAt": "2024-05-29T03:24:20.000Z",
        "extraParams": [],
        "type": "login",
        "redirectUrl": "<https://verifik.app>",
        "requires2FA": false,
        "_id": "66569d8cc9d6ad919263f15d",
        "updatedAt": "2024-05-29T03:14:21.663Z",
        "createdAt": "2024-05-29T03:14:21.663Z",
        "__v": 0,
        "new": true
  }
}

OTP Confirmation - Email

The OTP confirmation services aim to generate a “login” to the Verifik account by validating that the sent OTP matches the one sent to the email. As a response, the access token is obtained, which the user can use for queries.

Implementation

POST - https://api.verifik.co/v2/projects/email-login/confirm

Parameters to send in the body

{
  "email": "string",
  "otp": "string"
}

Successful response (OTP correctly validated)

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

Note: A token generated by this means will be valid for 30 days from the time the successful response is received. Verifik is not responsible for handling the Access Token. It is recommended to be very careful in determining who or what uses it to avoid potential consumption issues.