DocV Web SDK Capture App Customization

Customize Your Capture App Flow

The Predictive Document Verification (DocV) Web SDK includes customizable options that allow you to modify the user interface and user experience of the Capture App flow.

After completing your SDK integration, use this section to learn how to build and deploy a customized flow that matches your organization's style, branding, and document verification use case.

Step 1: Build your Capture App flow in RiskOS™

On the DocV App page in RiskOS™:

1. Select your Capture App flow use case, then customize the Capture App UI to match your application's theme.
2. When you are finished, save the flow to the Production environment.

Step 2: Deploy your custom flow

The DocV Web SDK requires you to make a POST request to the /api/evaluation endpoint to generate a docvTransactionToken. You can deploy your custom flow settings using the data.individual.docv.config object parameters in the API request body. The docvTransactionToken returned in the API response will automatically apply your Capture App flow settings to the transaction.

curl --location 'https://riskos.socure.com/api/evaluation' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer a182150a-363a-4f4a-xxxx-xxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --header 'X-API-Version: 2025-01-01.orion' \
  --data-raw '{
  ...
    "docv": {
      "config": {
        "send_message": false,
        "language": "en",
        "use_case_key": "customer_use_case_key",
        "redirect": {
          "method": "GET",
          "url": "https://www.socure.com",
        "document_type": "license"
        },
      },
      ...
    }'

The following table lists the config object parameters:

How the redirect object works

The optional redirect object conforms to the following type:

{
  url: string;
  method: 'GET' | 'POST';
  headers?: { [key: string]: string };
  delay?: number;
}

The redirect object allows you to redirect the consumer after the Capture App flow is canceled or successfully completed using the following fields:

• url: Sets the destination website address. You can also pass values using query strings to uniquely identify each transaction.
• method: Defines the redirect method. Possible values are GET or POST.
• headers: Adds optional headers to the request.
• delay: Adds a delay before redirecting, specified in milliseconds (for example, 5000 for 5 seconds).

How document_type works

The document_type field sets a default acceptable document type for the transaction using the values license for driver's license or passport for passport. After the SDK is launched, the Capture App flow will implement a simplified flow that skips the Selected ID Type Screen and starts the consumer on the Document Capture Screen. See Document Verification Flow for more information.

Step 3: Redirect to the Capture App

When you call the <Anchor label="/api/evaluation" target="_blank" href="https://help.socure.com/riskos/reference">/api/evaluation</Anchor> endpoint, the API response includes a one-time-use document request URL that is used to redirect the consumer to the Capture App flow. Depending on your integration workflow, the consumer can access the document request URL using one of the three methods listed in the tabs below.

curl --location 'https://riskos.socure.com/api/evaluation' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer a182150a-363a-4f4a-xxxx-xxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --header 'X-API-Version: 2025-01-01.orion' \
  --data-raw '{
    ...
    "phone_number": "+13475550100",
    "docv": {
      "config": {
        "send_message": true,
        ...
      }
    }
  }'

{
  ...
  "response": {
    "data": {
      "docvTransactionToken": "70c6a4bc-f646-4c6a-94c1-9cd428e356ef",
      "eventId": "70c6a4bc-f646-4c6a-94c1-9cd428e356ef",
      "qrcode": "data:image/png;base64,iVBO......K5CYII=",
      "url": "https://verify.socure.com/#/dv/70c6a4bc-f646-4c6a-94c1-9cd428e356ef"
    },
  },
  ...
}

curl --location 'https://riskos.socure.com/api/evaluation' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer a182150a-363a-4f4a-xxxx-xxxxxxxxxxxx' \
  --header 'content-type: application/json' \
  --header 'X-API-Version: 2025-01-01.orion' \
  --data-raw '{
    ...
    "docv": {
      "config": {
        "send_message": false,
        ...
      }
    }
  }'

{
  ...
  "response": {
    "data": {
      "docvTransactionToken": "70c6a4bc-f646-4c6a-94c1-9cd428e356ef",
      "eventId": "70c6a4bc-f646-4c6a-94c1-9cd428e356ef",
      "qrcode": "data:image/png;base64,iVBO......K5CYII=",
      "url": "https://verify.socure.com/#/dv/70c6a4bc-f646-4c6a-94c1-9cd428e356ef"
    },
  },
  ...
}