Events

Monitor your account's activity and retrieve precise data about API usage

Every time something new happens in your account, Universign creates an event. An event corresponds to a modification of a resource you interacted with, or with the usage you made of a service. For example, if you create or delete an API key, an event is triggered such as apikey.created or apikey.deleted. Please note that Universign only logs events linked to API requests that returned a 200 status code.

Access your workspace’s events

If your account has API entitlements and if you are its Owner, or have an Admin or Integrator role, you then have access to a Developer space from your workspace. To view your workspace’s events, navigate to the Events section of the Developer space.

The list of webhookable events is as follows:

Apikey events

• apikey.created(the apikey has been created)
• apikey.updated(the apikey name has been updated)
• apikey.deleted(the apikey has been deleted)

Transaction events

• transaction.lifecycle.created(the transaction has been created in draft)
• transaction.lifecycle.started(the transaction has been started)
• transaction.lifecycle.paused(the transaction has been paused)
• transaction.lifecycle.cancelled(the transaction has been cancelled)
• transaction.lifecycle.expired(the transaction has been expired)
• transaction.lifecycle.completed(all participants have performed their actions, the transaction is completed and all signed documents are ready to be retrieved)
• transaction.chat.message.received(the transaction creator received an instant message send by the participant)

Participant action events

• action.opened(the action is ready to be performed by the participant)
• action.closed(the participant has performed his/her action)
• action.stalled(the participant has not performed his/her action within the allotted time)
• action.manualreminder.sent(a manual reminder has been sent to the participant)
• action.reminder.sent(an automatic reminder has been sent to the participant)
• action.waitingperiod.cancelled(the waiting period has been cancelled within the transaction)
• action.waitingperiod.ended(the waiting period has ended and the participant can perform his action now)

List of all possible stall reasons

Note that a participant’s action can be stalled for one of the following reasons:

• action_refusal: the participant refused to authenticate on the signature page
• signature_refusal: the participant refused to sign a document
• consultation_refusal: the participant refused to view a document
• review_refusal: the participant refused to review a document
• upload_refusal: the participant refused to upload supporting documents
• unknown_editor: the co-editor is unknown
• edition_refusal: the co-editor refused to fill the unknown participant information
• actor_conflict: a cyclic relation appears in the transaction
• incorrect_name_prerequisite: the participant refused the prerequisite name
• incorrect_mobile_prerequisite: the participant refused the prerequisite phone number
• incorrect_information_prerequisite: the participant refused the prerequisite name and phone number
• sealer_expired: the certificate related to the sealer is expired

The stall reason is indicated in the action.stalled event payload.

Identity validation events

• identity-validation.processed(The identity has been verified)

Registration events

Event	Description
registration.identity.verified	The identity has been verified with a verification_status value among success or failure.
registration.identity.rejected	The validated identity has been rejected. The user decalred an error in his/data extracted and presented as valid. This rejection can be due to an extraction error or an input error in the data recording file.
registration.lifecycle.rejected	Identity information rejected at the beginning of the process if one of the registration requirements specified by the registration creator is not respected (i.e. user full name and/or phone number).
registration.lifecycle.expired	The registration session has expired. Note that a registration has a lifetime of 7 days. After this period, if it has not been used to create a certificate, it is deleted.
registration.lifecycle.completed	Registration is complete: the user has chosen a certificate name and signed the subscription agreement.
registration.certificate.activated	The certificate has been issued and is ready to be used.

Filter your workspace’s events

An event search returns all the events that match your input filters. If no result match your search, you are indicated so.

• by period: Select the search format for the period, either Before a specific date or Between two specific dates and enter a search value,
• by type: This refers to the name of the resource or the service you interacted with,
• by API key: Select the API key that was used to authenticate the requests.

Note that you can export the list of events matching your search to CSV file.

Display information about a specific event

Click an event to view its detailed information.

Each event includes:

• an envelope that contains data about the event itself,
• the response body that was returned by the API.

Retrieve consumption report

You may need to retrieve useful information about your consumption within Universign’s services.

This endpoint enables you to compute and retrieve your workspace consumption report over a certain period for several actions such as:

• transactions (by state),
• signatures (by level),
• signed and/or read documents,
• visas,
• seals,
• reviews,
• timestamps,
• identities (by verification status),
• certificates created.

To retrieve a workspace consumption report, send a request to GET /v1/consumptions/summary:

curl
https://api.universign.com/v1/consumptions/summary?created_gt=2022-12-19T00:00:00Z&created_lt=2024-01-19T00:00:00Z

Note that you can still retrieve the consumption report by sending a request to GET /v1/events/report. However, this endpoint is Deprecated.

The API returns an events-report object.

{
  "object": "events-report",
  "tenant_id": "wsp_JqqOX1OY778L",
  "started_transactions": 895,
  "completed_transactions": 695,
  "cancelled_transactions": 100,
  "expired_transactions": 100,
  "visas": 60,
  "read_documents": 60,
  "seals": 2436,
  "sealed_documents": 87,
  "reviews": 154,
  "captures": 56,
  "signatures": 511,
  "signed_documents": 383,
  "signatures_by_required_level": {
      "level_3": 6,
      "level_4": 4,
      "level_0": 5,
      "level_1": 452,
      "level_2": 44
  },
  "signed_documents_by_required_level": {
      "level_3": 6,
      "level_4": 4,
      "level_0": 4,
      "level_1": 325,
      "level_2": 44
  },
  "transactions_by_max_level": {
      "level_3": 3,
      "level_4": 2,
      "level_0": 2,
      "level_1": 150,
      "level_2": 22
  },
  "timestamps": 1,
  "standalone_seals": 28,
  "pvid_identities_analysed": 9,
  "pvid_identities_validated": 5,
  "pvid_identities_rejected": 4,
  "certificate_creation_with_pvid": 3,
  "web_identities_analysed": 51,
  "web_identities_validated": 38,
  "web_identities_rejected": 13,
  "certificate_creation_with_web": 9
}

---

API keys

← Previous

Traces

Next →