Enrichment Step
The Enrichment step calls data services and APIs to add external data to the workflow. This additional context improves decision-making and supports more accurate evaluations.
Key features
- Built-in Socure modules: RiskOS™ includes all existing Socure modules pre-integrated.
- Third-party data services: Connect with a variety of best-in-class external providers.
- Custom models: Integrate your own REST APIs or ML models for tailored enrichment.
For a complete list of supported data services, see Third-Party Data Services.
Note: Data services must be enabled before they appear in the platform. Your account manager will activate all subscribed modules during integration.
Configure an Enrichment step
- Select the Enrichment step in the workflow canvas.
- Choose a Data Service from the dropdown menu.
- The Output field shows where the API response will be stored. This field can be referenced in subsequent steps (e.g., Condition, Transformation, Decision).
- To review the returned payload of the selected service, expand the Browse What’s Inside card.
Note:
- A workflow can include multiple Enrichment steps, including back-to-back Enrichment steps if needed.
- You can customize the Enrichment step’s label by editing the text field at the top of the side panel.
Integration best practices
- Every API response from an Enrichment step is returned in the
data_enrichmentsarray of the evaluation API response. - Design your integration to handle multiple results in this array. A single workflow can include several Enrichment steps, and the set of enrichments may evolve over time.
- Do not hard-code against specific enrichment step names or positions.
- The order and number of enrichment steps are not guaranteed. Always parse the enrichment array and identify the enrichment you need by name or metadata.
- Keeping your integration flexible ensures that workflow changes won’t break downstream systems.
Calling a custom API
The Enrichment step can also call an internal custom API—for example, a machine learning model hosted in your own infrastructure—to bring proprietary signals into your workflow.
When to use
- You have internal risk models or services that should participate in real-time decisions.
- You need signals not available from built-in Socure modules or third-party providers.
How to request
This capability may require enablement. Please coordinate with your account manager or email [email protected] for assistance.
Typical configuration (high level)
- Endpoint URL: Your service’s HTTPS endpoint.
- Method & payload mapping: Configure the HTTP method and map input fields from the workflow payload.
- Auth & headers: Provide required headers (e.g., API key, bearer token).
Best practices
- Minimize latency: Keep the custom API fast and cache results where appropriate.
- Return stable JSON: Use predictable keys and types to simplify downstream logic.
- Version your API: Expose a versioned path to avoid breaking changes.
- Graceful failure: On errors/timeouts, return clear indicators that the workflow can branch on.
Updated 3 months ago
