Connect API Catalog
/
Check and Decide
/
API Documentation
/
Instance Management
/
Instance Configuration

Check and Decide (1.0.0)

Introduction

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
Mock server
https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/
Sandbox server
https://connect.sandbox.creditsafe.com/v1/
Production server
https://connect.creditsafe.com/v1/

Authentication

Operations

Instance Management

Operations

Return All Available Instances

Request

Returns all instances (Decision Trees) a user has permission to access.

Query
customerIdinteger

The unique identifier of the customer. If used it will return all the Decision Trees associated to that customer.

userIdinteger

The unique identifier of the user. If used it will return all the Decision Trees that user has access to.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/instances?customerId=0&userId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
correlationIdstring

A unique ID assigned to this request.

instancesArray of objects

The list of decision trees and GUID's available to user.

Response
application/json
{
  "correlationId": "string",
  "instances": [
    { … }
  ]
}

Instance Configuration

Request

Returns instance user has permission to access.

Path
guidstringrequired

Get results by guid.

Query
categorystring

Filters instance by contract category i.e., Bronze, Silver or Gold.

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/instance/{guid}?category=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
object
Response
application/json
{}

Update Instance Configuration

Request

Update the instances information.

You will need to call the GET /decisionEngine/instance/{guid} endpoint to get the current configuration and then update the fields you want to change.

Path
guidstringrequired

get results by guid.

Bodyapplication/json
any(UpdateDecisionEngineInstanceRequestBodyWithExample)
curl -i -X PUT \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/checkdecide/checkanddecide/decisionEngine/instance/{guid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json'

Responses

Bodyapplication/json
object
Response
application/json
{}

Decision Trees

Operations

Decision Logs

Operations

Run Decision

Operations

Decision Outcome

Operations