checks object for each account (one per linkReferenceNumber). The object is placed immediately after dataSource, alongside the account’s profile, summary, and transactions.
This section builds on the AA + PDF flow. The
checks object uses the same shape everywhere accounts appear — see Overview for the field reference, and Track Status for the webhook and polling responses.Example
Each item indata[] represents one account. The checks object sits after dataSource and reports the outcome of every check evaluated for that account. The full response envelope is shown below.
Fields
| Field | Type | Description |
|---|---|---|
data[].checks.indicators[] | array | List of checks evaluated for this account. One entry per check. |
data[].checks.indicators[].check_id | string | Identifier of the check that was evaluated (for example, MIN_SALARY_15000). |
data[].checks.indicators[].metadata | object | The values from the account’s data used to evaluate the check (for example, { "salary": "40000" }). |
data[].checks.indicators[].result | string | Outcome of the check: PASS or FAILED. |
The
checks object appears on every account regardless of its dataSource (AA or PDF), so you can evaluate outcomes the same way across all accounts.