# Api LiveID+

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.

Version: 2.1.0

## Servers

Test
```
https://liveid.test.namirialtsp.com
```

Production
```
https://liveid.namirialtsp.com
```

## Security

### ConferenceToken

Bearer Token provided on call closing or generated with [genAPIToken](./../developer-documentation/api-definition/authenticate/genapitoken)

Type: http
Scheme: bearer
Bearer Format: JWT

### ApiKeyAuth

Organization specific API key provided by Namirial LiveID+ team

Type: apiKey
In: header
Name: apikey

## Download OpenAPI description

 - [Api LiveID+](https://docs.namirial.app/_bundle/@l10n/it/products/liveidplus/@2.2/enterprise/developer-documentation/api-definition.yaml)

## app

 - [GET /app/service-asyncall](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/app/serviceasyncall.md): In addition to perform a "synchronous" call (the customer calls and is immediately redirected to platform test, then to the first available operator) it's also possible to perform an "asynchronous" ca
 - [POST /app/service-start](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/app/servicestart.md): Start the process for a video identification. It can be a live session with an operator or a self process, or a combination of both (in this case, a selection method should be discussed in advance wit
 - [POST /app/service-webrtc-test](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/app/servicewebrtctest.md): service-webrtc-test is in the process of being deprecated. For initial integration with LiveID+, it is strongly recommended to use the service-start API.To initiate a video identification, a request t
## authenticate

 - [GET /api/authenticate/genAPIToken](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/authenticate/genapitoken.md): Retrieve a call specific access token for interaction with other LiveID+ integration features.
## service

 - [GET /api/service/checkStatus](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/checkstatus.md): Check if the service is active
 - [POST /api/service/pushAsyncCall](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/pushasynccall.md): In addition to *synchronous* call - where the customer initiate a call and is immediately redirected to the network and media test, then to the first available operator - LiveID+ also supports *asynch
 - [DELETE /api/service/delAsyncCall](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/delasynccall.md): Delete an async call previously added in the system
 - [POST /api/service/availableLanguages](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/availablelanguages.md): Retrieve all the languages spoken by operators of a specific organization.
 - [POST /api/service/getDailyWaitingTimes](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/getdailywaitingtimes.md): Retrieve the average daily waiting time of the last week (in seconds) and of the last 60 minutes, for a single organization
 - [POST /api/service/getAvailableOperators](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/getavailableoperators.md): Retrieve the number of the operators currently available to answer calls
 - [POST /api/service/getCallInfoUID](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/getcallinfouid.md): Retrieve the details about the last call related to the async UID passed. **To retrieve all the calls related to the async UID, use the [getAsyncRequestInfo](./../v2/getasyncrequestinfo) method of the
 - [POST /api/service/getQueue](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/service/getqueue.md): Retrieve the number of people in queue for a specified process
## v1

 - [GET /api/v1/conferenceData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v1/conferencedatav1.md): 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 depr
 - [GET /api/v1/getAuditData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v1/getauditdatav1v1.md): 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
 - [DELETE /api/v1/deleteAuditData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v1/deleteauditdatav1.md): 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 a
 - [GET /api/v1/checkStatus](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v1/checkstatusv1.md): Check if the service is active This API has been deprecated and will be shut down soon (see the deprecation roadmap).Please use service/checkStatus. See the migration guide for details.
## v2

 - [GET /api/v2/conferenceData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/conferencedata.md): Retrieve LiveID+ video identification calls data ***Notice***: for details about module structure provided in "data" parameter see this ConferenceData response: module structure
 - [DELETE /api/v2/deleteAuditData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/deleteauditdata.md): 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 a
 - [GET /api/v2/getAuditData](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/getauditdatav2.md): Retrieve LiveID zip containing the audit data and recognition call photo's. Unless otherwise specified with the direct parameter, an url will be returned where you can download the zip.
 - [PATCH /api/v2/rejectCall](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/rejectcall.md): Reject a call as if it was rejected by the system
 - [GET /api/v2/getAsyncRequestInfo](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/getasyncrequestinfo.md): Retrieve the details about all the calls related to the async UID passed
 - [POST /api/v2/registerAlertEmail](https://docs.namirial.app/it/products/liveidplus/enterprise/developer-documentation/api-definition/v2/registeralertemail.md): Register one or more email addresses to receive alerts about the server callbacks of a process. **Pay attention**: each registration will override the previous email address registered for the process
