Update an Evaluation

patch

https://riskos.socure.com/api/evaluation/{eval_id}

Update a paused or in-progress RiskOS™ evaluation with additional data to resume workflow processing.

Path Params

eval_id

uuid

required

The system-generated unique ID for the evaluation. Capture this value from the initial POST /api/evaluation response.

Headers

X-API-Version

string

Specifies the API version used for the request. If omitted, the default version is used. Socure recommends pinning a version to avoid unexpected behavioral changes when new versions are released.

Body Params

workflow

string

enum

required

Your environment-specific workflow identifier. You can find this value in the RiskOS™ Dashboard > Developer Workbench > Integration Checklist.

Note: The workflow name must be unique within your RiskOS™ environment. It is not scoped by use case and must identify a single active workflow for each Evaluation API request.

Allowed:

string

required

Required, customer-defined unique identifier for the request.

This value must be unique for each evaluation. Reusing an ID causes RiskOS™ to treat the request as a re-run and can impact processing behavior, results, and downstream workflows.

timestamp

date-time

required

The timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.

customer_metadata

object | null

Optional, opaque JSON object echoed back unchanged on the response and at the top level of webhook callbacks — use it to route and correlate requests. Must be a JSON object of up to 200 characters total (the entire serialized JSON); larger payloads return 413 CUSTOMER_METADATA_TOO_LARGE. Omit it or send null to skip. Don't include PII or secrets. See Customer Metadata.

actions

object

A top-level container for instructions that modify the lifecycle of the current evaluation session.

data

object

required

The main payload for the Consumer Onboarding workflow.

Responses

400

Bad Request - The request was unacceptable.

401

Unauthorized - An invalid API key was provided.

404

Not Found - The requested resource does not exist.

413

Payload Too Large - The customer_metadata object exceeds the maximum allowed size.

500

500 Internal Server Error – Unexpected server issue.

200The evaluation was updated successfully.