API reference
Response
Every field in a Verify API response.
Top level#
| Field | Type | Description |
|---|---|---|
requestId | string | Unique ID for this check. Log it. |
timestamp | ISO date | When the check ran |
overallRecommendation | APPROVE | REVIEW | DENY | The most cautious decision among applicable scenarios |
overallRiskScore | number 0-100 | The highest scenario risk score |
summary | string | One-sentence explanation |
scenarioResults | array | One result per scenario |
metadata | object | processedScenarios, applicableScenarios, dataItems, executionTimeMs, profileId |
Scenario result#
| Field | Type | Description |
|---|---|---|
scenarioId, scenarioName | string | Which scenario |
applicable | boolean | false when none of its checks had the data they need |
recommendation | string | This scenario's decision |
riskScore | number 0-100 | This scenario's risk |
matchedRules | number | How many checks flagged |
anomalies | string[] | Plain-language reasons |
ruleReports | array | Per-check details, see below |
Rule report#
| Field | Type | Description |
|---|---|---|
ruleId, ruleName | string | Which check |
status | PASSED | FLAGGED | SKIPPED | ERROR | SKIPPED means its inputs were not sent |
findings | array | { code, message }, the reasons it flagged or skipped |
Use codes in your code, messages in your logs
Finding codes such as DISPOSABLE_EMAIL_DETECTED are stable and good for branching or metrics. messages are written for people.