Reserve an artifact slot
curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"byte_size": 2,
"checksum_sha256": "<string>",
"document_id": "<string>"
}
'import requests
url = "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts"
payload = {
"byte_size": 2,
"checksum_sha256": "<string>",
"document_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({byte_size: 2, checksum_sha256: '<string>', document_id: '<string>'})
};
fetch('https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'byte_size' => 2,
'checksum_sha256' => '<string>',
'document_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts"
payload := strings.NewReader("{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"status": "collecting_artifacts",
"capture_manifest": {
"workflow": "liveness_and_id",
"required_kinds": [
"liveness_front"
]
},
"step_manifest": {
"steps": [
{
"step_id": "<string>",
"type": "liveness",
"required": true,
"title": "<string>",
"config": {
"accepted_id_types": [
"driver_license"
],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"sides": "one_sided",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"type": "text",
"required": true,
"required_when": {
"question_id": "<string>",
"equals": true
},
"visible_when": {
"question_id": "<string>",
"equals": true
},
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [
"application/pdf"
],
"required": true
}
]
}
}
]
},
"artifacts": [
{
"artifact_id": "<string>",
"kind": "liveness_front",
"status": "reserved",
"document_id": "<string>",
"upload_reference": "<string>",
"content_type": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"delete_after": "2023-11-07T05:31:56Z",
"reserved_at": "2023-11-07T05:31:56Z",
"uploaded_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"delete_after": "2023-11-07T05:31:56Z",
"creator_application_id": "<string>",
"profile_id": "<string>",
"review_status": "request_sent",
"flag_categories": [
"idv"
],
"profile_update_enabled": true,
"flag_settings": {},
"privacy_contact_email": "jsmith@example.com",
"consent_evidence": {
"redacted": false,
"notice_text": "<string>",
"tenant_name": "<string>",
"privacy_contact_email": "jsmith@example.com",
"accepted": true,
"accepted_at": "2023-11-07T05:31:56Z",
"notice_version": "<string>",
"notice_digest": "<string>"
},
"review_history": [
{
"status_from": "<string>",
"status_to": "<string>",
"actor_kind": "application",
"actor_id": "<string>",
"note": "<string>",
"at": "2023-11-07T05:31:56Z",
"kind": "",
"profile_updates_fields": [
"<string>"
],
"assignee_user_id_from": "<string>",
"assignee_user_id_to": "<string>"
}
],
"assignee": "<string>",
"submitted_at": "<string>",
"reviewed_at": "<string>",
"legal_hold": true,
"workflow_ref": {
"workflow_id": "<string>",
"name": "<string>",
"revision": 2
},
"theme_ref": {
"theme_id": "<string>",
"name": "<string>",
"revision": 2
},
"assessment": {
"status": "collecting_artifacts",
"model_id": "<string>",
"inference_profile_id": "<string>",
"prompt_version": "<string>",
"face_match": "match",
"face_match_performed": true,
"liveness": "live",
"document_authenticity": "authentic",
"document": {
"id_type": "driver_license",
"issuing_country": "US",
"issuing_subdivision": "US-CA",
"id_type_confidence": 0.5,
"jurisdiction_confidence": 0.5
},
"fraud_flags": [
{
"code": "<string>",
"category": "image_quality",
"severity": "low",
"confidence": 0.5,
"explanation": "<string>",
"rationale": "<string>",
"gating": true,
"evidence_codes": [
"laminate_lift_or_reseal"
],
"normalization_reason_codes": [
"assessment_status_invalid"
]
}
],
"reviewer_summary": "<string>",
"assessed_at": "2023-11-07T05:31:56Z",
"holder_apparent_age_range": "<string>",
"barcode_check": "<string>"
},
"biometrics_delete_after": "2023-11-07T05:31:56Z",
"id_images_delete_after": "2023-11-07T05:31:56Z",
"documents_delete_after": "2023-11-07T05:31:56Z",
"biometrics_purged_at": "2023-11-07T05:31:56Z",
"id_images_purged_at": "2023-11-07T05:31:56Z",
"documents_purged_at": "2023-11-07T05:31:56Z",
"sensitive_data_purged_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}Capture
Reserve an artifact slot
Session-token auth. Rejected once the session leaves the capture window (status not in collecting_artifacts/ready_for_assessment, or token consumed). A fresh server-measured capture event for the same kind must exist, be no more than five minutes old, and is atomically consumed by a camera reservation. A document reservation instead requires an exact document id and accepted content type from the session’s copied workflow manifest, a bounded byte size, and a lowercase SHA-256 digest. Retrying an identical request after a lost response returns the same reservation.
POST
/
sessions
/
{sessionId}
/
artifacts
Reserve an artifact slot
curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"byte_size": 2,
"checksum_sha256": "<string>",
"document_id": "<string>"
}
'import requests
url = "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts"
payload = {
"byte_size": 2,
"checksum_sha256": "<string>",
"document_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({byte_size: 2, checksum_sha256: '<string>', document_id: '<string>'})
};
fetch('https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'byte_size' => 2,
'checksum_sha256' => '<string>',
'document_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts"
payload := strings.NewReader("{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions/{sessionId}/artifacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"byte_size\": 2,\n \"checksum_sha256\": \"<string>\",\n \"document_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"status": "collecting_artifacts",
"capture_manifest": {
"workflow": "liveness_and_id",
"required_kinds": [
"liveness_front"
]
},
"step_manifest": {
"steps": [
{
"step_id": "<string>",
"type": "liveness",
"required": true,
"title": "<string>",
"config": {
"accepted_id_types": [
"driver_license"
],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"sides": "one_sided",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"type": "text",
"required": true,
"required_when": {
"question_id": "<string>",
"equals": true
},
"visible_when": {
"question_id": "<string>",
"equals": true
},
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [
"application/pdf"
],
"required": true
}
]
}
}
]
},
"artifacts": [
{
"artifact_id": "<string>",
"kind": "liveness_front",
"status": "reserved",
"document_id": "<string>",
"upload_reference": "<string>",
"content_type": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"delete_after": "2023-11-07T05:31:56Z",
"reserved_at": "2023-11-07T05:31:56Z",
"uploaded_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"delete_after": "2023-11-07T05:31:56Z",
"creator_application_id": "<string>",
"profile_id": "<string>",
"review_status": "request_sent",
"flag_categories": [
"idv"
],
"profile_update_enabled": true,
"flag_settings": {},
"privacy_contact_email": "jsmith@example.com",
"consent_evidence": {
"redacted": false,
"notice_text": "<string>",
"tenant_name": "<string>",
"privacy_contact_email": "jsmith@example.com",
"accepted": true,
"accepted_at": "2023-11-07T05:31:56Z",
"notice_version": "<string>",
"notice_digest": "<string>"
},
"review_history": [
{
"status_from": "<string>",
"status_to": "<string>",
"actor_kind": "application",
"actor_id": "<string>",
"note": "<string>",
"at": "2023-11-07T05:31:56Z",
"kind": "",
"profile_updates_fields": [
"<string>"
],
"assignee_user_id_from": "<string>",
"assignee_user_id_to": "<string>"
}
],
"assignee": "<string>",
"submitted_at": "<string>",
"reviewed_at": "<string>",
"legal_hold": true,
"workflow_ref": {
"workflow_id": "<string>",
"name": "<string>",
"revision": 2
},
"theme_ref": {
"theme_id": "<string>",
"name": "<string>",
"revision": 2
},
"assessment": {
"status": "collecting_artifacts",
"model_id": "<string>",
"inference_profile_id": "<string>",
"prompt_version": "<string>",
"face_match": "match",
"face_match_performed": true,
"liveness": "live",
"document_authenticity": "authentic",
"document": {
"id_type": "driver_license",
"issuing_country": "US",
"issuing_subdivision": "US-CA",
"id_type_confidence": 0.5,
"jurisdiction_confidence": 0.5
},
"fraud_flags": [
{
"code": "<string>",
"category": "image_quality",
"severity": "low",
"confidence": 0.5,
"explanation": "<string>",
"rationale": "<string>",
"gating": true,
"evidence_codes": [
"laminate_lift_or_reseal"
],
"normalization_reason_codes": [
"assessment_status_invalid"
]
}
],
"reviewer_summary": "<string>",
"assessed_at": "2023-11-07T05:31:56Z",
"holder_apparent_age_range": "<string>",
"barcode_check": "<string>"
},
"biometrics_delete_after": "2023-11-07T05:31:56Z",
"id_images_delete_after": "2023-11-07T05:31:56Z",
"documents_delete_after": "2023-11-07T05:31:56Z",
"biometrics_purged_at": "2023-11-07T05:31:56Z",
"id_images_purged_at": "2023-11-07T05:31:56Z",
"documents_purged_at": "2023-11-07T05:31:56Z",
"sensitive_data_purged_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}Authorizations
Authorization: Bearer idvs_<token>: one-time value from create/acquire. Header only; never a query param.
Path Parameters
Body
application/json
Camera capture kinds plus workflow-authorized supporting documents.
Available options:
liveness_front, liveness_left, liveness_right, id_front, id_back, document image/jpeg|png|webp for camera captures; manifest-allowlisted PDF/image for documents.
Available options:
application/pdf, image/jpeg, image/png, image/webp Required range:
x >= 1Required for document uploads; optional for camera captures.
Pattern:
^[0-9a-f]{64}$Required only when kind=document; must exist in the copied workflow manifest.
Pattern:
^[a-z0-9_-]{1,64}$Response
Reserved
Reviewer-safe session projection (management planes).
Show child attributes
Show child attributes