Fidera documentation
Flows and documents
Use configured Flows for document, biometric, and checks-only journeys while keeping standalone Checks separate.
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
- Request an upload with
POST /v1/flows/{flow_id}/documents. - Upload bytes to the returned signed URL using the specified method and headers.
- Mark the upload complete with
POST /v1/flows/{flow_id}/documents/{document_id}/complete. - 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 result
Poll GET /v1/flows/{flow_id} or consume your completion workflow. The Flow
response contains its component check outcomes and overall decision.
Existing /v1/flows request shapes and webhook event names remain compatible.