Create an IDV session
curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"profile_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"subject_reference": "<string>",
"retention_policy_id": "<string>",
"workflow": "liveness_and_id",
"steps": [
{
"step_id": "<string>",
"required": true,
"title": "<string>",
"config": {
"accepted_id_types": [],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"required": true,
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [],
"required": true
}
]
}
}
],
"workflow_id": "<string>",
"idempotency_key": "<string>",
"session_overrides": {
"version": 1,
"id_capture": {
"accepted_id_types": []
},
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}
'import requests
url = "https://api.gominerva.com/idv/v1/sessions"
payload = {
"profile_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"subject_reference": "<string>",
"retention_policy_id": "<string>",
"workflow": "liveness_and_id",
"steps": [
{
"step_id": "<string>",
"required": True,
"title": "<string>",
"config": {
"accepted_id_types": [],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"required": True,
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [],
"required": True
}
]
}
}
],
"workflow_id": "<string>",
"idempotency_key": "<string>",
"session_overrides": {
"version": 1,
"id_capture": { "accepted_id_types": [] },
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile_id: '<string>',
tenant_id: '<string>',
workspace_id: '<string>',
subject_reference: '<string>',
retention_policy_id: '<string>',
workflow: 'liveness_and_id',
steps: [
{
step_id: '<string>',
required: true,
title: '<string>',
config: {
accepted_id_types: [],
custom_id_types: [{id_type: '<string>', label: '<string>', description: '<string>'}],
sides: 'auto',
questions: [
{
question_id: '<string>',
label: '<string>',
required: true,
options: [{value: '<string>', label: '<string>'}]
}
],
documents: [
{
document_id: '<string>',
label: '<string>',
description: '<string>',
accepted_content_types: [],
required: true
}
]
}
}
],
workflow_id: '<string>',
idempotency_key: '<string>',
session_overrides: {
version: 1,
id_capture: {accepted_id_types: []},
completion: {action: 'close_tab', return_url: '<string>'}
}
})
};
fetch('https://api.gominerva.com/idv/v1/sessions', 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",
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([
'profile_id' => '<string>',
'tenant_id' => '<string>',
'workspace_id' => '<string>',
'subject_reference' => '<string>',
'retention_policy_id' => '<string>',
'workflow' => 'liveness_and_id',
'steps' => [
[
'step_id' => '<string>',
'required' => true,
'title' => '<string>',
'config' => [
'accepted_id_types' => [
],
'custom_id_types' => [
[
'id_type' => '<string>',
'label' => '<string>',
'description' => '<string>'
]
],
'sides' => 'auto',
'questions' => [
[
'question_id' => '<string>',
'label' => '<string>',
'required' => true,
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
]
]
],
'documents' => [
[
'document_id' => '<string>',
'label' => '<string>',
'description' => '<string>',
'accepted_content_types' => [
],
'required' => true
]
]
]
]
],
'workflow_id' => '<string>',
'idempotency_key' => '<string>',
'session_overrides' => [
'version' => 1,
'id_capture' => [
'accepted_id_types' => [
]
],
'completion' => [
'action' => 'close_tab',
'return_url' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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"
payload := strings.NewReader("{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\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"
},
"session_token": "idvs_9c1f...redacted",
"token_expires_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>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}Sessions
Create an IDV session
Accepts an application API key or a dashboard session. profile_id is REQUIRED (missing/empty -> 400 idv_profile_id_required; malformed -> 400 idv_profile_id_invalid): sessions are never free-floating. The profile MUST exist in scope in the Minerva profiles service: a missing profile -> 400 idv_profile_not_found, a profile-service lookup failure -> 503 idv_profile_lookup_unavailable (fail closed). Returns the session plus a one-time session_token (shown only here) and the resolved capture manifest. Caller-supplied tenant/workspace are overwritten by the resolved principal. An optional scoped idempotency_key makes retries return the original session; replay responses intentionally leave the one-time token fields empty rather than rotating a token that may already be in use. Session overrides are accepted only for applications entitled to them; other callers receive 403.
POST
/
sessions
Create an IDV session
curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"profile_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"subject_reference": "<string>",
"retention_policy_id": "<string>",
"workflow": "liveness_and_id",
"steps": [
{
"step_id": "<string>",
"required": true,
"title": "<string>",
"config": {
"accepted_id_types": [],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"required": true,
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [],
"required": true
}
]
}
}
],
"workflow_id": "<string>",
"idempotency_key": "<string>",
"session_overrides": {
"version": 1,
"id_capture": {
"accepted_id_types": []
},
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}
'import requests
url = "https://api.gominerva.com/idv/v1/sessions"
payload = {
"profile_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"subject_reference": "<string>",
"retention_policy_id": "<string>",
"workflow": "liveness_and_id",
"steps": [
{
"step_id": "<string>",
"required": True,
"title": "<string>",
"config": {
"accepted_id_types": [],
"custom_id_types": [
{
"id_type": "<string>",
"label": "<string>",
"description": "<string>"
}
],
"sides": "auto",
"questions": [
{
"question_id": "<string>",
"label": "<string>",
"required": True,
"options": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"documents": [
{
"document_id": "<string>",
"label": "<string>",
"description": "<string>",
"accepted_content_types": [],
"required": True
}
]
}
}
],
"workflow_id": "<string>",
"idempotency_key": "<string>",
"session_overrides": {
"version": 1,
"id_capture": { "accepted_id_types": [] },
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile_id: '<string>',
tenant_id: '<string>',
workspace_id: '<string>',
subject_reference: '<string>',
retention_policy_id: '<string>',
workflow: 'liveness_and_id',
steps: [
{
step_id: '<string>',
required: true,
title: '<string>',
config: {
accepted_id_types: [],
custom_id_types: [{id_type: '<string>', label: '<string>', description: '<string>'}],
sides: 'auto',
questions: [
{
question_id: '<string>',
label: '<string>',
required: true,
options: [{value: '<string>', label: '<string>'}]
}
],
documents: [
{
document_id: '<string>',
label: '<string>',
description: '<string>',
accepted_content_types: [],
required: true
}
]
}
}
],
workflow_id: '<string>',
idempotency_key: '<string>',
session_overrides: {
version: 1,
id_capture: {accepted_id_types: []},
completion: {action: 'close_tab', return_url: '<string>'}
}
})
};
fetch('https://api.gominerva.com/idv/v1/sessions', 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",
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([
'profile_id' => '<string>',
'tenant_id' => '<string>',
'workspace_id' => '<string>',
'subject_reference' => '<string>',
'retention_policy_id' => '<string>',
'workflow' => 'liveness_and_id',
'steps' => [
[
'step_id' => '<string>',
'required' => true,
'title' => '<string>',
'config' => [
'accepted_id_types' => [
],
'custom_id_types' => [
[
'id_type' => '<string>',
'label' => '<string>',
'description' => '<string>'
]
],
'sides' => 'auto',
'questions' => [
[
'question_id' => '<string>',
'label' => '<string>',
'required' => true,
'options' => [
[
'value' => '<string>',
'label' => '<string>'
]
]
]
],
'documents' => [
[
'document_id' => '<string>',
'label' => '<string>',
'description' => '<string>',
'accepted_content_types' => [
],
'required' => true
]
]
]
]
],
'workflow_id' => '<string>',
'idempotency_key' => '<string>',
'session_overrides' => [
'version' => 1,
'id_capture' => [
'accepted_id_types' => [
]
],
'completion' => [
'action' => 'close_tab',
'return_url' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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"
payload := strings.NewReader("{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_id\": \"<string>\",\n \"tenant_id\": \"<string>\",\n \"workspace_id\": \"<string>\",\n \"subject_reference\": \"<string>\",\n \"retention_policy_id\": \"<string>\",\n \"workflow\": \"liveness_and_id\",\n \"steps\": [\n {\n \"step_id\": \"<string>\",\n \"required\": true,\n \"title\": \"<string>\",\n \"config\": {\n \"accepted_id_types\": [],\n \"custom_id_types\": [\n {\n \"id_type\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sides\": \"auto\",\n \"questions\": [\n {\n \"question_id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n {\n \"value\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n }\n ],\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"accepted_content_types\": [],\n \"required\": true\n }\n ]\n }\n }\n ],\n \"workflow_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"session_overrides\": {\n \"version\": 1,\n \"id_capture\": {\n \"accepted_id_types\": []\n },\n \"completion\": {\n \"action\": \"close_tab\",\n \"return_url\": \"<string>\"\n }\n }\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"
},
"session_token": "idvs_9c1f...redacted",
"token_expires_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>"
}
}{
"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
applicationApiKeydashboardUserToken
Authorization: Api-Key <application_api_key> (legacy X-Api-Key also accepted).
Body
application/json
REQUIRED. The Minerva customer/profile object id this verification belongs to (missing/empty -> 400 idv_profile_id_required; bad shape -> 400 idv_profile_id_invalid). The profile MUST exist in scope in the Minerva profiles service: a missing profile -> 400 idv_profile_not_found, a profile-service lookup failure -> 503 idv_profile_lookup_unavailable (fail closed). The id is stored, scoped, and indexed, and every profile-scoped query is always tenant+workspace bounded.
Required string length:
1 - 128Pattern:
^[A-Za-z0-9._:-]+$Ignored/overwritten when an application principal is resolved.
Ignored/overwritten when an application principal is resolved.
Encrypted at rest; never echoed.
Mutually exclusive with steps (both present -> 400).
Available options:
liveness_and_id, liveness_only, id_only Explicit flow-step manifest. Order is the canonical flow order. At most one liveness and one id_capture step; step_id and document_id values are unique, with at most five documents total. Mutually exclusive with workflow.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Workflow OBJECT reference (idvw_...). Mutually exclusive with BOTH workflow and steps (400 when combined). Must resolve within the caller's tenant/workspace (404 otherwise; missing and out-of-scope are indistinguishable). Steps + branding are COPIED onto the session at create; later workflow edits never mutate it. When ALL manifest sources are omitted, the scope's DEFAULT workflow applies (falling back to the liveness_and_id preset).
Optional caller-generated retry key, unique within the authenticated tenant/workspace. A replay with the same profile, workflow source, and normalized full-create fingerprint returns the original session; reuse for a different request returns 409 idv_session_idempotency_conflict. The key is internal persistence metadata and is never included in a session response.
Required string length:
1 - 160Pattern:
^[A-Za-z0-9._:-]+$Versioned bounded overrides available only to applications entitled to them. Applied after the workflow/default manifest and policy are resolved and copied. This surface cannot remove/reorder steps or change consent, liveness, documents, retention, theme, or assessment controls.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Created
Reviewer-safe session projection (management planes).
Show child attributes
Show child attributes
One-time end-user capture token. Returned only for the first keyed create; an idempotent replay returns an empty string because the original token cannot be recovered or safely rotated.
Example:
"idvs_9c1f...redacted"