Connect API Catalog
/
Check and Decide
/
API Documentation
/
Decision Trees

Check and Decide (1.0.0)

Endpoints to access pre-configured decision trees to automate credit decisions. Decision Engine can help you save time and money across your company by automating time consuming processes which drain your company's resources. This can free you and your staff to spend more time to work on achieving your business goals.

A full audit trail of previous decisions is maintained for user access and decisions in a pending state can be manually approved or declined.

Download OpenAPI description
checkAndDecide.json
checkAndDecide.yaml
Languages
Servers
Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoint for a user authentication and token management.

Operations

Instance Management

Endpoints for managing decision engine instances, including retrieval, and updating.

Operations

Decision Trees

Endpoints for accessing and managing pre-configured decision trees used for automated credit decisions.

Operations

Decision Trees

Request

Returns all decision trees that the user has permission to access.

Query
typestring

Filter the returned decision trees by their associated decision tree type.

Enum"Credit Approval""CS Decision Module""Demo""Credit Approval, CS Decision Module"
sortBystring

Sort results by this column.

Value"friendlyName"
decisionOutcomeboolean

Fetch decision outcome in guid list endpoint.

Default false
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/decisionEngine/GUID?decisionOutcome=false&sortBy=friendlyName&type=Credit%20Approval' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

Example: "23921650-c073-11ea-860f-06bc8182190e"
GUIDListArray of objects
Response
application/json
{
  "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
  "GUIDList": [
    { … }
  ]
}

User Data Fields

Request

Returns the user data fields defined for the given decision tree GUID.

Path
provenirIdstringrequired

The unique identifier of the decision tree, obtained from /GUID.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/decisionEngine/{provenirId}/userDataFields' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
decisionEngineIdstring

The unique reference for the decision tree.

Example: "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9"
fieldsArray of objects

A list of user-input data fields that are supported by the provided decision tree. The values for these fields should be passed to the /{guid} endpoint call when running a decision.

Response
application/json
{
  "decisionEngineId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
  "fields": [
    { … }
  ]
}

Decision Logs

Endpoints for retrieving and managing logs of past decisions.

Operations

Run Decision

Endpoints for executing decision trees to automate credit decisions.

Operations

Decision Outcome

Endpoints for retrieving the outcomes of executed decisions, including detailed results.

Operations