Create a Biometric Validation

POST https://api.verifik.co/v2/biometric-validations

A Biometric Validation is an instance within Verifik's system that allows you to process and validate user identities through facial recognition and liveness detection. This process ensures the authenticity of users by verifying their unique biometric characteristics through advanced security technology.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer {YOUR_ACCESS_TOKEN}

Body

Name
Type
Required
Description

project

string

Yes

The unique identifier for the project where this biometric validation will be used.

projectFlow

string

Yes

The unique identifier for the project flow configuration.

identifier

string

Yes

A unique identifier for the user or session (e.g., email, phone, or custom ID).

type

string

Yes

Type of validation: validation, login, onboarding, or oneTimeLink.

expiresAt

string

No

Optional expiration date for the validation session.

redirectUrl

string

No

Optional URL for redirect after validation.

webhookUrl

string

No

Optional webhook URL for validation notifications.

requires2FA

boolean

No

Optional flag indicating if two-factor authentication is required.

ipAddress

string

No

Optional IP address of the user.

sendViaEmail

boolean

No

Optional flag to send validation link via email.

email

string

No

Email address to send validation link to (required if sendViaEmail is true).

language

string

No

Language for email templates (en/es). Defaults to "en".

type Values

Value
Description

validation

General biometric identity validation.

login

Biometric verification during user authentication.

onboarding

Biometric verification during user registration.

Body Examples

Basic Biometric Validation

{
  "project": "507f1f77bcf86cd799439011",
  "projectFlow": "507f1f77bcf86cd799439015",
  "identifier": "[email protected]",
  "type": "validation"
}

Advanced Biometric Validation with Email

{
  "project": "507f1f77bcf86cd799439011",
  "projectFlow": "507f1f77bcf86cd799439015",
  "identifier": "[email protected]",
  "type": "login",
  "expiresAt": "2024-12-31T23:59:59.000Z",
  "redirectUrl": "https://yourapp.com/success",
  "webhookUrl": "https://yourapp.com/webhook",
  "requires2FA": false,
  "ipAddress": "192.168.1.1",
  "sendViaEmail": true,
  "email": "[email protected]",
  "language": "en"
}

Request

curl -X POST https://api.verifik.co/v2/biometric-validations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "project": "507f1f77bcf86cd799439011",
    "projectFlow": "507f1f77bcf86cd799439015",
    "identifier": "[email protected]",
    "type": "validation"
  }'

Response

The response will contain information about the new Biometric Validation instance, including the liveness session details, validation URL, and authentication token.

{
  "data": {
    "livenessSession": {
      "_id": "674de8df21c72be3cc42b8a7",
      "identifier": "[email protected]",
      "client": "507f1f77bcf86cd799439013",
      "project": "507f1f77bcf86cd799439011",
      "projectFlow": "507f1f77bcf86cd799439015",
      "status": "active",
      "expiresAt": "2024-12-02T17:15:35.000Z",
      "createdAt": "2024-12-02T17:05:36.788Z",
      "updatedAt": "2024-12-02T17:05:36.788Z"
    },
    "biometricValidation": {
      "_id": "674de8df21c72be3cc42b8a8",
      "client": "507f1f77bcf86cd799439013",
      "project": "507f1f77bcf86cd799439011",
      "projectFlow": "507f1f77bcf86cd799439015",
      "status": "new",
      "livenessSession": "674de8df21c72be3cc42b8a7",
      "type": "validation",
      "url": "https://access.verifik.co/stand-alone/507f1f77bcf86cd799439011?type=liveness",
      "assignedCollection": "507f1f77bcf86cd799439016",
      "collectionCode": "col_12345",
      "redirectUrl": null,
      "webhook": null,
      "requires2FA": false,
      "createdAt": "2024-12-02T17:05:36.788Z",
      "updatedAt": "2024-12-02T17:05:36.788Z"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Notes

  • Liveness Session: A secure session is automatically created with a 4-minute expiration for security.

  • Collection Requirement: The project must have an assigned collection for biometric data storage.

  • Feature Activation: Liveness detection must be enabled in the project flow configuration.

  • URL Generation: The validation URL is automatically generated based on the project and validation type.

  • Email Integration: Optional email notifications can be sent with validation links in English or Spanish.

  • Security: Each session gets a unique JWT token for secure authentication.

Common Use Cases

  • User Registration: Verify identity during account creation with biometric data

  • Login Security: Add biometric verification to user authentication

  • KYC Processes: Comprehensive identity verification for compliance

  • High-Security Access: Multi-factor authentication with biometrics

Once your Biometric Validation is created, users can access the provided URL to complete their liveness detection and facial recognition verification. The session will remain active for 4 minutes, after which it expires for security purposes.

Last updated

Was this helpful?