curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire', 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}/acquire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/acquire")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"session_token": "idvs_9c1f...redacted",
"token_expires_at": "2023-11-07T05:31:56Z",
"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
}
]
}
}
]
},
"progress": {
"status": "collecting_artifacts",
"privacy_contact_email": "jsmith@example.com",
"consent_notice_locale": "en",
"consent_notice_version": "<string>",
"consent_notice_text": "<string>",
"consent_notice_digest": "<string>",
"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
}
]
}
}
]
},
"flow_steps": [
{
"step_id": "<string>",
"type": "liveness",
"required": true,
"state": "pending",
"detail": {
"captured_kinds": [
"liveness_front"
],
"remaining_kinds": [
"liveness_front"
],
"answered_count": 1,
"question_count": 1,
"uploaded_document_ids": [
"<string>"
],
"remaining_document_ids": [
"<string>"
]
}
}
],
"steps": [
{
"kind": "liveness_front",
"reserved": true,
"uploaded": true
}
],
"face_match_performed": true,
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}Exchange an invite for a fresh capture token
Invite-credential auth (the bearer is the idvi_ invite code, NOT a capture token). Validates the invite (constant-time HMAC, not expired/consumed, capture window open) and mints a FRESH 900s capture token, returning it with the resolved manifest and progress so the acquiring device can start capturing. The exchange is revision-bound: a concurrent session update or re-invite returns 409 and requires the caller to authenticate the current invite. Email invites stay reusable within their TTL so a reconnecting device can re-acquire; direct delivery:none invites are consumed atomically by the first successful acquire. A capture token presented here is rejected (uniform 401).
curl --request POST \
--url https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire', 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}/acquire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/acquire")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/sessions/{sessionId}/acquire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"session_token": "idvs_9c1f...redacted",
"token_expires_at": "2023-11-07T05:31:56Z",
"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
}
]
}
}
]
},
"progress": {
"status": "collecting_artifacts",
"privacy_contact_email": "jsmith@example.com",
"consent_notice_locale": "en",
"consent_notice_version": "<string>",
"consent_notice_text": "<string>",
"consent_notice_digest": "<string>",
"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
}
]
}
}
]
},
"flow_steps": [
{
"step_id": "<string>",
"type": "liveness",
"required": true,
"state": "pending",
"detail": {
"captured_kinds": [
"liveness_front"
],
"remaining_kinds": [
"liveness_front"
],
"answered_count": 1,
"question_count": 1,
"uploaded_document_ids": [
"<string>"
],
"remaining_document_ids": [
"<string>"
]
}
}
],
"steps": [
{
"kind": "liveness_front",
"reserved": true,
"uploaded": true
}
],
"face_match_performed": true,
"completion": {
"action": "close_tab",
"return_url": "<string>"
}
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}{
"error": {
"code": "idv_session_not_found",
"message": "<string>"
}
}Authorizations
Authorization: Bearer idvi_<code>: long-lived invite credential emailed to the end user. Header only; never a query param.
Path Parameters
Response
Acquired
Fresh one-time capture token (idvs_...). Returned ONLY here and at create.
"idvs_9c1f...redacted"
Show child attributes
Show child attributes
The resolved, persisted step manifest (canonical order; config echoed).
Show child attributes
Show child attributes
Token-plane projection. No tenant/workspace, no upload refs, no OCR/jurisdiction/fraud detail.
Show child attributes
Show child attributes