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 with Namirial).
At the end of the process, or in case of errors, the page will be redirected to the redirectUrl (if specified) passing a LiveIDPlusResult POST parameter, containing the JSON result message in the same format specified in the Call closing section.
There are two ways to integrate LiveID+:
- standalone mode: the call is launched in a new browser tab and provides a server-side callback and a rediderct URL for client-side 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 [network and media test and call status check Client side events section and Call closing section).
In case of embedded mode, the iframe must have allow property set to include geolocation, camera, and microphone access, as following:
allow="geolocation; camera; microphone"
If this API is used to start a single video identification process, the id_process parameter is mandatory.
If LiveID+ should automatically perform a check to decide whether to use a live process or a self process, the id_process_live and id_process_self are mandatory. The procedure to determine which process to choose has to be discussed with Namirial in the set up phase.
The id_process parameter and id_process_self, id_process_live couple are mutually exclusive.
Identification code [CODE] of the calling organization.
(Provided by Namirial during the platform setup)
A custom ID to identify the call. It will be searchable in the reports (max 100 characters)
The url where the browser should be redirected when the process is completed or in case of errors. Data will be passed as POST parameters as specified in the Call closing section
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)
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)
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)
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)
Only for live processes
Useful information to show to Operator before answering the call (max length: 100 chars).
Only for live processes
If set to true, compatibility test will skip the audio/video recording customer's check.
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.
UTF-8 Base64 encoded JSON object containing all the configuration parameters for starting a call.
In case of preparing the call using pushAsyncCall, this parameter should not be base64 encoded, but directly passed as JSON
- Testhttps://liveid.test.namirialtsp.com/app/service-start
- Productionhttps://liveid.namirialtsp.com/app/service-start
curl -i -X POST \
https://liveid.test.namirialtsp.com/app/service-start \
-H 'Content-Type: application/json' \
-d '{
"id_process": "d7e3c9d5-ed32-4a9f-95d4-873ecc4bd359",
"id_organization": "string",
"external_id": "string",
"redirectUrl": "http://example.com",
"redirectMethod": "GET",
"id_operator2Call": "c813819c-5fe1-47c5-b9c5-b3ce03364691",
"email_operator2Call": "user@example.com",
"extId_operator2Call": "string",
"direct": "string",
"opInfo": "string",
"skipAVrecTest": false,
"disableRTCTest": 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"
}
}
}
}'