Update an Evaluation State

Updates evaluation metadata, including decision, status, and sub_status, and optionally adds notes or a base64-encoded attachment.

Path Params
uuid
required

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

Headers
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
string
required

Your environment-specific workflow identifier.

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.

string
enum
required

The new decision value to apply.

Allowed:
string

Comma-separated list of tags to apply to the evaluation.

string

The review queue to assign the evaluation to.

string

Optional notes to add context to the evaluation.

attachments
array of objects

An array of base64-encoded attachment files.

attachments
Responses
200

The evaluation state was updated successfully. No response body is returned.

400

Bad Request - The request was unacceptable.

401

Unauthorized - An invalid API key was provided.

403

Forbidden - IP Address was rejected.

404

Not Found - The requested resource does not exist.

500

Internal Server Error – An unexpected condition occurred on the server.

Language
Credentials
Bearer
URL
LoadingLoading…