← FlexAPI Documentation / Reference / Zoom Meeting Linking

Zoom Meeting Linking

A single scheduled Zoom meeting can be linked to many remote online notarization (RON) transactions. This is most useful for bulk work, where a notary notarizes documents across several transactions but only needs to meet once. One meeting, linked across the transactions, is far more efficient than a meeting for each. Available in SIGNiX release 180.

This page covers the concept, the restrictions, and linking a meeting when you submit a transaction. Separate pages cover the calls that add, move, remove and look up meetings.

Before you link meetings

  • Same client account. A meeting cannot be linked between transactions in different client accounts.
  • No completed tasks. A meeting cannot be linked, moved or removed if the transactions involved have a completed task. When linking or moving a meeting, neither the source nor the destination transaction may have one. When removing a meeting, the transaction it is removed from must not have one.
  • Identify the meeting. A meeting is identified by the DocumentSetID of a transaction it belongs to, its MeetingUUID, and its Part. The MeetingUUID is returned when the meeting is created. Part is almost always 1.
  • No orphaned meetings. A meeting must always belong to at least one transaction.
  • Protect the meeting links. The SubmitterMeetingLink returned in responses is the host link for the notary. Treat it as sensitive and do not share it with signers. Signers use the SignerMeetingLink.

Which call to use

CallUse it to
SubmitDocument with MeetingLinkCreate a new transaction that shares an existing meeting.
AddMeetingAdd a meeting to an existing transaction, either a new meeting or a link to an existing one. The meeting stays in its original transaction as well.
UpdateMeetingMove a meeting from one transaction to another. The source transaction no longer has the meeting.
RemoveMeetingRemove a meeting from a transaction, as long as at least one other transaction still has it.
GetMeetingsRetrieve meeting details for a transaction, or every transaction sharing a meeting.

Linking a meeting when you submit

To schedule a new meeting as you submit a transaction, you send a MeetingInfo element in SubmitDocument. To share an existing meeting instead, send a MeetingLink element in its place. It goes in the same position, after the MemberInfo elements and before the Form elements.

  • All three elements, DocumentSetID, MeetingUUID and Part, must be present. If one is missing you receive a descriptive error that says which.
  • MeetingInfo and MeetingLink cannot be mixed in the same request. You receive an error if you send both.
  • DocumentSetID is the transaction that currently has the meeting, and MeetingUUID is that meeting.
  • In almost all cases, set Part to 1. A higher value means the original meeting grew too large and was split into several parts. Linking such a meeting means linking one that has already finished, which is not a typical workflow. It is allowed, but you should understand the risks.
SubmitDocument - MeetingLink (between MemberInfo and Form)
<!-- ... MemberInfo elements, including the notary ... -->

<!-- Use MeetingLink OR MeetingInfo, never both. All three elements are required. -->
<MeetingLink>
  <DocumentSetID>YOUR_SOURCE_DOCUMENT_SET_ID</DocumentSetID> <!-- Transaction from which you are linking a meeting -->
  <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID> <!-- The meeting you are linking to this transaction -->
  <Part>1</Part> <!-- Almost always 1 -->
</MeetingLink>

<!-- ... Form elements ... -->

Response

A successful request returns the usual SubmitDocument response, which includes the meeting details for the linked meeting. Only the Data element is shown here. See SubmitDocument - Response XML for the rest.

SubmitDocument response with a linked meeting (Data only)
<Data>

  <DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>
  <PickupToken>YOUR_PICKUP_TOKEN</PickupToken>
  <PickupLink>YOUR_PICKUP_LINK</PickupLink>

  <!-- Meeting details for the linked meeting. -->
  <SubmitterMeetingLink>YOUR_SUBMITTER_MEETING_LINK</SubmitterMeetingLink> <!-- Host link (notary). Treat as sensitive. -->
  <SignerMeetingLink>YOUR_SIGNER_MEETING_LINK</SignerMeetingLink> <!-- Participant link (signer / witness) -->
  <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
  <MeetingDateTime>10/05/2025 08:30 AM US/Eastern</MeetingDateTime>

</Data>

Error response

If the meeting cannot be linked, for example because the transaction it is currently in already has a completed task, StatusCode is 2 and StatusDesc explains why. The response can still include a Data element, so always check StatusCode before treating a response as a success.

SubmitDocument - error linking a meeting
<SubmitDocumentRs xmlns="urn:com:signix:schema:sdddc-1-1">

  <Status>
    <StatusCode>2</StatusCode> <!-- Non-zero: the meeting could not be linked -->
    <StatusDesc>Unable to link existing meeting: The meeting cannot be linked between the existing transaction and this transaction because the existing transaction has completed tasks.</StatusDesc>
  </Status>

  <Data>
    <DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>
    <PickupToken>YOUR_PICKUP_TOKEN</PickupToken>
    <PickupLink>YOUR_PICKUP_LINK</PickupLink>
  </Data>

</SubmitDocumentRs>

Transaction events

Meeting activity is recorded as events in the transaction's history. The meeting's MeetingUUID and Part are included, so you can match an event to a meeting.

EventWhen it appears
Online Meeting CreatedA new meeting is created for a transaction. It records the MeetingUUID, Part, meeting ID, meeting topic and participants.
Online Meeting LinkedAn existing meeting is linked to a transaction, by SubmitDocument or AddMeeting. It records the same details, plus the linked DocumentSetID.
Online Meeting UpdatedA meeting is moved into a transaction by UpdateMeeting. It appears on the destination transaction and records the previous DocumentSetID.
Online Meeting RemovedA meeting is removed from a transaction, by RemoveMeeting or when UpdateMeeting moves it out. It appears on the transaction the meeting left.