Batch Uploads
Run high-volume bulk evaluations against a live workflow directly in RiskOS™— upload a CSV or JSON file, validate it, submit the batch, and download complete results, all self-service.
Batch Uploads lets you evaluate large volumes of records against a workflow in a single run—no scripts and no coordination with the Socure team required. You upload a CSV or JSON file, RiskOS™ validates it, runs each row through your live workflow, and generates downloadable results in both CSV and JSON formats.
Use Batch Uploads when you want to:
- Re-screen an existing customer portfolio against your current risk workflow.
- Run bulk evaluations for testing or quality assurance.
- Process offline applications or events in a single upload instead of one API call at a time.
Note:
This page covers the current Batch Uploads feature. It replaces the earlier, now-deprecated CSV upload method—see Run Batch Evaluations via CSV Upload if you're looking for the legacy flow.
Before you start
Note:
If you don't see Batch Uploads under Cases in your RiskOS™ Dashboard, contact your Socure account team to have it activated for your account.
Before you upload a batch, make sure you have:
- A published, live workflow to evaluate your records against.
- Permission to initiate batch uploads and to view batch results. If you can't access Batch Uploads or download results, ask your account admin to confirm your role permissions.
Access Batch Uploads
Once Batch Uploads is activated for your account, Batch Uploads appears as a menu item under Cases in the RiskOS™ Dashboard sidebar. Select it to open the Batch Uploads overview page, where you can create a new batch and track existing ones.
Create a new batch
- On the Batch Uploads page, start a new batch.
- (Optional) Enter a name for the batch. If you leave the name empty, RiskOS™ uses the uploaded file's name as the batch name.
- Select your upload format and file (see Prepare your file).
How batches run against workflows
A batch always runs against the live version of the workflow at the time each row is processed. If you publish a new version of the workflow while a batch is still running, the rows that haven't yet been processed run against the new live version. You don't need to restart the batch.
Note:
Because remaining rows pick up the latest live workflow, different rows in the same batch can be evaluated against different workflow versions if you publish a change mid-run.
Prepare your file
You can upload your records in one of two formats.
| Format | Requirements | Notes |
|---|---|---|
| CSV | Column headers must match the RiskOS™ API field structure. Download the provided template to start with the correct columns. | A downloadable CSV template is available on the upload screen. |
| JSON | Must follow the standard evaluation API schema and be newline-delimited JSON (NDJSON)—one JSON object per line, not a single JSON array. | Use JSON when your records include nested fields that CSV can't represent. |
Encrypt your file (optional)
You can PGP-encrypt your file before uploading it. Encryption is optional—files are protected in transit either way. If your organization requires PGP encryption, download the current Socure PGP public key from the upload screen and encrypt your file before selecting it. Socure decrypts your file before processing.
For step-by-step instructions on encrypting your file with the Socure public key on macOS, Linux, or Windows, see Encrypt batch files with PGP.
Upload and validate your file
- Select your prepared file to upload it.
- RiskOS™ runs a quick validation check on the file. This is a pass/fail gate—you can't submit a batch until the file passes.
- If validation fails, download the error report to see exactly what you need to fix. Correct the issues in your file and re-upload it. RiskOS™ validates the new file again.
- When validation passes, review the validation summary before you submit.
Note:
If validation keeps failing, open the error report and check that your column headers (CSV) or field names (JSON) match the API field structure exactly, that all required fields are present, and—for JSON—that the file is newline-delimited with one object per line.
Submit and monitor a batch
After you review the validation summary, submit the batch to start processing. Open the batch to track its progress from the batch detail page as it runs.
Cancel a running batch
To stop a batch before it finishes, open it and select Cancel on the batch detail page. Cancel is available only after the file passes validation and while the batch is still processing—once a batch reaches a completed, canceled, or failed state, you can no longer cancel it.
Note:
You cancel a batch from its detail page, not from the Batch Uploads overview list. Select a batch in the list to open its detail page.
Batch completion and results
When a batch finishes, RiskOS™ shows a completion summary that includes the number of failed rows and the total number of rows processed. You also receive an in-app notification when processing is complete.
A batch ends in one of these states:
| Status | What it means |
|---|---|
| Completed | Every row finished processing. Download your results in CSV or JSON. |
| Canceled | You stopped the batch before it finished. The batch detail page shows how far it progressed before you canceled it. |
| Failed | Processing couldn't complete. Open the batch to review the failure details. |
For a completed batch, download your results in either format:
| Download format | Contents |
|---|---|
| CSV | A flattened summary with the most critical information for each row. |
| JSON | The full /evaluation API response for each row, including detail not present in the CSV. |
The Batch Uploads overview page
The overview page lists your batches with their status. From this page you can:
- Filter batches by status to find the runs you care about.
- Open a batch to view its detail page, where you can cancel it while it's still processing or download its results once it completes.
Related topics
Updated 19 days ago