FlowVerifyDevelopers

Libraries and tools

Use the OpenAPI document to generate a client, import into Postman, or call the API from any HTTP library.

There is no official SDK yet — the API is plain JSON over HTTPS and works with any HTTP client. Official TypeScript and Python libraries are planned; they will be generated from the same OpenAPI document described here, so anything you generate today maps one-to-one onto them.

The OpenAPI document

https://api.flowverify.co/v1/openapi.json

An OpenAPI 3.1 description of every endpoint, parameter, schema and error, always in sync with the deployed API. It is public — no key needed to download it. The API reference on this site is rendered from it.

Generate a client

npx openapi-typescript https://api.flowverify.co/v1/openapi.json -o flowverify.d.ts

Pair the generated types with a small fetch wrapper that sets Authorization and Idempotency-Key:

import createClient from 'openapi-fetch';
import type { paths } from './flowverify';

const fv = createClient<paths>({
  baseUrl: 'https://api.flowverify.co/v1',
  headers: { Authorization: `Bearer ${process.env.FV_API_KEY}` },
});

const { data, error } = await fv.POST('/templates/{id}/envelopes', {
  params: { path: { id: templateId }, header: { 'Idempotency-Key': `order-${orderId}` } },
  body: { recipients: [{ role: 'signer_1', name: 'Asha Rao', email: '[email protected]' }], reference: `order-${orderId}` },
});

Postman and Insomnia

Import https://api.flowverify.co/v1/openapi.json as a collection. Set a collection-level bearer token with your key and add an Idempotency-Key header to the requests you fire repeatedly while testing.

Webhook receivers

Copy the signature-verification snippets for Node.js and Python from the Webhooks guide. Any framework works as long as you can read the raw request body before it is parsed.

Command line

curl examples throughout these docs run as-is once you replace fv_live_xxxxxxxx. Pipe through jq to read responses:

curl -s https://api.flowverify.co/v1/envelopes?limit=3 \
  -H "Authorization: Bearer fv_live_xxxxxxxx" | jq '.data.data[] | {id, name, status}'

On this page