Archive a workflow
curl --request POST \
--url https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive \
--header 'Authorization: <api-key>'import requests
url = "https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive', 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/workflows/{workflowId}/archive",
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: <api-key>"
],
]);
$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/workflows/{workflowId}/archive"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/workflows/{workflowId}/archive")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"workflow_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"profile_kind": "individual",
"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
}
]
}
}
],
"status": "draft",
"theme_id": "<string>",
"is_default": true,
"retention_days": 60,
"biometrics_retention_days": 90,
"id_images_retention_days": 365,
"documents_retention_days": 1825,
"pii_retention_days": 2555,
"assessment_prompt_instructions": "<string>",
"privacy_contact_email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"revision": 2,
"description": "<string>",
"profile_update_enabled": true,
"flag_settings": {}
}
}{
"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>"
}
}Workflows
Archive a workflow
draft/active -> archived (read-only until restored via /activate). Archiving the scope default CLEARS the default flag in the same update. Existing sessions keep their copied steps.
POST
/
workflows
/
{workflowId}
/
archive
Archive a workflow
curl --request POST \
--url https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive \
--header 'Authorization: <api-key>'import requests
url = "https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive', 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/workflows/{workflowId}/archive",
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: <api-key>"
],
]);
$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/workflows/{workflowId}/archive"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
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/workflows/{workflowId}/archive")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/idv/v1/workflows/{workflowId}/archive")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"workflow_id": "<string>",
"tenant_id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"profile_kind": "individual",
"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
}
]
}
}
],
"status": "draft",
"theme_id": "<string>",
"is_default": true,
"retention_days": 60,
"biometrics_retention_days": 90,
"id_images_retention_days": 365,
"documents_retention_days": 1825,
"pii_retention_days": 2555,
"assessment_prompt_instructions": "<string>",
"privacy_contact_email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"revision": 2,
"description": "<string>",
"profile_update_enabled": true,
"flag_settings": {}
}
}{
"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).
Path Parameters
Pattern:
^idvw_[0-9a-f]{24}$Response
The (now archived) workflow
Tenant/workspace-scoped, versioned workflow object. (Distinct from the legacy Workflow PRESET enum above.) The cycle-2 inline branding block is REMOVED; presentation lives on Theme objects referenced by theme_id.
Show child attributes
Show child attributes