Skip to content

service-webrtc-test
deprecated

Request

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 to the LiveID+ system has to be performed in order to check the compatibility of the customer's device with the platform. Only if this check is successful will the video identification process begin.

There are two modes in which the video identification call can be initiated:

  • standalone mode: the call is launched in a new browser tab and does not allow for client-side closing callbacks;
  • embedded mode: the call is launched within an HTML iframe directly in the client procedure, allowing for client-side callbacks (in form of window.postMessage) as described in the Client side events section and Call closing section).

If you choose to use embedded mode, the iframe must have the allow property set to include geolocation, camera, and microphone access, as following:
allow="geolocation; camera; microphone"

Bodyapplication/json
One of:
id_organizationstringrequired

Identification code [CODE] of the calling organization.
(Provided by Namirial during the platform setup)

id_processstring, (uuid)required

Unique identifier of the identification process that will be performed.
(Provided by Namirial during the platform setup)

external_idstring, <= 100 characters

A custom ID to identify the call. It will be searchable in the reports (max 100 characters)

id_operator2Callstring, (uuid)

Only for live processes
Identification code of the operator to whom the call will be directly assigned.

Please note: if this parameter is set, the call will be automatically terminated with a KO if the operator doesn't answer, and it will not be assigned to any other operator available.

(id_operator2Call, email_operator2Call, extId_operator2Call and direct parameters are mutually esclusive)

email_operator2Callstring, (email)

Only for live processes
Email of the operator to whom the call will be directly assigned.

Please note: if this parameter is set, the call will be automatically terminated with a KO if the operator doesn't answer, and it will not be assigned to any other operator available.

(id_operator2Call, email_operator2Call, extId_operator2Call and direct parameters are mutually esclusive)

extId_operator2Callstring

Only for live processes
External ID of the operator to whom the call will be directly assigned.

Please note: if this parameter is set, the call will be automatically terminated with a KO if the operator doesn't answer, and it will not be assigned to any other operator available

(id_operator2Call, email_operator2Call, extId_operator2Call and direct parameters are mutually esclusive)

directstring, (JWT)

Only for live processes
Unique token sent to customer for calling a specified operator.

Please note: if this parameter is set, the call will be automatically terminated with a KO if the operator doesn't answer, and it will not be assigned to any other operator available

(id_operator2Call, email_operator2Call, extId_operator2Call and direct parameters are mutually esclusive)

opInfostring, <= 100 characters

Only for live processes
Useful information to show to Operator before answering the call (max length: 100 chars).

skipAVrecTestboolean

Only for live processes
If set to true, compatibility test will skip the audio/video recording customer's check.

Default:false
disableRTCTestboolean

Only for live processes
If set to true, compatibility test will skip the WebRTC check. It's suggested to set to true this property ONLY for processes that doesn't need a video registration.

Default:false
selfIDboolean

If set to true, it starts a SelfID process.

Default:false
jsonobject(ServiceStartJson)required

JSON object containing all the configuration parameters for starting a call

curl -i -X POST \
  https://liveid.test.namirialtsp.com/app/service-webrtc-test \
  -H 'Content-Type: application/json' \
  -d '{
    "id_organization": "string",
    "id_process": "d7e3c9d5-ed32-4a9f-95d4-873ecc4bd359",
    "external_id": "string",
    "id_operator2Call": "c813819c-5fe1-47c5-b9c5-b3ce03364691",
    "email_operator2Call": "user@example.com",
    "extId_operator2Call": "string",
    "direct": "string",
    "opInfo": "string",
    "skipAVrecTest": false,
    "disableRTCTest": false,
    "selfID": false,
    "json": {
      "lang": "en",
      "liveid_email": "user@example.com",
      "liveid_name": "string",
      "liveid_surname": "string",
      "liveid_servercallback": {
        "url": "http://example.com",
        "otherParams": {},
        "headers": {}
      },
      "liveid_priorityQueueLevel": 0,
      "data": {
        "example_field": {
          "datatype": "checkbox",
          "label": "string",
          "value": "string",
          "display": "none",
          "order": 0,
          "disabled": true,
          "maxlength": 0,
          "max": 0,
          "min": 0,
          "pattern": "string",
          "placeholder": "string",
          "readonly": true,
          "required": true,
          "size": 0,
          "step": 0,
          "title": "string"
        }
      }
    }
  }'

Responses

Success

Bodytext/html
string

The identification process page

Response
string