Policy result object

This page describes the policy_result object, which represents the outcome of evaluating a business against a policy or ruleset. Policy results contain the overall decision, matched conditions, and individual action results.

Example JSON response

1 {
2   "object": "policy_result",
3   "id": "f074244d-5cf3-4703-950a-73a7d54ee555",
4   "result": "approved",
5   "name": "Standard Verification Policy",
6   "matched": "all_conditions",
7   "executed": true,
8   "type_of": "business_verification",
9   "business_id": "b3638510-87ec-425e-bdaa-ad6e48dec871",
10   "owner_id": "b3638510-87ec-425e-bdaa-ad6e48dec871",
11   "owner_type": "Business",
12   "details": {
13     "conditions_evaluated": 5,
14     "conditions_passed": 5
15   },
16   "policy_action_results": [
17     {
18       "object": "policy_action_result",
19       "id": "action-123",
20       "action_type": "verify_tin",
21       "result": "passed",
22       "details": {
23         "tin_verified": true,
24         "name_match": true
25       }
26     },
27     {
28       "object": "policy_action_result",
29       "id": "action-124",
30       "action_type": "check_registration",
31       "result": "passed",
32       "details": {
33         "status": "active"
34       }
35     }
36   ],
37   "created_at": "2024-01-30T23:49:01.100Z"
38 }

Policy result attributes

Attribute	Type	Description
`object`	string	The object type. Always `policy_result`.
`id`	string	The unique identifier for the policy result.
`result`	string	The overall outcome of the policy evaluation.
`name`	string \| null	The name of the policy that was evaluated.
`matched`	string \| null	Indicates which conditions were matched.
`executed`	boolean	Whether the policy was fully executed.
`type_of`	string	The type of policy result.
`business_id`	string	The unique identifier of the evaluated business.
`owner_id`	string	The polymorphic owner ID.
`owner_type`	string	The polymorphic owner type.
`details`	object	Additional details about the policy evaluation.
`policy_action_results`	PolicyActionResult[]	An array of individual action results from the policy.
`created_at`	timestamp	The timestamp when the policy result was created.

Policy action result attributes

Each action within a policy produces its own result, captured in the policy_action_results array.

Attribute	Type	Description
`object`	string	The object type. Always `policy_action_result`.
`id`	string	The unique identifier for the action result.
`action_type`	string	The type of action that was evaluated.
`result`	string	The outcome of the individual action.
`details`	object	Additional details specific to the action type.

Common result values

Result	Description
`approved`	The business passed all policy conditions and was approved.
`rejected`	The business failed one or more policy conditions and was rejected.
`review`	The business requires manual review before a final decision.
`pending`	The policy evaluation is still in progress.

Get a demo

Contact your account manager or contact sales to inquire about access.