Overview

To configure webhooks for your account, please reach out to your account manager or our support team with your webhook URL.

General Structure

URL: Provided by you
Method: POST
Authentication Supported: Basic Auth / Bearer

{
    notarization_id: "", //  Callback variable, provided by you during Create Session.
    bn_session_id: "", // 24 characters alpha-numeric case insensitve string
    event_type: "", // List provided below
    event_details: {
        message: "",
        final_output_files: [
            {
                name: "",
                base64Doc: ""
            },
            {
                name: "",
                base64Doc: ""
            }
        ],
        additional_signers_signing_urls: {
            bn_signing_url: "",
            full_signing_url: ""
        }
    },
    event_by_details: { // Details of the user which triggered the event
        first_name: "",
        last_name: "",
        middle_name: "",
        name: "",
        email: ""
    }
}

List of Events:


open_call_accepted	Triggered when notary picks up session
photo_id_passed	Triggered when signer passes photoid stage
photo_id_failed	Triggered when signer fails photoid stage
biometrics_passed	Triggered when signer passes biometrics
kba_started	Triggered when signer starts KBA flow
kba_answered	Triggered when signer answers the KBA Flow Question Set
kba_succeeded	Triggered when signer passes the KBA Stage
kba_first_set_failed	Triggered when signer failes the first stage of KBA Question Set
kba_failed	Triggered when signer fails KBA stage
join_session	Triggered when any user joins session
leave_session	Triggered when any user leaves session
session_started	Triggered when session is started
session_completed_clicked	Triggered when user completes the session, and document processing starts
session_completed	Triggered when session is completed. This webhook request also sends the final signed pdf files
session_expired	Triggered when session is expired. Once session is expired, the login links will not work.
additional_signer_invited	Triggered when customer/notary invites an additional signer in session
esign_action_completed	Triggered when a signer have signed the document for esign session
personal_details_filled	Triggered when a new customer joins via vendor link and starts a new session. In this event under `event_details` section, additional keys like customer_email, customer_name, sessionId and state would be added

Samples

join_session

A user has joined a session. This includes the notary.

{
  "event_type": "join_session",
  "event_details": {
    "message": "User has joined the session"
  },
  "event_by_details": {
    "name": "John Doe",
    "email": "[email protected]"
  },
  "notarization_id": "my-session-12345",
  "bn_session_id": "6891f7f3fc2bbfd77a43429b"
}

leave_session

A user has left the session.

{
  "event_type": "leave_session",
  "event_details": {
    "message": "User has left the session"
  },
  "event_by_details": {
    "name": "John Doe",
    "email": "[email protected]"
  },
  "notarization_id": "my-session-12345",
  "bn_session_id": "6891f7f3fc2bbfd77a43429b"
}

open_call_accepted

When a notary has accepted the request and will be joining the session soon.

{
  "event_type": "open_call_accepted",
  "event_details": {
    "message": "Notary assigned to the Session"
  },
  "event_by_details": {
    "first_name": "Collin",
    "last_name": "Watson",
    "name": "Collin Watson",
    "email": "[email protected]"
  },
  "notarization_id": "my-session-12345",
  "bn_session_id": "6891f7f3fc2bbfd77a43429b"
}

session_completed_clicked

When the notary has completed the session.

{
  "event_type": "session_completed_clicked",
  "event_details": {
    "message": "Session Completed Button Clicked. Documents are Processing..."
  },
  "event_by_details": {
    "first_name": "Collin",
    "last_name": "Watson",
    "name": "Collin Watson",
    "email": "[email protected]"
  },
  "notarization_id": "my-session-12345",
  "bn_session_id": "6891f7f3fc2bbfd77a43429b"
}

session_completed

When the session is completed and processed. This includes the final signed document.

{
  "event_type": "session_completed",
  "event_details": {
    "message": "Session completed successfully.",
    "final_output_files": [
      {
        "name": "Signed_Form_1754299454549.pdf",
        "base64Doc": "JVBERi0x.....olJUVPRg==",
        "initial_document_name": "Form_1754299454549.pdf"
      }
    ]
  },
  "event_by_details": {
    "first_name": "Collin",
    "last_name": "Watson",
    "name": "Collin Watson",
    "email": "[email protected]"
  },
  "notarization_id": "my-session-12345",
  "bn_session_id": "6891f7f3fc2bbfd77a43429b"
}