Request

The request body contains the following elements:

Key

Type

Required/Optional

Description

application_id

String

Optional

Application ID to associate the application with

return_only_passes

Boolean

Optional

If true, API returns only decisions that passed, if false, all decisions are returned

global_variables

Object

Optional

Data required by the strategies requested that will be shared by all strategies (data that only applies to a specific strategy should be provided in the variables array). Variables are provided as key value pairs with the key being the variable's system name (not display name)

variables

Object

Required

Specifies the strategies to run and provides the data required as an array of objects (one object per model). See below for detail

The variables element contains the following sub-elements (one object per strategy requested):

Key

Type

Required/Optional

Description

strategy_name

String

Required

Name of the strategy to use for the decision. Uses the strategy system name (not display name)

strategy_status

String

Required

Status of the strategy to use, either Active or Testing corresponding to the status set in Strategy Activation

[variable_name]

Varies by Variable Type

Required

Data required by the strategy requested. Data provided at this level will take precedence over data provided in global_variables. Variables are provided as key value pairs with the key being the variable's system name (not display name)

Response

The response body contains the following elements:

Key

Type

Description

application_id

String

Application ID associated with results (only returned if application_id is provided in request)

batch_id

String

The ID assigned to the batch by the system

results

Array

Contains information on the decision results. Only shown in successful responses. See below for detail

The results element contains the following sub-elements:

Key

Type

Description

strategy_name

String

Name of the strategy used for the decision

strategy_version

Number

Version number of the strategy used for the decision

strategy_status

String

Status of the strategy used for the decision (either active or testing)

case_id

String

The ID assigned to the case by the system

passed

Boolean

Indicates if the decision passed or failed. Returns true if all Requirements Rules modules passed and false if any fail. If Strategy contains no Requirements Rules modules it will return true

decline_reasons

String (Array)

Shows the assigned decline reasons in the case the decision fails and decline reasons have been set up within the Strategy

input_variables

Object

Contains all Input Variables provided in the API request. Variables are populated as key value pairs with the key being the variable's system name (not display name). Only returned if return_input_variables is set to true in the request

output_variables

Object

Contains all Output Variables assigned by the Strategy. Variables are populated as key value pairs with the key being the variable's system name (not display name). There will be as many data items as there are Output Variables assigned by the Strategy

Language