Copy PageStart an Evaluationpost https://riskos.socure.com/api/evaluationSubmit an evaluation request to run a RiskOS™ workflow and receive a decision, scores, reason codes, and enrichment data. HeadersX-API-VersionstringThis header is optional. If omitted, requests use the current default version, 2025-01-01.orion. Set this header to pin your integration to a specific API version.Body ParamsConsumer OnboardingAdvanced PrefillGeneric PassthroughTrust and SafetyBank Account VerificationBusiness OnboardingLogin and AuthenticationWorkforce VerificationPayment ScreeningAge AssuranceworkflowstringrequiredYour 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.idstringrequiredRequired, 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.timestampdate-timerequiredThe timestamp indicating when the evaluation was initiated, in ISO 8601 / RFC 3339 format.customer_metadataobject | nullOptional, 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.Customer Metadata object | nulldataobjectrequiredThe main payload for the Consumer Onboarding workflow.data objectResponses 200The request was processed successfully. 201The evaluation was accepted and is paused pending an asynchronous step. 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. 413Payload Too Large – The customer_metadata object exceeds the maximum allowed size. 429Too Many Requests – The rate limit for this API has been exceeded. 500Internal Server Error – An unexpected condition occurred on the server.Updated 3 months ago EvaluationUpdate an EvaluationDid this page help you?YesNo
