Retrieve session

GET /api/v2/facial-authentication-sessions/{tokenString}/

Retrieve session

cURL

curl --request GET \
  --url https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/ \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.get("https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

require 'uri'
require 'net/http'

url = URI("https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

using RestSharp;


var options = new RestClientOptions("https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

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

func main() {

	url := "https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/")
  .get()
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["Authorization": "Basic <encoded-value>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "givenScanRef": "<string>",
  "tokenString": "<string>",
  "approved": true,
  "facePhoto": "<string>"
}

Authorizations

Authorization · string · header · required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Path Parameters

tokenString · string · required

Token string used for authentication.

Response

200 - application/json

id · string<uuid> · required · read-only

givenScanRef · string · required

deprecated

Maximum string length: 40

tokenString · string

Token string used for authentication.

Maximum string length: 40

approved · boolean | null

type · enum<string>

Available options: ENROLLMENT, AUTHENTICATION

authenticationMethod · enum<string>

Available options: ACTIVE_LIVENESS, FACE_MATCHING

facePhoto · string<uri> | null