Skip to content
/v1

Api LiveID+ (2.1.0)

API for third parties integration with LiveID+ video identification platform.

You can subscribe to the LiveID+ service on the Namirial status page to receive updates on important releases.

Download OpenAPI description
api-definition.json
api-definition.yaml
Languages
Servers
Test
https://liveid.test.namirialtsp.com
Production
https://liveid.namirialtsp.com

app

Endpoints to initiate a call on LiveID+

Operations

authenticate

Endpoints to manage authentication and generate session tokens

Operations

service

General service endpoints for checking status, queue information, and available operators

Operations

v1

General conference management endpoints (Version 1)

DEPRECATION NOTICE:

For security reasons, the v1 API endpoints has been deprecated and will be shut down in the upcoming months, starting from TEST environment.
  • 15/10/2026 - TEST environment
  • 15/01/2027 - PRODUCTION environment
Please migrate to the v2 API endpoints as soon as possible. See the migration guide for details.

Operations

conferenceData
Deprecated

Request

Retrieve LiveID+ video identification calls data

Notice: for details about module structure provided in "data" parameter see this ConferenceData response: module structure

This API has been deprecated and will be shut down soon (see the deprecation roadmap).
Please use the v2 version. See the migration guide for details.
Security
ConferenceToken
Bodyapplication/json
modulestring

Id of the module to retrieve. If not provided, all the data of the call will be returned.

Enum"photo""formfilling"
tokenstring(JWT)
Deprecated

Token provided on call closing or generated with genAPIToken (if not provided as header)

curl -i -X GET \
  https://liveid.test.namirialtsp.com/api/v1/conferenceData \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "module": "photo",
    "token": "string"
  }'

Responses

Success

Body
servicestring

Service endpoint

successboolean

Success result

Default true
call_answer_datestring(datetime)

date when the call was answered by an operator

call_end_datestring(datetime)

date when the call was closed

call_last_activitystring(datetime)

date of the last activity on the call

end_patternstring(EndPattern)

Status of the call

  • N Closed succesfully
  • A Aborted by operator
  • K System KO
  • S Suspended
  • ACTIVE Still running
  • EXPIRED Expired (no one answered)
  • CANCELLED Cancelled by user
Enum"N""A""K""S""ACTIVE""EXPIRED""CANCELLED"
operatorobject
dataobject

json of the requested data

Response
{
  "service": "string",
  "success": true,
  "call_answer_date": "string",
  "call_end_date": "string",
  "call_last_activity": "string",
  "end_pattern": "N",
  "operator": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "external_id": "string"
  },
  "data": {}
}

getAuditData
Deprecated

Request

Retrieve LiveID zip containing the audit data and identification call photo's.

This API has been deprecated and will be shut down soon (see the deprecation roadmap).
Please use the v2 version. See the migration guide for details.
Security
ConferenceToken
Query
idConferencestringrequired

Conference process id

avstring

Set to "1" to retrieve audio and video

Default "0"
Enum"0""1"
tokenstring(JWT)

Token provided on call closing or generated with genAPIToken (if not provided as header)

curl -i -X GET \
  'https://liveid.test.namirialtsp.com/api/v1/getAuditData?idConference=string&av=0&token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A zip file containing the audit data requested

Bodyapplication/zip
string(binary)
Response
No content

deleteAuditData
Deprecated

Request

Delete all the artifacts (audio, video, photos and shared documents) stored in LiveID+ relative to the served conference id. The textual audit data won't be deleted; to force deleting the audit data and all the data stored in the database is available the "eraseAll" parameters.

This API has been deprecated and will be shut down soon. Please use the v2 version. See the migration guide for details.
Security
ConferenceToken
Query
idConferencestring(uuid)required

Conference process id

eraseAllstring

If set to "1" will delete all the audit data and all the data stored in the database

Default "0"
Enum"0""1"
tokenstring(JWT)
Deprecated

Token provided on call closing or generated with genAPIToken (if not provided as header)

curl -i -X DELETE \
  'https://liveid.test.namirialtsp.com/api/v1/deleteAuditData?idConference=497f6eca-6276-4993-bfeb-53cbbbba6f08&eraseAll=0&token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
servicestring

Service endpoint

successboolean

Success result

Default true
Response
application/json
{
  "service": "string",
  "success": true
}

v2

General conference management endpoints (Version 2)

Operations