Contents

LoupeCheck

A check. result is set once status is completed, and error says why when it is failed. documents_deleted_at is when we deleted the documents; what the check found stays. folio says where they went once someone asked for them to be kept in Folio.

Fields

  • id required Type: string
  • status required Type: "queued" "running" "completed" "failed"
  • created_by required Type: string
  • created_at required Type: string
  • completed_at required Type: string null
  • documents_deleted_at required Type: string null
  • documents required Type: LoupeDocument[]
  • policy required Type: LoupePolicy
  • result required Type: LoupeResult null
  • error required Type: string null
  • review required Type: LoupeReview null
  • assigned_to required Type: string null

    Who is deciding on the check.

  • assigned_at required Type: string null
  • folio required Type: LoupeFolioKept null
Example
{
  "id": "lck_01jb2r6x8k4m7q9s2t5v8w1y3z",
  "status": "queued",
  "created_by": "api_key:key_01jb2r5n3c8d6f9h2j4k7m1p5r",
  "created_at": "2026-10-22T09:14:03Z",
  "completed_at": null,
  "documents_deleted_at": null,
  "documents": [
    {
      "index": 0,
      "name": "statement-september.pdf",
      "sha256": "3f1c9a0e5b7d2c4f6a8b1d3e5f7a9c0b2d4e6f8a1c3e5b7d9f0a2c4e6b8d1f3a",
      "size_bytes": 184211
    }
  ],
  "policy": {
    "name": "default",
    "version": 1,
    "fail": 0.9,
    "flag": 0.5,
    "auto": 0.15,
    "auto_approve": true,
    "weights": {},
    "disabled": []
  },
  "result": null,
  "error": null,
  "review": null,
  "assigned_to": null,
  "assigned_at": null,
  "folio": null
}

Where you'll see it