Image Retrieval
RiskOS™ supports access to end-user images captured during Document Verification (DocV) via the RiskOS Dashboard or the Evaluation API. For any retrieval method, the DocV capture session must be complete and images must exist for the evaluation.
- API download (ZIP archive): Use the Download Evaluation Documents endpoint to programmatically retrieve a structured ZIP of images and case attachments for a given
eval_id.
RiskOS Dashboard (case management & viewing): To ensure images are visible in the RiskOS case view, include the Socure Image Request enrichment step in your workflow. This step retrieves images and attaches them to the evaluation for reviewers.
API: Download Evaluation Documents
Retrieves a ZIP archive of documents for a specific evaluation. Contents may include consumer ID images, selfie images, secondary documents, and attachments added by reviewers.
Servers
- Production:
https://riskos.socure.com/api/evaluation/{eval_id}/documents - Sandbox:
https://riskos.sandbox.socure.com/api/evaluation/{eval_id}/documents
Path parameter
eval_id— UUID returned when you created the evaluation.
Auth header
Authorization: Bearer YOUR_API_KEY(use the correct key for Sandbox vs Production)
Response
200 OKwithapplication/zipbody
Sample Request
curl --location 'https://riskos.socure.com/api/evaluation/fb1ddadc-6dba-4ce4-aa6d-25c005b192b5/documents' \
--header 'Authorization: Bearer YOUR_API_KEY \ZIP structure (example)
user_uploaded/ # Consumer-submitted identity documents
├─ document_verification/
│ ├─ documentfrontDoc_Front_1_blob.jpg
│ └─ documentbackDoc_Back_1_blob.jpg
└─ vouched_id_verification/
└─ Doc_Selfie_1_blob.jpg
case_attachments/ # Case attachments added via the RiskOS™ Dashboard
├─ identity.pdf
└─ additional_doc.pdf
Filenames:
When present, images are returned using these names:
Doc_Selfie_1_blob.jpgdocumentbackDoc_Back_1_blob.jpgdocumentfrontDoc_Front_1_blob.jpg
No-Image scenarios
There are valid scenarios where DocV images/documents are not available. In these cases, the endpoint returns an error.
Common reasons
- Military IDs: If the document is determined to be a military ID, images are immediately deleted and are not retained due to regulatory requirements. (
documentType.type = "Military") - Minors: If the user is determined to be under 18, images are immediately deleted and are not retained. (Reason code
R844 — User is a minor (under 18)) - Data-retention policies or customer deletion requests removed the images after capture.
Example error response
HTTP/1.1 400 Bad Request
Content-Type: application/json{
"message": "No Documents Found"
}Workflow error handling:
It is not recommended to include error handling within the RiskOS workflow for the Socure Image Request enrichment step given the valid scenarios above where images would not be expected and an error would be returned.
Updated 3 months ago
