> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepidv.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Workflow

> Retrieve a workflow by ID

```
GET /v1/workflows/{id}
```

Returns the full workflow record for the given ID. The workflow must belong to your organization.

## Request

### Headers

| Header      | Required | Description  |
| ----------- | -------- | ------------ |
| `x-api-key` | Yes      | Your API key |

### Path parameters

| Parameter | Type   | Required | Description     |
| --------- | ------ | -------- | --------------- |
| `id`      | string | Yes      | The workflow ID |

### Example request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.deepidv.com/v1/workflows/6d6da499-9225-40fb-9ffd-a06634b915bd" \
    -H "x-api-key: YOUR_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.deepidv.com/v1/workflows/6d6da499-9225-40fb-9ffd-a06634b915bd",
    {
      headers: { "x-api-key": "YOUR_API_KEY" },
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.deepidv.com/v1/workflows/6d6da499-9225-40fb-9ffd-a06634b915bd",
      headers={"x-api-key": "YOUR_API_KEY"},
  )
  ```
</CodeGroup>

## Response

### 200 — Success

### Workflow object

| 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_at`      | string | ISO 8601 creation timestamp        |
| `workflow.updated_at`      | string | ISO 8601 last-updated timestamp    |
| `workflow.steps`           | array  | Ordered list of verification steps |

### Step object

| Field            | Type   | Description                                               |
| ---------------- | ------ | --------------------------------------------------------- |
| `steps[].id`     | string | Step identifier (e.g. `id-verification`, `face-liveness`) |
| `steps[].config` | object | Step-specific configuration settings                      |

<Tip>
  To list sessions associated with a workflow, use the [List Sessions](/api-reference/sessions/list-sessions) endpoint with the `workflow_id` query parameter.
</Tip>

### Error responses

| 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                          |

<ResponseExample>
  ```json 200 theme={null}
  {
    "workflow": {
      "id": "6d6da499-9225-40fb-9ffd-a06634b915bd",
      "name": "Everything",
      "status": "active",
      "organization_id": "da760e2f-2f7b-4f5d-b394-766ce9c4fad8",
      "created_at": "2026-03-01T17:30:24.573Z",
      "updated_at": "2026-03-01T17:30:24.573Z",
      "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": {}
        }
      ]
    }
  }
  ```
</ResponseExample>