WorkflowClient Reference

WorkflowClient Reference

Overview

The WorkflowClient provides HTTP client functionality for interacting with the Integra verification API. All methods return promises and handle error responses appropriately.

Client Setup

import { WorkflowClient, getWorkflowClient } from '@/api/workflowClient';

// Use singleton instance
const client = getWorkflowClient();

// Or create custom instance
const client = new WorkflowClient('https://api.integra.dev');

Methods

create(params: CreateWorkflowRequest)

Create new workflow and start verification process.

get(workflowId: string)

Retrieve complete workflow state and navigation information.

saveMetadata(workflowId: string, metadata: SaveMetadataRequest)

Save business metadata for workflow.

saveUISchema(workflowId: string, uiSchema: SaveUISchemaRequest)

Save UI customization settings.

skipUISchema(workflowId: string)

Skip UI customization with defaults.

publish(workflowId: string)

Publish workflow to blockchain registry.

retry(workflowId: string)

Retry failed workflow.

getABI(workflowId: string)

Get parsed contract ABI.

delete(workflowId: string)

Delete workflow permanently.

Error Handling

All methods throw WorkflowClientError with structured error information including codes, messages, and optional details for debugging.