Photo Collect workflow

This overview shows the available capture and upload paths through validation, processing, quality control, export, retry, and verification.

flowchart TB
    accTitle: Photo Collect workflow overview
    accDescr: The available capture and upload paths, automated and manual checks, image processing, export, retry, and verification outcomes.
    A["Backend / API / Deeplink"] --> B["Photo capture<br/>On-site or off-site"]
    U["API upload"] --> C["Automatic check<br/>Example: Number of persons"]
    B --> C & P["Request phone number / email<br/>No contact details available"]
    C --> D["Automatic image processing<br/>Example: Cropping / background removal"]
    C -- "AI check rejection<br/>Up to 3 times" --> R["AI check rejection<br/>Up to 3 times"]
    R --> B
    D --> E{"Result OK<br/>Self-check"} & M["Manual quality control<br/>Example: Headwear"]
    E -- Yes --> X["Export<br/>ZIP, SFTP or API"]
    E -- No --> N["New upload request<br/>Contact details available"]
    N --> B
    M --> X & N
    P <--> V["Verification<br/>Via one-time code"]
    V --> N & Z["End of process<br/>No contact details available"]

Integration sequences

Web application with a Deeplink

sequenceDiagram
    accTitle: Deeplink web application sequence
    accDescr: A web application sends a user through Photo Collect capture and retrieves the result with or without manual quality control.
    participant U as User
    participant W as Web App
    participant P as Photo Collect

    W->>W: Generate signed Deeplink
    W->>U: Show "Upload Photo" button (Deeplink)
    U->>P: Open Deeplink
    P->>U: Guided photo capture
    U->>P: Upload photo
    P->>P: Process photo
    P->>U: Redirect to redirect_uri
    U->>W: Return to Web App

    alt QC disabled
        W->>P: GET /export
        P-->>W: Photo data
        W->>P: DELETE /export
    else QC enabled
        W->>P: GET /search (optional)
        P-->>W: Status (photo_status, qc_status)
    end

Process an existing image

sequenceDiagram
    accTitle: Existing image processing sequence
    accDescr: A client uploads an unprocessed image and receives either the processed image or quality-check failure reasons.
    participant C as Client System
    participant P as Photo Collect

    C->>P: POST /photo (unprocessed image)
    P->>P: Image processing & validation

    alt Quality Check passed
        P-->>C: Processed image (base64)
    else Quality Check failed
        P-->>C: Failure reasons
    end

Poll for approved photos

sequenceDiagram
    accTitle: Approved photo polling sequence
    accDescr: An export worker polls Photo Collect, stores returned photos, and deletes successfully processed exports.
    participant W as Export Worker
    participant P as Photo Collect

    loop Every 1–5 minutes
        W->>P: GET /export
        P-->>W: List of exported photos
        W->>W: Store photos
        W->>P: DELETE /export (invitation_keys)
    end

See the Integration guide for implementation recommendations for each workflow.