curl --request GET \
--url https://api.deepidv.com/v1/workflows/{id}{
"workflow": {
"id": "6d6da499-9225-40fb-9ffd-a06634b915bd",
"created_at": "2026-03-01T17:30:24.573Z",
"created_by": "a69b63ca-9084-480f-aaaa-2df661d9c902",
"name": "Everything",
"organization_id": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"status": "active",
"steps": [
{
"id": "id_verification",
"config": {
"age_restriction_settings": {
"minimum_age": { "lower": 18, "upper": 55 }
},
"expiry_date_settings": { "expiry_date": 1 },
"face_scan_settings": { "face_front_photo_only": false },
"id_scan_face_settings": { "require_front_only": false },
"id_scan_settings": {
"require_secondary_id": true,
"require_tertiary_id": true
},
"valid_id_types_settings": {
"valid_id_types": {
"driver_license_ca": true,
"driver_license_us": true,
"passport_ca": true,
"passport_us": true,
"pr_card_ca": true,
"pr_card_us": true
}
},
"valid_states_settings": {
"valid_states": { "BC": true, "CA": true, "NY": true, "ON": true }
}
}
},
{
"id": "face_liveness",
"config": {
"face_liveness_confidence_settings": { "confidence_threshold": 70 },
"face_liveness_settings": { "preferred_liveness_method": "FaceMovementChallenge" }
}
},
{
"id": "age_estimation",
"config": {
"age_estimation_settings": { "minimum_age": 18 }
}
},
{
"id": "pep_sanctions",
"config": {}
},
{
"id": "adverse_media",
"config": {}
},
{
"id": "bank_statement_upload",
"config": {
"bank_statement_settings": {
"account_type": "checking",
"statement_period": "12"
}
}
},
{
"id": "document_upload",
"config": {
"document_upload_instructions": {
"document_upload_list": {
"document1": "Articles of Incorporation"
}
}
}
},
{
"id": "title_search",
"config": {
"title_search_settings": { "title_search_country": "usa" }
}
},
{
"id": "custom_prompt",
"config": {
"custom_instructions": {
"custom_prompts_list": [{ "text": "Hold up 3 fingers" }]
}
}
},
{
"id": "custom_form",
"config": {
"form_fields": {
"form_fields_list": {
"field1": {
"label": "What is your Company Business Number",
"options": {},
"type": "short-text"
}
}
}
}
},
{
"id": "ai_bank_statement_analysis",
"config": {}
}
],
"updated_at": "2026-03-01T17:30:24.573Z"
}
}
Retrieve a workflow by ID
curl --request GET \
--url https://api.deepidv.com/v1/workflows/{id}{
"workflow": {
"id": "6d6da499-9225-40fb-9ffd-a06634b915bd",
"created_at": "2026-03-01T17:30:24.573Z",
"created_by": "a69b63ca-9084-480f-aaaa-2df661d9c902",
"name": "Everything",
"organization_id": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"status": "active",
"steps": [
{
"id": "id_verification",
"config": {
"age_restriction_settings": {
"minimum_age": { "lower": 18, "upper": 55 }
},
"expiry_date_settings": { "expiry_date": 1 },
"face_scan_settings": { "face_front_photo_only": false },
"id_scan_face_settings": { "require_front_only": false },
"id_scan_settings": {
"require_secondary_id": true,
"require_tertiary_id": true
},
"valid_id_types_settings": {
"valid_id_types": {
"driver_license_ca": true,
"driver_license_us": true,
"passport_ca": true,
"passport_us": true,
"pr_card_ca": true,
"pr_card_us": true
}
},
"valid_states_settings": {
"valid_states": { "BC": true, "CA": true, "NY": true, "ON": true }
}
}
},
{
"id": "face_liveness",
"config": {
"face_liveness_confidence_settings": { "confidence_threshold": 70 },
"face_liveness_settings": { "preferred_liveness_method": "FaceMovementChallenge" }
}
},
{
"id": "age_estimation",
"config": {
"age_estimation_settings": { "minimum_age": 18 }
}
},
{
"id": "pep_sanctions",
"config": {}
},
{
"id": "adverse_media",
"config": {}
},
{
"id": "bank_statement_upload",
"config": {
"bank_statement_settings": {
"account_type": "checking",
"statement_period": "12"
}
}
},
{
"id": "document_upload",
"config": {
"document_upload_instructions": {
"document_upload_list": {
"document1": "Articles of Incorporation"
}
}
}
},
{
"id": "title_search",
"config": {
"title_search_settings": { "title_search_country": "usa" }
}
},
{
"id": "custom_prompt",
"config": {
"custom_instructions": {
"custom_prompts_list": [{ "text": "Hold up 3 fingers" }]
}
}
},
{
"id": "custom_form",
"config": {
"form_fields": {
"form_fields_list": {
"field1": {
"label": "What is your Company Business Number",
"options": {},
"type": "short-text"
}
}
}
}
},
{
"id": "ai_bank_statement_analysis",
"config": {}
}
],
"updated_at": "2026-03-01T17:30:24.573Z"
}
}
GET /v1/workflows/{id}
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The workflow ID |
curl -X GET "https://api.deepidv.com/v1/workflows/6d6da499-9225-40fb-9ffd-a06634b915bd" \
-H "x-api-key: YOUR_API_KEY"
| Field | Type | Description |
|---|---|---|
workflow | object | The workflow record |
workflow.id | string | Unique workflow identifier |
workflow.name | string | Workflow name |
workflow.organization_id | string | Owning organization ID |
workflow.status | string | active or inactive |
workflow.created_by | string | User ID of the workflow creator |
workflow.created_at | string | ISO 8601 creation timestamp |
workflow.updated_at | string | ISO 8601 last-updated timestamp |
workflow.steps | array | Ordered list of verification steps |
| Field | Type | Description |
|---|---|---|
steps[].id | string | Step identifier (e.g. id_verification, face_liveness) |
steps[].config | object | Step-specific configuration settings |
workflow_id query parameter.| Status | Description |
|---|---|
401 Unauthorized | Missing or invalid API key |
403 Forbidden | Workflow belongs to a different organization |
404 Not Found | No workflow found with the given ID |
429 Too Many Requests | Rate limit exceeded |
{
"workflow": {
"id": "6d6da499-9225-40fb-9ffd-a06634b915bd",
"created_at": "2026-03-01T17:30:24.573Z",
"created_by": "a69b63ca-9084-480f-aaaa-2df661d9c902",
"name": "Everything",
"organization_id": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
"status": "active",
"steps": [
{
"id": "id_verification",
"config": {
"age_restriction_settings": {
"minimum_age": { "lower": 18, "upper": 55 }
},
"expiry_date_settings": { "expiry_date": 1 },
"face_scan_settings": { "face_front_photo_only": false },
"id_scan_face_settings": { "require_front_only": false },
"id_scan_settings": {
"require_secondary_id": true,
"require_tertiary_id": true
},
"valid_id_types_settings": {
"valid_id_types": {
"driver_license_ca": true,
"driver_license_us": true,
"passport_ca": true,
"passport_us": true,
"pr_card_ca": true,
"pr_card_us": true
}
},
"valid_states_settings": {
"valid_states": { "BC": true, "CA": true, "NY": true, "ON": true }
}
}
},
{
"id": "face_liveness",
"config": {
"face_liveness_confidence_settings": { "confidence_threshold": 70 },
"face_liveness_settings": { "preferred_liveness_method": "FaceMovementChallenge" }
}
},
{
"id": "age_estimation",
"config": {
"age_estimation_settings": { "minimum_age": 18 }
}
},
{
"id": "pep_sanctions",
"config": {}
},
{
"id": "adverse_media",
"config": {}
},
{
"id": "bank_statement_upload",
"config": {
"bank_statement_settings": {
"account_type": "checking",
"statement_period": "12"
}
}
},
{
"id": "document_upload",
"config": {
"document_upload_instructions": {
"document_upload_list": {
"document1": "Articles of Incorporation"
}
}
}
},
{
"id": "title_search",
"config": {
"title_search_settings": { "title_search_country": "usa" }
}
},
{
"id": "custom_prompt",
"config": {
"custom_instructions": {
"custom_prompts_list": [{ "text": "Hold up 3 fingers" }]
}
}
},
{
"id": "custom_form",
"config": {
"form_fields": {
"form_fields_list": {
"field1": {
"label": "What is your Company Business Number",
"options": {},
"type": "short-text"
}
}
}
}
},
{
"id": "ai_bank_statement_analysis",
"config": {}
}
],
"updated_at": "2026-03-01T17:30:24.573Z"
}
}