Skip to main content
Business-rule checks let you evaluate each account against rules that matter to your product — for example, a minimum salary or a minimum average balance — as part of the consent journey. Each check is evaluated against an account’s data while the journey runs, and the outcome is returned per account so you can act on it (approve, decline, route the applicant, and so on). Checks are an opt-in feature that is configured per product and layered on top of the AA + PDF flow — the request and response contracts are the same, with checks added wherever accounts appear.
This section builds on the AA + PDF flow. If you have not integrated that flow yet, start with the AA + PDF Enabled section first — it covers the full integration flow, status tracking (webhook, polling, and UI events), data fetch, and the quick reference. Checks simply add a checks object to each account (and an optional checks_overrides field on the Initiate Consent request).

​
The checks object

Wherever an account is returned — in the webhook, the status polling response, and the raw FI data — it carries a checks object describing the outcome of every check evaluated for that account. 
{
  "checks": {
    "indicators": [
      {
        "check_id": "MIN_SALARY_15000",
        "metadata": { "salary": "40000" },
        "result": "PASS"
      }
    ]
  }
}

​
Fields

FieldTypeDescription
indicators[]arrayList of checks evaluated for this account. One entry per check.
indicators[].check_idstringIdentifier of the check that was evaluated (for example, MIN_SALARY_15000).
indicators[].metadataobjectThe values from the account’s data used to evaluate the check (for example, { "salary": "40000" }).
indicators[].resultstringOutcome of the check: PASS or FAILED.

​
Pages in this section

PageWhat it covers
Enabling ChecksHow checks are turned on for your product, and the optional checks_overrides request field for per-request thresholds.
Track StatusHow the checks object appears on each account in the webhook and status polling responses.
Fetch Raw DataHow the checks object appears on each account in the raw FI data response.