Partially Update an Evaluation

patch

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

Updates risk data or metadata for a previously submitted evaluation request that is in a paused state. The request is identified by eval_id, and updates can be partial—any data not included in the request will remain unchanged. The body of the PATCH request must follow the same structure as the original POST request.

Note: Once an evaluation is completed, its data becomes immutable. Any attempt to update it will result in a failed request.

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.

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.

500

500 Internal Server Error – Unexpected server issue.

Language

Credentials

Bearer

URL

Loading…

Response

Choose an example:

application/json

200The evaluation was updated successfully.