Liveness API

---

Authentication

Description

The API uses a token-based authentication scheme. Each request must include an Authorization header containing your access key.

Header Example

{
  "Authorization": "YOUR_KEY"
}

• Required: Yes
• Format: Plain-text token.

---

Retrieve result

To ensure security, results must be retrieved using a GET request to our servers. Results are available for 300 seconds after the process is completed.

Available endpoint:

Select the base URL according to the environment you are using:

• PRO https://pro.vfp.kn.talentomobile.com
• PRE https://pre.vfp.kn.talentomobile.com
• DEV https://dev.vfp.kn.talentomobile.com

API Specifications

• URL: /result/:id
• Method: GET

URL Params

Required:

id=[string]

• Data Params

  None

• Success Response:

  • Code: 200
    Body:

    Sample response:

    [
      {
        "type": "CH_BLINK", 
        "startTimestamp": 1631260389,
        "endTimestamp": 1631260390,
        "success": true,
        "evidences": [
          {
            "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
            "type": "MV_BLINK"
          }
        ]
      },
      {
        "type": "CH_BIOMETRY", 
        "endTimestamp": 1631260652,
        "startTimestamp": 1631260650,
        "score": 99.9845,
        "success": true,
        "evidences": [
          {
            "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
            "type": "MV_HEAD_STRAIGHT"
          },
          {
            "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
            "type": "MV_ORIGIN"
          },
        ],
      },
      {
        "type": "CH_HEAD_POSE", 
        "endTimestamp": 1631260652,
        "startTimestamp": 1631260650,
        "success": true,
        "moves": [
          {
            "type": "MV_HEAD_TURN_LEFT",
            "startTimestamp": 1631260652,
            "endTimestamp": 1631260652,
            "success": true,
            "evidence": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
          },
          {
            "type": "MV_HEAD_TURN_RIGHT",
            "startTimestamp": 1631260652,
            "endTimestamp": 1631260652,
            "success": true,
            "evidence": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==",
          },
        ],
      },
    ]
    

    Result Reference

• Error Response:

  • Code: 404 NOT FOUND
    

• Sample Call:

  Node.js

    const https = require('https');
  
    const id = 'd5335d6a-9d95-4977-9976-00dede352749';
    const base_url = 'https://dev.vfp.kn.talentomobile.com/';
    https.get(base_url + 'result/' + id, (resp) => {
      let data = '';
      resp.on('data', (chunk) => data += chunk);
      resp.on('end', () => console.log(JSON.parse(data)));
    });

• Result Helper (Only Browser)

    import { ResultHelper, Envs } from 'tm-videoface-plus';
  
    const id = 'd5335d6a-9d95-4977-9976-00dede352749';
    const result = await ResultHelper.get(id, Envs.DEV);
  

---