For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • GETList workflows
      • POSTCreate a workflow
      • GETGet a workflow
      • PATCHUpdate a workflow
      • POSTTrigger a workflow
      • GETGet session workflow run
      • GETList available verification policies
      • GETList workflow versions
      • GETGet workflow analytics
      • POSTSet a workflow as default
      • POSTDeactivate a workflow
      • GETList workflow drafts
      • GETGet a workflow draft
      • GETDiff a draft against the current workflow
      • POSTDry-run a workflow draft
      • POSTPublish a workflow draft
      • POSTDry-run a workflow
      • GETGet workflow rollout map
      • PUTUpdate workflow rollout map
      • POSTClone a workflow
      • GETList verification policies
API ReferenceWorkflows

Publish a workflow draft

POST
https://devapi.withverifa.com/api/v1/workflows/:workflow_id/drafts/:draft_id/publish
POST
/api/v1/workflows/:workflow_id/drafts/:draft_id/publish
$curl -X POST https://devapi.withverifa.com/api/v1/workflows/workflow_id/drafts/draft_id/publish \
> -H "X-API-Key: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "initial_rollout_percentage": 25
>}'
1{
2 "created_at": "2024-01-15T09:30:00Z",
3 "id": "wfl_abc123",
4 "is_active": true,
5 "is_default": true,
6 "name": "Standard KYC",
7 "version": 4,
8 "description": "Workflow for standard customer identity verification",
9 "format": "steps",
10 "published_version": 4,
11 "step_count": 5,
12 "updated_at": "2024-04-10T14:45:00Z"
13}

Promotes a draft into a new published workflow version with the specified initial rollout percentage.

Required scope: workflows:write

Was this page helpful?
Previous

Dry-run a workflow

Next
Built with

Authentication

X-API-Keystring

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

Path parameters

workflow_idstringRequired
draft_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:
Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Request

This endpoint expects an object.
initial_rollout_percentageintegerRequired0-100

Response

Draft published.
created_atdatetime
idstring
Workflow ID.
is_activeboolean
Whether this workflow is active and available for use.
is_defaultboolean
Whether this is the organization's default workflow.
namestring

Human-readable workflow name.

versioninteger
Workflow version number, incremented on each update.
descriptionstring or null
Optional description of what this workflow does.
formatenumDefaults to steps

Workflow format — “steps” for legacy array format, “graph” for DAG format.

Allowed values:
published_versioninteger
step_countinteger
Number of steps in the workflow.
updated_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error