Skip to main content
Get Face Match Session
curl --request GET \
  --url https://api.sandbox.verisoul.ai/liveness/session \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.sandbox.verisoul.ai/liveness/session"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.verisoul.ai/liveness/session', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.verisoul.ai/liveness/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.sandbox.verisoul.ai/liveness/session"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.verisoul.ai/liveness/session")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.verisoul.ai/liveness/session")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "request_id": "db4ad346-e8f1-46cc-922d-f89ca8fb7ac7",
  "session_id": "00022912-cbaa-4239-a3ec-51c32fcc0fc1"
}
{
"request_id": "e6f078a5-7931-4c41-ad53-1ef35a4ca762",
"success": false,
"error": "groups_enabled"
}

Authorizations

x-api-key
string
header
required

API key authentication

Query Parameters

referring_session_id
string<uuid>

ID of a referring session, if applicable

simulate
string

See Simulate Face Match for more information

Response

Session created successfully

request_id
string<uuid>
required

Unique identifier for the request

session_id
string<uuid>
required

Unique identifier for the session