List all Biometric Validations

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

Retrieves a list of biometric validation records based on specified filters and parameters.

Headers

Name	Value
Authorization	Bearer {YOUR_ACCESS_TOKEN}

Query Parameters

Pagination

Parameter	Type	Description	Example
page	number	Page number (starts at 1).	page=1
perPage	number	Items per page (default: 20).	perPage=10
offset	number	Alternative to page for skipping records.	offset=20

Data Selection

Parameter	Type	Description	Example
populates[]	array	Fields to populate with related data.	populates[]=client&populates[]=project

Filtering

Parameter	Type	Description	Example
where_client	string	Filter by client ID.	where_client=507f1f77bcf86cd799439013
where_status	string	Filter by validation status.	where_status=validated
where_type	string	Filter by validation type.	where_type=login
where_livenessSession	string	Filter by liveness session ID.	where_livenessSession=674de8df21c72be3cc42b8a7
in_status	array	Filter by multiple statuses.	in_status[]=validated&in_status[]=failed
where>_createdAt	string	Filter records created after date.	where>_createdAt=2024-12-01

Sorting

Parameter	Type	Description	Example
sort	string	Sort order (prefix with - for descending).	sort=-createdAt

Request Examples

Basic Request

curl -X GET "https://api.verifik.co/v2/biometric-validations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

With Pagination

curl -X GET "https://api.verifik.co/v2/biometric-validations?page=1&perPage=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

With Filters

curl -X GET "https://api.verifik.co/v2/biometric-validations?where_status=validated&where_type=login" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200

{
  "data": {
    "docs": [
      {
        "_id": "674de8df21c72be3cc42b8a8",
        "status": "validated",
        "type": "login",
        "url": "https://access.verifik.co/sign-in/507f1f77bcf86cd799439011?type=liveness",
        "createdAt": "2024-12-02T17:05:36.788Z"
      }
    ],
    "total": 1,
    "limit": 20,
    "page": 1,
    "pages": 1
  }
}

204

{
  "data": []
}

Notes

• Authentication Required: Valid access token with appropriate permissions.

• Access Control: Users can only access validations for their own client or with super admin privileges.

• Default Pagination: 20 items per page if not specified.

• Populate Relationships: Use populates[] to include related data like client, project, and liveness session.

• Filtering: Apply various filters to narrow down results based on specific criteria.

• Performance: Use lean=true for better performance when you don't need Mongoose document features.

Common Use Cases

• Dashboard Views: Display validation statuses and counts for monitoring.

• User Management: List validations for specific users or time periods.

• Reporting: Generate reports on validation activities and success rates.

• Integration: Retrieve validation data for external system processing.

• Audit Trails: Access validation history for compliance and security purposes.

This endpoint provides flexible access to biometric validation records with comprehensive filtering, pagination, and data selection capabilities.