Contents

PolicySpec

Fields

  • auto_approve_enabled optional Type: boolean
  • auto_threshold required Type: number

    A check is approved automatically when its score reaches approve_threshold and the low end of its likely range reaches auto_threshold. It can sit below approve_threshold, and must be above fail_threshold.

  • approve_threshold required Type: number
  • fail_threshold required Type: number

    A signature scoring under this fails. With fewer than three references it goes to review instead, unless it scores under 0.01 or is a copy of a reference.

  • quality optional Type: QualityPolicy null
  • review_rate optional Type: number null

    The share of genuine signatures you're prepared to review, for example 0.05. When it's set, the approve bar is chosen for each number of references so that about this share of genuine signatures is flagged or failed, and approve_threshold isn't used. Slow, even strokes and a signature closer than the person's usual variation are then shown as notes rather than holding the check.

  • forgery_rate optional Type: number null

    How often you expect a forgery, for example 0.001 for 1 in 1,000. Each signature then also shows forgery_probability. It doesn't change any decision.

Example
{
  "auto_approve_enabled": false,
  "auto_threshold": 0.7,
  "approve_threshold": 0.85,
  "fail_threshold": 0.3
}

Where you'll see it