Flows and documents

Flows orchestrate configured verification journeys. Use standalone /v1/checks when you need a direct provider or AML evaluation; use /v1/flows when a template coordinates documents, biometrics, and several checks.

Create a Flow

POST /v1/flows accepts either:

• a tenant secret key for sync or async server-to-server execution;
• a restricted publishable key for eligible synchronous checks-only Flows;
• an authenticated operator session in the dashboard.

{
  "template_slug": "default",
  "type": "id_document",
  "mode": "async",
  "applicant": {
    "external_id": "customer-481",
    "legal_name_first": "Jane",
    "legal_name_last": "Example"
  }
}

Async document Flows return pending work. Upload the requested artifacts and then trigger processing.

Upload a document

1. Request an upload with POST /v1/flows/{flow_id}/documents.
2. Upload bytes to the returned signed URL using the specified method and headers.
3. Mark the upload complete with POST /v1/flows/{flow_id}/documents/{document_id}/complete.
4. Start processing with POST /v1/flows/{flow_id}/process.

Signed URLs are short-lived and object-specific. Do not log them or treat them as stable document identifiers.

Read the Flow and its Checks

Poll GET /v1/flows/{flow_id} or consume your completion workflow. The Flow has one execution-only state: pending, awaiting_input, processing, completed, or failed. Each component Check carries its own result. Fidera does not turn those results into a Flow-level approval, review, or denial; your system owns that workflow.

The former Flow-level result, status, and decision response fields have been replaced by state. Webhook event names remain compatible.