Staging environment — data here is not production data
Fidera
Docs
Browse documentation
Flows

Get Flow Spec

get/v1/flow_templates/{slug}/spec

Sanitized contract for the SDK. Tenant API key only. Returns the flow's check list plus the derived document requirements, so the iOS app knows which screens to render. No rule details or audit metadata leak through this path.

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

slug
path · required

No additional parameter description.

Example request

cURL
curl --request GET \
  --url 'https://api.fideralabs.com/v1/flow_templates/{slug}/spec' \
  --header 'Authorization: Bearer $FIDERA_API_KEY'

Responses

200Successful Response
allowed_document_types
DocumentType[]

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.

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[]required

No additional field description.

slug
stringrequired

No additional field description.

application/json
{
  "allowed_document_types": [
    "string"
  ],
  "default_datasets": [
    "string"
  ],
  "description": "string",
  "document_capture_mode": "live_or_upload",
  "intake_fields": [
    "string"
  ],
  "name": "string",
  "passport_nfc_behavior": "optional",
  "required_checks": [
    "string"
  ],
  "required_documents": [
    {
      "min": 1,
      "side": {},
      "types": [
        {}
      ]
    }
  ],
  "slug": "string"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

get_flow_spec_v1_flow_templates__slug__spec_get