Contents

LoupeDocumentResult

Fields

  • name required Type: string
  • files required Type: LoupeFile[]
  • pages required Type: integer
  • page_hashes required Type: string[]
  • text_source required Type: "pdf_text" "ocr" "document_text" "none"
  • document_type required Type: "bank_statement" "payslip" "p60" "p45" "invoice" "utility_bill" "tenancy_agreement" "letter" null null
  • fields required Type: LoupeField[]
  • verdict required Type: LoupeVerdict
  • probability required Type: number
  • top_reasons required Type: string[]

    Why the document might not be what it seems, strongest first.

  • rating optional Type: LoupeRating
  • trusted_because required Type: LoupeAssurance[]

    What was checked on the document and held, each with where it is on the page.

  • not_checked required Type: string[]

    What couldn't be checked on the document, and why.

  • signals required Type: LoupeSignal[]
  • facts required Type: LoupeFact[]
  • details optional Type: LoupeDetail[]

    Everything the files hold about themselves, at most 1,000 entries. It's here until the documents are deleted, a day after the check.

  • versions required Type: LoupeVersions

Where you'll see it