Verification Checks SDK
The Verification Checks library provides a standardized, extensible system for validating deliveries against contract requirements. Includes 30+ built-in check types across 17 domains.
Quick Start
import FinalTX from '@finaltx/sdk';
const ftx = new FinalTX({ apiKey: 'your-api-key' });
// List available checks
const { data, plugins } = await ftx.checks.list({ domain: 'http_api' });
// Test a check
const result = await ftx.checks.test('http_status_check', {
config: { url: 'https://api.example.com/health', expected_status: 200 }
});
// Create custom check
const custom = await ftx.checks.create({
slug: 'my_custom_check',
name: 'My Custom Check',
domain: 'http_api',
params_schema: { type: 'object', properties: { url: { type: 'string' } } }
});Check Domains
The library organizes checks into 17 domains. Click to expand and see available checks.
SDK Methods
ftx.checks.list(options?)List available check types with optional domain/search filtering
Returns: { data: CheckType[], plugins: Map }
ftx.checks.get(slug)Get check type details including versions and params schema
Returns: CheckType
ftx.checks.test(slug, { config })Test a check with sample parameters
Returns: TestResult
ftx.checks.create(input)Create a custom check type in your workspace
Returns: CheckType
ftx.checks.update(slug, updates)Update a custom check type
Returns: CheckType
ftx.checks.delete(slug)Delete a custom check type
Returns: void
Check Result Model
interface CheckResult {
status: 'pass' | 'fail' | 'indeterminate';
reason_code?: string; // Machine-readable failure reason
summary: string; // Human-readable summary
duration_ms: number; // Execution time
evidence: EvidenceArtifact[];
}
// Evidence types: text, json, binary, hash, link, screenshot, log, metric, attestation