Staging environment — data here is not production data
Browse documentation
Flow Sessions

Current Flow Session

get/v1/flow-sessions/current

Current Flow Session

Authentication

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

Example request

cURL
curl --request GET \
  --url 'https://api.fideralabs.com/v1/flow-sessions/current' \
  --header 'Authorization: Bearer $FIDERA_API_KEY'

Responses

200Successful Response
applicant
FlowSessionApplicantOutrequired

No additional field description.

branding
OnboardingBrandingrequired

No additional field description.

collection_policy
objectrequired

No additional field description.

journey_status
"active" | "processing" | "complete"required

No additional field description.

outcome
"pending" | "approved" | "in_review"

No additional field description.

requirements
FlowSessionRequirementOutrequired

No additional field description.

submission
SubmissionOutrequired

No additional field description.

template_description
string | nullrequired

No additional field description.

template_name
stringrequired

No additional field description.

tenant_name
stringrequired

No additional field description.

application/json
{
  "applicant": {
    "consent_policy_version": "string",
    "consented": true,
    "dob": "string",
    "gender": "string",
    "has_email": false,
    "has_phone": false,
    "legal_name_first": "string",
    "legal_name_last": "string",
    "legal_name_middle": "string",
    "missing_details": [
      "string"
    ],
    "nationality": "string"
  },
  "branding": {
    "consent_policy_version": "1",
    "consent_text": "I consent to the collection and processing of my identity document and biometric data for identity verification.",
    "logo_url": "string",
    "primary_color": "#16794f",
    "privacy_url": "string",
    "support_url": "string"
  },
  "collection_policy": {},
  "journey_status": "active",
  "outcome": "pending",
  "requirements": {
    "allowed_document_types": [
      "string"
    ],
    "document_capture_mode": "live_or_upload",
    "passport_nfc_behavior": "string",
    "requires_consent": true,
    "requires_document": true,
    "requires_liveness": true,
    "requires_selfie": true
  },
  "submission": {
    "applicant_id": "00000000-0000-0000-0000-000000000000",
    "capture_state": {
      "assurance_level": {},
      "completed_steps": [
        {}
      ],
      "current_step": "welcome",
      "selected_document_type": {}
    },
    "created_at": "2026-07-29T12:00:00Z",
    "documents": [
      {
        "created_at": {},
        "doc_type": {},
        "id": {},
        "mime_type": {},
        "side": {},
        "upload_status": {}
      }
    ],
    "entities": [
      {
        "id": {},
        "observed_at": {},
        "properties": {},
        "schema": {}
      }
    ],
    "flow_id": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "last_activity_at": "2026-07-29T12:00:00Z",
    "processing_requested_at": "2026-07-29T12:00:00Z",
    "state": "string",
    "submitted_at": "2026-07-29T12:00:00Z",
    "updated_at": "2026-07-29T12:00:00Z"
  },
  "template_description": "string",
  "template_name": "string",
  "tenant_name": "string"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

current_flow_session_v1_flow_sessions_current_get