Skip to main content
GET
/
api
/
v2
/
facial-authentication-sessions
/
{tokenString}
/
Retrieve session
curl --request GET \
  --url https://ivs.idenfy.com/api/v2/facial-authentication-sessions/{tokenString}/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "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