Start an Evaluation

post

https://riskos.socure.com/api/evaluation

Performs a new Evaluation in RiskOS™.

Select the type of evaluation below to access the corresponding schema.

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

Language

Credentials

Bearer

URL

Loading…

Response

Choose an example:

application/json

200The request was processed successfully.

201The request was partially processed (async integrations).

400Bad Request – The request was invalid or cannot be otherwise served.

401Unauthorized – No valid API key provided.

403Forbidden – IP address was rejected.

404Not Found – The requested resource does not exist.

429Too Many Requests – The rate limit for this API has been exceeded.

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