Get a workflow draft

GET

https://devapi.withverifa.com/api/v1/workflows/:workflow_id/drafts/:draft_id

GET

/api/v1/workflows/:workflow_id/drafts/:draft_id

$ curl https://devapi.withverifa.com/api/v1/workflows/workflow_id/drafts/draft_id \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "d4f8a9b2-3c7e-4f1a-9b6d-2e5f7a8c9d01",
3   "workflow_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4   "forked_from_version": 3,
5   "name": "Customer Onboarding Draft",
6   "description": "Draft version of the customer onboarding workflow with updated verification steps.",
7   "graph": {
8     "nodes": [
9       {
10         "id": "node1",
11         "type": "start",
12         "label": "Start"
13       },
14       {
15         "id": "node2",
16         "type": "verification",
17         "label": "ID Document Verification"
18       },
19       {
20         "id": "node3",
21         "type": "decision",
22         "label": "Verification Passed?"
23       },
24       {
25         "id": "node4",
26         "type": "end",
27         "label": "End"
28       }
29     ],
30     "edges": [
31       {
32         "from": "node1",
33         "to": "node2"
34       },
35       {
36         "from": "node2",
37         "to": "node3"
38       },
39       {
40         "from": "node3",
41         "to": "node4",
42         "condition": "yes"
43       },
44       {
45         "from": "node3",
46         "to": "node2",
47         "condition": "no"
48       }
49     ]
50   },
51   "graph_layout": {
52     "positions": {
53       "node1": {
54         "x": 100,
55         "y": 50
56       },
57       "node2": {
58         "x": 300,
59         "y": 50
60       },
61       "node3": {
62         "x": 500,
63         "y": 50
64       },
65       "node4": {
66         "x": 700,
67         "y": 50
68       }
69     }
70   },
71   "data_requirements": {
72     "required_fields": [
73       "first_name",
74       "last_name",
75       "date_of_birth",
76       "document_type",
77       "document_number"
78     ]
79   },
80   "purpose": "Identity verification for new customers",
81   "compliance_level": "high",
82   "created_by": "jane.doe@withverifa.com",
83   "created_at": "2024-01-15T09:30:00Z",
84   "updated_at": "2024-01-15T09:30:00Z"
85 }

Returns a single workflow draft by ID.

Required scope: workflows:read

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

workflow_idstringRequired

draft_idstringRequired

Response

Draft detail.

idstring

workflow_idstring

forked_from_versioninteger

namestring

descriptionstring or null

graphmap from strings to any or null

graph_layoutmap from strings to any or null

data_requirementsmap from strings to any or null

purposestring or null

compliance_levelstring or null

created_bystring or null

created_atdatetime

updated_atdatetime

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors