Participants

Signers, witnesses, and shared devices

Model the people in a session and give each role the correct signing and identity experience.

6 minAPI v2Integration guide

Add the signers

Provide all_signers as an array. For a normal RON signer, include first_name, last_name, and email. eSign also requires an action. Preserve your own participant mapping alongside the returned links.

JSON
{
  "all_signers": [
    {
      "first_name": "Sam",
      "last_name": "Signer",
      "email": "sam@example.com"
    },
    {
      "first_name": "Taylor",
      "last_name": "Signer",
      "email": "taylor@example.com"
    }
  ]
}

Choose invited or network witnesses

Use your own invited witnesses or request BlueNotary-sourced witnesses. Confirm identity requirements for the chosen workflow.

FieldUse
witnesses.invited_witness_detailsDetails for people you are inviting as witnesses.
witnesses.number_of_bluenotary_witnessesNumber of witnesses requested from the BlueNotary network.
witnesses.bluenotary_witness_id_auth_requiredWhether sourced witnesses require the configured identity authentication.
Validate witness outcomes

Confirm the invited witnesses appear and receive the expected access. Creation success is not proof that every later witness invitation succeeded.

Enable shared-device RON

Set same_device_signing_mode to all under session_configurations. Optionally designate one signer as the host with is_shared_device_owner; the first signer is the default RON host.

  • Only one shared-device owner can be selected.
  • Test the actual host-led participant sequence.
  • Shared-device eSign uses different access behavior and should have its own acceptance test.
JSON
{
  "session_configurations": {
    "same_device_signing_mode": "all"
  },
  "all_signers": [
    {
      "first_name": "Sam",
      "last_name": "Signer",
      "email": "sam@example.com",
      "is_shared_device_owner": true
    },
    {
      "first_name": "Taylor",
      "last_name": "Signer",
      "email": "taylor@example.com"
    }
  ]
}

Use an approved identity workflow

Per-signer authentication_type accepts kba, biometrics, or skip in the input mapping. Choose only the method approved and supported for the account, product, and participant.

  • Per-signer overrides can take precedence over defaults.
  • A session-level customer authentication option applies to the primary signer, not every participant.
  • Avoid unrecognized values; accepted input does not necessarily mean a valid workflow.
Configuration is not legal eligibility

A request field does not determine which identity process is appropriate for a notarization. Apply the approved policy and validate unsupported values before submission.

Handle participant changes deliberately

API v2 does not provide a general participant add/remove endpoint. If participants change after creation, follow the supported session UI/process and observe relevant invitation events.

Keep building