Skip to content
Connect API Catalog/
/
/
Return Instance Configura...

Check and Decide (1.0.1)

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

Return All Available Instances

Request

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

Security
bearerToken
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://connect.sandbox.creditsafe.com/v1/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": [
    { … }
  ]
}

Return Instance Configuration

Request

Returns instance user has permission to access.

Security
bearerToken
Path
guidstringrequired

Get results by guid.

Query
categorystring

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

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/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.

Security
bearerToken
Path
guidstringrequired

get results by guid.

Bodyapplication/json
templateIdstringrequired

The template ID of the decision tree to be updated.

Example: "72a7e73e799a4c3ea2a8b89bd2002829"
guidstringrequired

The GUID to be updated.

Example: "232101f5cfbf11edb2a53f274007bfbe"
decisionTreeNamestringrequired

The name of the decision tree to be updated.

Example: "Default US-Test Tree"
customerIdinteger

The customer ID to be updated.

Example: 103361848
inputParamsobject

The input parameters to be updated can be obtained from the GET/instance configuration endpoint.

Example: {"creditAmount":{"labelName":"Sales Amount","failedStatus":3,"unavailableStatus":2,"isMandatory":true,"orderInde":100,"fieldType":"Integer"}}
configurationVariablesobject

The Configuration Variables to be updated can be obtained from the GET/instance configuration endpoint.

Example: {"companyStatus":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"internationalScore":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":"B"},"riskScore":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":50},"dbt":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1},"possibleOFAC":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"estimatedAnnualRevenue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"yearsInBusiness":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":5},"derogatoryLegalFilingsCount":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":3},"derogatoryLegalFilingsValue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"numberOfEmployees":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":1000},"bankruptcy":{"isRequired":true,"failedStatus":2,"unavailableStatus":2},"totalNumberOfTradeLines":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":25},"percentageOfTotalPastDue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":15},"percentageSeverelyPastDue":{"isRequired":true,"failedStatus":2,"unavailableStatus":2,"value":10},"businessCompliance":{"isRequired":false,"failedStatus":null,"unavailableStatus":2,"value":null},"directorCompliance":{"isRequired":true,"failedStatus":null,"unavailableStatus":null,"value":null}}
scalarVariablesobject

The Scalar Variables to be updated can be obtained from the GET/instance configuration endpoint.

Example: {"creditLimitAdjustmentModifier":{"isRequired":false,"value":1}}
curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/decisionEngine/instance/{guid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateId": "72a7e73e799a4c3ea2a8b89bd2002829",
    "guid": "232101f5cfbf11edb2a53f274007bfbe",
    "decisionTreeName": "Default US-Test Tree",
    "customerId": 103361848,
    "inputParams": {
      "creditAmount": {
        "labelName": "Sales Amount",
        "failedStatus": 3,
        "unavailableStatus": 2,
        "isMandatory": true,
        "orderInde": 100,
        "fieldType": "Integer"
      }
    },
    "configurationVariables": {
      "companyStatus": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "internationalScore": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": "B"
      },
      "riskScore": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 50
      },
      "dbt": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1
      },
      "possibleOFAC": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "estimatedAnnualRevenue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "yearsInBusiness": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 5
      },
      "derogatoryLegalFilingsCount": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 3
      },
      "derogatoryLegalFilingsValue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "numberOfEmployees": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 1000
      },
      "bankruptcy": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2
      },
      "totalNumberOfTradeLines": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 25
      },
      "percentageOfTotalPastDue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 15
      },
      "percentageSeverelyPastDue": {
        "isRequired": true,
        "failedStatus": 2,
        "unavailableStatus": 2,
        "value": 10
      },
      "businessCompliance": {
        "isRequired": false,
        "failedStatus": null,
        "unavailableStatus": 2,
        "value": null
      },
      "directorCompliance": {
        "isRequired": true,
        "failedStatus": null,
        "unavailableStatus": null,
        "value": null
      }
    },
    "scalarVariables": {
      "creditLimitAdjustmentModifier": {
        "isRequired": false,
        "value": 1
      }
    },
    "publilshed": true
  }'

Responses

Bodyapplication/json
object
Response
application/json
{}

Decision Trees

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

Operations

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