OneSpan Identity Verification notification

OneSpan Identity Verification provides a call-back mechanism for partner applications to receive notifications whenever an e-agreement workflow reaches a certain pre-configured state. This feature enables partner systems to capture the status of a transaction.

Notifications can be configured inside the workflow, which is set up by OneSpan Professional Services based on your requirements. OneSpan Identity Verification scenarios with notifications lists the OneSpan Identity Verification scenarios which can be configured inside the workflow to send notifications.

OneSpan Identity Verification only supports string messages. You need to decide which type of notification to integrate, based on the response messages.

For security reasons, OneSpan Identity Verification only supports notification endpoints that have a static IP address. Notification endpoints with a dynamic IP address are not supported.

OneSpan Identity Verification scenarios with notifications
Scenario Options
Transaction
  • Created
  • Completed
  • Expired
  • Cancelled
  • Error
  • Ready for lender
Session
  • Started
  • Ended
  • Error
Document
  • Selected
  • Presented
  • Downloaded
  • Downloaded for Printing
  • Printed
  • Accepted
  • Signed
  • Added
Page view
  • Created
Signature
  • Accepted
  • Signed
Verifications
  • Doc ID
  • OTP
  • Document verification with face
Audit trail
  • Generated
  • Error
Consent
  • Accepted

Example notification: transaction created

  1. {
  2.   @timestamp": "2020-01-17 00:08:31.118 +0000",
  3.   "type":"notification",
  4.   "transaction_id":"a17800d8-0208-4052-b2c6-752f07c04dfa",
  5.   "session_id":"e639bf75-9c16-46f9-b71e-d13e9a8ac8d6",
  6.   "trigger":"transaction_created",
  7.   "skip_common_ux_components":true,
  8.   "skip_view_state":false,
  9.   "role":"Borrower",
  10.   "message":"Esignprocessisstarted.",
  11.   "fields":[],
  12.   "version":
  13. }

Example notification: consent accepted

In this example, consent information is specified in type and message, and in the fields array.

  1. {
  2.   "timestamp": "2022-07-22T20:32:10.336Z",
  3.   "type": "consent_accepted",
  4.   "transaction_id": "16b48158-1de3-4455-b059-65d0205a358b",
  5.   "session_id": "020b50ee-a730-4906-96a5-ab1f2af6da6f",
  6.   "id": "33cb6c3c-236f-45af-a48c-85e1870eb32d",
  7.   "trigger": "page_next",
  8.   "skip_common_ux_components": true,
  9.   "skip_view_state": false,
  10.   "role": "oss",
  11.   "document_references": [],
  12.   "message": "Consent is accepted",
  13.   "client_device": {
  14.   "ip_address": "192.0.2.15",
  15.   "name": "Other",
  16.   "os_version": "Linux",
  17.   "browser_version": "Chrome 100.0.4896",
  18.   "browser_width": 1848,
  19.   "page_height": 948
  20. },
  21.   "fields": [
  22.     {
  23.       "name": "explicit-consent",
  24.       "value": "false"
  25.     },
  26.     {
  27.       "name": "consent-text",
  28.       "value": "By clicking NEXT you consent to the processing of your personal data for the purpose of verifying your identity."
  29.     },
  30.     {
  31.       "name": "accepted",
  32.       "value": "true"
  33.     }
  34.   ],
  35.   "version": 0
  36. },