Patch Flow

patch/v1/flow_templates/{flow_template_id}

Patch Flow

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

flow_template_id

path · required

No additional parameter description.

Request body

JSON · required

allowed_document_types

DocumentType[] | null

No additional field description.

archived

boolean | null

No additional field description.

default_datasets

AmlDataset[] | null

No additional field description.

description

string | null

No additional field description.

document_capture_mode

DocumentCaptureMode | null

No additional field description.

intake_fields

IntakeField[] | null

No additional field description.

name

string | null

No additional field description.

passport_nfc_behavior

PassportNFCBehavior | null

No additional field description.

required_checks

CheckType[] | null

No additional field description.

Example request

cURL

curl --request PATCH \
  --url 'https://api.fideralabs.com/v1/flow_templates/{flow_template_id}' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "allowed_document_types": [
    "string"
  ],
  "archived": true,
  "default_datasets": [
    "string"
  ],
  "description": "string",
  "document_capture_mode": "string",
  "intake_fields": [
    "string"
  ],
  "name": "string",
  "passport_nfc_behavior": "string",
  "required_checks": [
    "string"
  ]
}'

Responses

200Successful Response

allowed_document_types

DocumentType[]

No additional field description.

archived_at

string | nullrequired

No additional field description.

created_at

stringrequired

No additional field description.

default_datasets

AmlDataset[] | null

No additional field description.

description

string | nullrequired

No additional field description.

document_capture_mode

DocumentCaptureMode

No additional field description.

id

stringrequired

No additional field description.

intake_fields

IntakeField[]

No additional field description.

name

stringrequired

No additional field description.

passport_nfc_behavior

PassportNFCBehavior

No additional field description.

required_checks

CheckType[]required

No additional field description.

required_documents

FlowDocumentRequirementOut[]

No additional field description.

slug

stringrequired

No additional field description.

updated_at

stringrequired

No additional field description.

application/json

{
  "allowed_document_types": [
    "string"
  ],
  "archived_at": "2026-07-29T12:00:00Z",
  "created_at": "2026-07-29T12:00:00Z",
  "default_datasets": [
    "string"
  ],
  "description": "string",
  "document_capture_mode": "live_or_upload",
  "id": "00000000-0000-0000-0000-000000000000",
  "intake_fields": [
    "string"
  ],
  "name": "string",
  "passport_nfc_behavior": "optional",
  "required_checks": [
    "string"
  ],
  "required_documents": [
    {
      "min": 1,
      "side": {},
      "types": [
        {}
      ]
    }
  ]
}

422Validation Error

detail

ValidationError[]

No additional field description.

Operation ID

patch_flow_v1_flow_templates__flow_template_id__patch