Contents

CheckResult

One item's result. Every field is present (null when absent).

Fields

  • id required Type: string

    The result's id.

  • item_index required Type: integer
  • kind required Type: "check" "signer_match"

    The item's kind. A signer match has its answer in signer_match; its file, subject_reference, decision, signatures and input_hashes are empty.

  • file required Type: string null
  • subject_reference required Type: string null

    Your id for the person compared against.

  • reference required Type: CheckReference null
  • process required Type: Process null
  • metadata required Type: Metadata null
  • status required Type: "completed" "failed"
  • error required Type: ItemError null
  • decision required Type: Decision null
  • input_type required Type: string null
  • pages required Type: integer null
  • notes required Type: string[]

    Document notes: code or code:detail, pages from 1.

  • signatures required Type: Signature[]
  • anchor_probability required Type: number null
  • signer_match required Type: SignerMatchResult null
  • versions required Type: Versions
  • input_hashes required Type: object null
  • timings_ms required Type: object
Example
{
  "id": "ver_01j9x3m8v7k2q4r5s6t7u8v9w0",
  "item_index": 0,
  "kind": "check",
  "file": "questioned",
  "subject_reference": "cust-88",
  "reference": "APP-1042",
  "process": "loan-application",
  "metadata": {
    "branch": "leeds"
  },
  "status": "completed",
  "error": null,
  "decision": "APPROVE",
  "input_type": "photo",
  "pages": 1,
  "notes": [],
  "signatures": [
    {
      "index": 0,
      "page": 1,
      "bbox": [
        412,
        1880,
        498,
        160
      ],
      "located_by": "template",
      "quality": {
        "ok": true,
        "effective_dpi": 214,
        "sharpness": 812.5,
        "contrast": 180,
        "issues": []
      },
      "match_probability": 0.94,
      "band": [
        0.88,
        0.97
      ],
      "reference_count": 2,
      "per_reference": [
        {
          "ref": "ref_01j9x3m8v7k2q4r5s6t7u8v9w1",
          "probability": 0.95
        },
        {
          "ref": "ref_01j9x3m8v7k2q4r5s6t7u8v9w2",
          "probability": 0.92
        }
      ],
      "flags": [],
      "decision": "APPROVE",
      "reasons": [
        "Compared against 2 references",
        "Overall appearance is within this writer's usual range",
        "Shape alignment is within this writer's usual range",
        "Approved, not auto-approved: the lowest likely score (88.0%) is under the auto-approve bar (97.0%), and auto-approve is off in policy default@7"
      ],
      "best_match": true
    }
  ],
  "anchor_probability": 0.94,
  "signer_match": null,
  "versions": {
    "model": "nib-2.6",
    "policy": "default@7",
    "api_version": "2026-09-27"
  },
  "input_hashes": {
    "questioned": "sha256:8550d9b6affca27a5645d75b058479d2e081b16a135e2d4255e5e83714ebf987",
    "references": [
      "sha256:070a8e98f85afe04ba05542428664ec3684db24bc356133c11d41f9fab27f135",
      "sha256:1cf1da50e3f0be0b50197022be0eedf20fa688cf20ca1154b388098a9d2e29e1"
    ]
  },
  "timings_ms": {
    "total": 1840
  }
}

Where you'll see it