Socure SDK Callback Methods

Predictive DocV Web SDK Callback Methods

The Predictive Document Verification (DocV) Web SDK provides callback functions through the config object, enabling you to implement custom logic for handling progress, success, and error events during the document capture and upload process.

Additionally, the config object includes settings that allow you to modify the handoff component

The DocV Web SDK also supports webhooks events to receive notifications as a consumer progresses through each step of the document capture process. See Predictive DocV Webhook Events Version 5 for more information.

The config object and the callback methods:

var config = {
  onProgress: function(event) { ... },
  onSuccess: function(response) { ... },
  onError: function(error) { ... },
  qrCodeNeeded: true, 
  disableSmsInput: false 
};

config object parameters

The following table lists the arguments passed to the config object:

Callback event types​

The following table provides additional details about the available event types of each of the three methods:

onProgress callback​

The onProgress callback returns real-time updates as the consumer progresses through the document capture and upload process.

WAITING_FOR_USER_TO_REDIRECT

Example callback event: Process Initiated

{
  "docvTransactionToken": "6d454cdd-108f-46f5-8fc2-b92529940eed",
  "status": "WAITING_FOR_USER_TO_REDIRECT",
  "key": "6d454cdd-108f-46f5-8fc2-b92529940eed",
  "customerUserId": "121212",
  "mobileNumber": "+13475550100",
  "deviceSessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjp7InNlc3Npb2..."
}

WAITING_FOR_UPLOAD

If the user opens the Capture App in a new window, use the captureAppWindow object to programmatically close the Capture App window at the end of the session.

onSuccess callback​

The onSuccess callback is triggered when the document and selfie images are successfully uploaded.

Example callback event: Image Upload Complete

{
  "docvTransactionToken": "6d454cdd-108f-46f5-8fc2-b92529940eed",
  "status": "DOCUMENTS_UPLOADED",
  "key": "6d454cdd-108f-46f5-8fc2-b92529940eed",
  "customerUserId": "121212",
  "mobileNumber": "+13475550100",
  "deviceSessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjp7InNlc3Npb2..."
}

onError callback​

The onError callback is triggered when an issue occurs during the document capture or upload process.

CONSENT_DECLINED

Example callback event: Consent Declined

{
  "docvTransactionToken": "c1c4223f-ce22-4c72-9fdf-90480ccefc77",
  "status": "CONSENT_DECLINED",
  "key": "c1c4223f-ce22-4c72-9fdf-90480ccefc77",
  "customerUserId": "121212",
  "mobileNumber": "+13475550100",
  "deviceSessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjp7InNlc3Npb2..."
}

DOCUMENTS_UPLOAD_FAILED

Example callback event: Documents Upload Failed

{
  "docvTransactionToken": "c1c4223f-ce22-4c72-9fdf-90480ccefc77",
  "status": "DOCUMENTS_UPLOAD_FAILED",
  "key": "c1c4223f-ce22-4c72-9fdf-90480ccefc77",
  "customerUserId": "121212",
  "mobileNumber": "+13475550100",
  "deviceSessionToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJkYXRhIjp7InNlc3Npb2..."
} 

Callbacks in a Multiple Document Capture flow​

The DocV Web SDK will receive onProgress callbacks with the "DOCUMENTS_UPLOADED" status for each document uploaded in the transaction. These callbacks will also include the total number of expected documents.

For the final document upload, the DocV Web SDK will receive both onProgressand onSuccesscallbacks with the status "DOCUMENTS_UPLOADED".

• The onProgress callback will contain a single docvTransactionTokenfor the last uploaded document.
• The onSuccesscallback will return an array of all docvTransactionTokenvalues from the transaction.

onProgress callback

Current Document Count

onProgressfor each document upload (Multiple Document Capture only)

{ 
  "docvTransactionToken": "78d1c86d-03a3-4e11-b837-71a31cb44142",
  "status": "DOCUMENTS_UPLOADED",
  "key": "78d1c86d-03a3-4e11-b837-71a31cb44142",
  "mobileNumber": "+19788626926",
  "deviceSessionToken": "xxSyBgzKzPNWJO3UqTFCXiOQjk1KZKtdKcQElv3f",
  "multiDoc": {
    "transactionGroupId": "86f4m42e-04n7-5f12-c970-32b58dc31952",
    "current" : 1,
    "total" : 3
  }
}

Final Document Upload

onProgress for final document uploaded (Multiple Document Capture only)

{ 
  "docvTransactionToken": "5213seac-cggn-562a-9b12-23bt3p3qra59",
  "status": "DOCUMENTS_UPLOADED",
  "key": "aa896ee4-b7b7-4049-92b1-0cfdd20481a5",
  "mobileNumber": "+19788626926",
  "deviceSessionToken": "xxSyBgzKzPNWJO3UqTFCXiOQjk1KZKtdKcQElv3f",
  "multiDoc": {
    "transactionGroupId": "86f4m42e-04n7-5f12-c970-32b58dc31952",
    "current" : 3,
    "total" : 3
  }
}

onSuccess callback​

onSuccessafter all document are uploaded (Multiple Document Capture only)

{
  "status": "DOCUMENTS_UPLOADED",
  "key": "aa896ee4-b7b7-4049-92b1-0cfdd20481a5",
  "mobileNumber": "+19788626926",
  "deviceSessionToken": "xxSyBgzKzPNWJO3UqTFCXiOQjk1KZKtdKcQElv3f",
  "multiDoc": {
    "transactionGroupId": "86f4m42e-04n7-5f12-c970-32b58dc31952",
    "docvTransactionTokens": [
      "78d1c86d-03a3-4e11-b837-71a31cb44142",
      "891e1cac-ff1f-439d-8a22-11db6e35a607",
      "5213seac-cggn-562a-9b12-23bt3p3qra59"
    ]
  }
}