Socure Predictive DocV node

The Socure Predictive DocV node verifies a user’s identity by authenticating government-issued documents, such as a passport or driver license. It initiates a workflow to capture images of the document and a selfie. The workflow extracts personally identifiable information (PII) from the document to compare against the user’s profile and verifies the ID photo against the selfie to detect discrepancies.

The node returns a decision for the verification process and stores the collected data in shared state.

Example

Example Socure ID+ and Predictive DocV journey

Availability

Product	Available?
PingOne Advanced Identity Cloud	Yes
PingAM (self-managed)	Yes
Ping Identity Platform (self-managed)	Yes

Product

Available?

PingOne Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

Inputs

The node reads the user profile attributes from shared state, including the device identifier.

Dependencies

You must have a Socure admin account with access to developer APIs.

The node requires an ref:ROOT:attribute-collector.adoc[] earlier in the journey to collect the profile attributes for verifying against the document attributes.

Optionally, place a Socure DeviceId Collector node before this node to collect the device identifier.

Configuration

Property Usage

Property	Usage
SocureApiEndpoint	The Socure ID+ API endpoint for confirming the authenticity of a government-issued ID. For example, `https://service.socure.com/api/5.0/documents/request`.
Socure Api Key	The unique identifier used to access the Socure ID+ API. Get your ID+ key from the Socure admin portal.
Web Sdk Key	The unique identifier used to access the Socure Web SDK. Get your SDK key from the Socure admin portal.
Web Sdk URL	The URL for the latest version of the Predictive DocV Web SDK. For example, `https://websdk.socure.com/bundle.js`.
Document Attributes Mapping	Maps PII collected from the document request to user profile attributes. Remove all map entries if you don’t want to store any attributes. Key The attribute collected by the document. For example, `firstName`. Value The corresponding identity store attribute. For example, `givenName`.
Flow Name	(Optional) Specify a custom flow for capturing document information.
Send Message	(Optional) Determines whether a one-time-use document request URL is sent to the end user by text message. By default, this is enabled to use the Socure SMS delivery. Don’t enable this setting if you prefer to use a different method.
Redirect URL	(Optional) If set, the flow redirects the end user to the specified URL after the document capture and the upload process is cancelled or completed.
Redirect Method	(Optional) Specify `GET` or `POST` as the redirect method if you have set a value for the redirect URL.
Default Document Type	(Optional) Lets you set a default document type for the verification check. For example, `license` or `passport`. This implements a simplified flow to capture document information that skips the step to select an ID type.

SocureApiEndpoint

The Socure ID+ API endpoint for confirming the authenticity of a government-issued ID. For example, https://service.socure.com/api/5.0/documents/request.

Socure Api Key

The unique identifier used to access the Socure ID+ API.

Get your ID+ key from the Socure admin portal.

Web Sdk Key

The unique identifier used to access the Socure Web SDK.

Get your SDK key from the Socure admin portal.

Web Sdk URL

The URL for the latest version of the Predictive DocV Web SDK. For example, https://websdk.socure.com/bundle.js.

Document Attributes Mapping

Maps PII collected from the document request to user profile attributes.

Remove all map entries if you don’t want to store any attributes.

Key: The attribute collected by the document. For example, firstName.
Value: The corresponding identity store attribute. For example, givenName.

Flow Name

(Optional) Specify a custom flow for capturing document information.

Send Message

(Optional) Determines whether a one-time-use document request URL is sent to the end user by text message. By default, this is enabled to use the Socure SMS delivery.

Don’t enable this setting if you prefer to use a different method.

Redirect URL

(Optional) If set, the flow redirects the end user to the specified URL after the document capture and the upload process is cancelled or completed.

Redirect Method

(Optional) Specify GET or POST as the redirect method if you have set a value for the redirect URL.

Default Document Type

(Optional) Lets you set a default document type for the verification check. For example, license or passport. This implements a simplified flow to capture document information that skips the step to select an ID type.

Outputs

The node stores the document data in shared state.

It also records that document verification is in progress.

If an error occurs, the exception and the stacktrace are added to shared state.

Outcomes

The node outcomes are determined by the response from the call to the Socure ID+ API. The API uses logic defined in the Decision module to provide recommendations for the identity verification.

Reject: The end user is rejected due to the presence of specific reason codes or scores.
Refer: The end user is referred for further checks.
Resubmit: Resubmit the end user’s PII with a residential address.
Review: Perform a manual review of the end user’s PII to verify their identity.
Accept: The end user is verified and accepted.
Error: An error occurred during the verification process.

Errors

If an error occurs, the node logs it with the prefix [SocureDocumentVerification Node][Marketplace].

Authentication nodes