{"templateId":"markdown","versions":[{"version":"2.1-test","label":"2.1 (TEST)","link":"/products/liveidplus/2.1-test/enterprise/get-started/call-closing","default":false,"active":false,"folderId":"ed500da1"},{"version":"2.1","label":"2.1 (latest)","link":"/products/liveidplus/enterprise/get-started/call-closing","default":true,"active":true,"folderId":"ed500da1"},{"version":"2.0","label":"2.0","link":"/products/liveidplus/2.0/enterprise/get-started/call-closing","default":false,"active":false,"folderId":"ed500da1"}],"sharedDataIds":{"sidebar":"sidebar-products/liveidplus/@2.0/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Call Closing","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"call-closing","__idx":0},"children":["Call Closing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a call is terminated, an event is sent to the integrator with the details of the closure.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"All LiveID+ events are available via the client-side callback and the redirect parameter. However, only call closing events (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},") are also forwarded to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["liveid_servercallback"]}," URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The events that can be received are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event"},"children":["Event"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fired when the video identification process is closed by the operator."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fired when the video identification process is closed due to unexpected errors (e.g., operator disconnection)."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-parameters","__idx":1},"children":["Event Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For each event, an object containing the following properties is provided:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for the LiveID+ video identification process."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON object containing additional parameters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.closeStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates how the video identification process was closed:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["N"]},": Successfully completed.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["S"]},": Suspended by the operator.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["A"]},": Aborted by the operator due to an error.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," - ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["K"]},": Terminated by the system due to unexpected errors."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.note"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A note provided by the operator at the time of closure."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.processId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the associated process workflow."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.self"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean indicating if the process is a self-identification process."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.abortCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Code corresponding to predefined closure reasons (only present when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["closeStatus=A"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.nextProcess"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of a follow-up video identification process, if applicable. ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Not included for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," events."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.token"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication token for LiveID+ API features. ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Not included for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," events."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.additionalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON object containing custom data added by the end script. ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Not included for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," events."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"abort-codes","__idx":2},"children":["Abort Codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The abort codes can be customized per process upon request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The default codes are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_CONN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Problem starting the call, stuck on \"Connecting...\""]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_DISCONNECT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User disconnected"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_ANSWER_TIMEOUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connection timeout"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_OTHER_NO_TECH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Other non-technical issue not listed (specify)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_OTHER_TECH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Other technical problem not listed (specify)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_PHOTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Problem taking photo after switched camera on mobile"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_QUAL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Problem with video quality"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_REC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Problem recording call"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_SWITCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Problem switching camera on mobile device"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_VIDEO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Video issues for customer and/or operator"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_SOUND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audio issues for customer and/or operator"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_DATA"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incorrect data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_THIRDP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Presence of unauthorized third party"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_DOC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or invalid (unreadable, expired, etc...) document"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["E_CONN_LOW"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Poor and/or unstable connection"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"call-closing-strategy","__idx":3},"children":["Call Closing Strategy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each customer organization should define a strategy for handling video identification process closures. Some examples:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization A"]},": Sends an email containing all identification data as a ZIP file attachment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization B"]},": Calls an exposed service to retrieve the video identification status and related details."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Since there are no predefined standard procedures, organizations must define their own processes based on their requirements."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recommended-workflow","__idx":4},"children":["Recommended Workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A typical call closing integration workflow would be:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receive the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["close"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," event (via client-side callback, redirect, or server-side callback)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Extract the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callID"]}," (conference ID) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["closeStatus"]}," from the event payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["closeStatus"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["N"]}," (success), use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message.token"]}," to retrieve identification data via the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/liveidplus/enterprise/get-started/data-retrieval"},"children":["Data Retrieval"]}," APIs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["closeStatus"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["A"]}," (aborted), check the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abortCode"]}," for the specific reason and handle accordingly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store the results in your system for further processing."]}]}]},"headings":[{"value":"Call Closing","id":"call-closing","depth":1},{"value":"Event Parameters","id":"event-parameters","depth":2},{"value":"Abort Codes","id":"abort-codes","depth":2},{"value":"Call Closing Strategy","id":"call-closing-strategy","depth":2},{"value":"Recommended Workflow","id":"recommended-workflow","depth":3}],"frontmatter":{"outline":"deep","title":"Call Closing","scope":"vertical-solutions","product":"LiveID+","category":"get-started","version":"2.0","description":"Reference guide for LiveID+ call closing events, close and error message parameters, closeStatus codes, and the complete list of abort codes.","keywords":["call closing","close event","abort codes","closeStatus","call lifecycle","LiveID+"],"seo":{"title":"Call Closing"}},"lastModified":"2026-07-16T07:59:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/liveidplus/enterprise/get-started/call-closing","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}