Estimated reading time: 15-20 minutes

What will you learn from this guide?

This manual will teach you how to use the Life Verification system (Liveness) JAAKwith. Livenessyou will be able to confirm that the person interacted with your system is real and physically present, preventing attacks from suplanting his or her identity with photos, videos or masks. You will also learn how to monitor and analyse the results of these checks.

No prior technical knowledge required - just follow the steps.

Before Start - Checks list

Be sure to have these data ready:

• API Key (Token Bearer): Your valid authentication key provided by JAAK. It's essential to get our services.
• Video to analyze: A short video of the person's face, ideally in Base64.
• Basic knowledge of APIs REST: familiarity with how HTTP (POST, GET) applications are made and JSON responses are processed.

Contents Index

1. What's Verification Liveness?

The Life Verification system (Liveness) JAAK It's a biometric technology that determines if a person in an image or video is physically present and living in real time, rather than being a fake representation as a photo, preengraving video, or mask.

That process is crucial to:

• Prevent fraud: Prevent criminals from using stolen or false identities to gain access to services.
• Ensure authenticity: To confirm that the person performing an action is a living entity and not a suplantation.
• Compliance with regulations: To help companies comply with "Know Your Customer" regulations (KYC) and "Anti Money Willing" (AML).

2. Key functionality

Our product Liveness offers the following main capabilities:

• Advanced Life Detection: He analyzes videos to identify signs of real life and differentiate between a living person and an attack of suplanting (e.g. photos, videos, masks).
• Trust score (Score): It provides a numerical value (0-100) that indicates the probability that the person will be real.
• Best Fame Extraction (bestFrame): It identifies and returns the best quality image of the video face, useful for later analysis or facial comparison.
• Record of events: Keep a complete history of each life check, including processing time and result.
• Specific Error Codes: It offers detailed code to quickly diagnose problems such as non-processing videos or life-detection faults.

3. Integration with API

Interaction with the system Liveness It's made through calls to our API.

3.1 Life Verification Endpoint (POST / api / v1 / liveness / verify-and-bestframe)

That's the main endpoint to conduct a life check from a video.

• Method: POST
• Base URL: https://api.sandbox.jaak.ai/api/v1/liveness/verify-and-bestframe

Required Headers:

• Authorization: Bearer TU_API_KEY_AQUI (Your authentication key)
• Content-Type: application/json

Application body (JSON):

Successful Response (HTTP Status: 200 OK):

The answer includes a eventId and requestId for monitoring, processTime (milliseconds), score (liveness score). bestFrame contains the best photo of the video encoded at Base64. state indicates if isRealPerson It's true or false and an message associated.

Example of response:

{
  "eventId": "06722190-9de7-4d1b-a9ad-1559a5ab8cb9",
  "score": 85.6,
  "bestFrame": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJ...",
  "state": {
    "isRealPerson": true,
    "message": ""
  }
}

3.2 Important considerations for video

• Format: Make sure the video's properly encoded at Base64.
• Content: The video should have a clear and visible face for precise detection.
• Size: The size limit for the requested body is 10MB. Larger videos can cause timeouts.

4. Monitoring of Events

The details of life monitoring events for audit, performance analysis and problem solving are available.

4.1 Event Consultation (GET / api / v1 / livelihood / event)

This endpoint allows you to filter and get a pawned list of all events of survival.

• Method: GET
• Base URL: https://api.sandbox.jaak.ai/api/v1/liveness/event

Required Headers:

• Authorization: Bearer TU_API_KEY_AQUI
• company-id: Your Company ID

Consultation parameters (Query Params):

Can you use parameters as limit (number of elements per page, 1-100), page (page number), status (success, failed, processing, rejected), action (verify-liveness), min-process-time, max-process-time, min-created-at, max-created-at.

Example: GET /api/v1/liveness/event?limit=10&page=1&status=success

4.2 Special Event Consultation (PET / api / v1 / livelihood / event /: id)

To get complete details of an individual liveness event.

• Method: GET
• Base URL: https://api.sandbox.jaak.ai/api/v1/liveness/event/:id (where :id It's the unique event ID in Mongolia's ObjectID format)

The answer includes status of the event, processTime, flow processing (details of each step as horizon and liveness) and the results of the survival (score, is_real).

5. Common Problem Resolution

6. Do you need some help?

Do not hesitate to contact our support team (support) if:

• The problem-solving steps do not solve your drawback after several attempts.
• You get undocumented or unexpected mistakes.
• You need special settings or assistance with advanced integrations.
• Do you have persistent performance problems or data inconsistencies.

Information to have ready while contacting support:

• Special description of the problem
• Steps you followed before the mistake
• Event ID or Request ID of failed requests (if applicable)
• Screenshots of an error (if possible)
• Browser and device used (if applicable to client problems)
• Approximate time after problem
• Filters used for consultations (if applicable)

7. Glossary of terms

Reference links

• Documentation API - POST / api / v1 / survival / verify-and-bestframe
• Documentation API - GET / api / v1 / survival / event /: id
• Documentation API - GET / api / v1 / livelihood / event
• General documentation API of JAAK
• Authentication guide with API Kys